Method: courses.list

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

Este método devuelve 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 devueltos a aquellos que tienen un estudiante con el identificador especificado. El identificador puede ser uno de los siguientes:

  • 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 devueltos a aquellos que tienen un profesor con el identificador especificado. El identificador puede ser uno de los siguientes:

  • 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 devueltos a aquellos que se encuentran en uno de los estados especificados. Si no se especifica, se devuelven los cursos en cualquier estado.
pageSize

integer

Es la cantidad máxima de elementos que se devolverán. El valor cero o no especificado indica que el servidor puede asignar un máximo.

Es posible que el servidor devuelva menos resultados de los que se especificaron.
pageToken

string

Valor de nextPageToken que se devolvió de una llamada list anterior, lo que indica que se debe devolver la página siguiente de resultados.

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

Es la 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)

Son los cursos que coinciden con la solicitud de lista.
nextPageToken

string

Es un token que identifica la siguiente página de resultados que se devolverá. 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.