Method: courses.list

Muestra una lista de cursos que el usuario solicitante puede ver, restringida a aquellos que coinciden con la solicitud. Los cursos devueltos se ordenan por fecha de creación, de modo que primero se mostrará el más reciente.

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

  • PERMISSION_DENIED para errores de acceso.
  • Es INVALID_ARGUMENT si el argumento de consulta tiene un formato incorrecto.
  • Es NOT_FOUND si no existe alguno de 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 string "me", que indica el usuario solicitante
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 string "me", que indica el usuario solicitante
courseStates[]

enum (CourseState)

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

integer

Cantidad máxima de artículos que se mostrarán. Cero o sin especificar indica que el servidor puede asignar un máximo.

Es posible que el servidor muestre menos resultados que la cantidad especificada.
pageToken

string

Valor de nextPageToken que se muestra en una llamada a list anterior, 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 página siguiente de resultados para mostrar. Si está vacío, no hay más resultados disponibles.

Permisos de la autorización

Se necesita uno de los siguientes alcances 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.