Method: courses.list

Muestra una lista de los cursos que el usuario solicitante tiene permiso para ver, restringida a aquellos que coinciden con la solicitud. Los cursos que se muestran se ordenan por hora de creación, y los creados más recientemente aparecen primero.

Este método muestra los siguientes códigos de error:

  • PERMISSION_DENIED para errores de acceso.
  • INVALID_ARGUMENT si el argumento de la consulta tiene un formato incorrecto
  • NOT_FOUND si no existen los usuarios especificados en los argumentos de la consulta

Solicitud HTTP

GET https://classroom.googleapis.com/v1/courses

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
studentId

string

Restringe los cursos que se muestran a aquellos que tienen un alumno con el identificador especificado. El identificador puede ser uno de los siguientes:

  • el identificador numérico del usuario
  • la dirección de correo electrónico del usuario
  • el literal de cadena "me", que indica el usuario solicitante

Si se especifica, teacherId debe estar vacío.
teacherId

string

Restringe los cursos que se muestran a aquellos que tienen un profesor con el identificador especificado. El identificador puede ser uno de los siguientes:

  • el identificador numérico del usuario
  • la dirección de correo electrónico del usuario
  • el literal de cadena "me", que indica el usuario solicitante

Si se especifica, studentId debe estar vacío.
courseStates[]

enum (CourseState)

Restringe los cursos que se muestran a aquellos que se encuentran en uno de los estados especificados. El valor predeterminado es ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

Cantidad máxima de elementos que se mostrarán. Si es cero o no se especifica, indica que el servidor puede asignar un máximo.

El servidor puede mostrar menos resultados que la cantidad especificada.
pageToken

string

Valor de nextPageToken que se muestra en una llamada list anterior, lo que indica que se debe mostrar la página de resultados posterior.

La solicitud list debe ser idéntica a la que generó este token.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta cuando se enumeran los cursos.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Campos
courses[]

object (Course)

Cursos que coinciden con la solicitud de lista.
nextPageToken

string

Token que identifica la siguiente página de resultados que se mostrará. Si está vacío, no hay más resultados disponibles.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Para obtener más información, consulta la guía de autorización.