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. Primero, se muestran los que se crearon más recientemente.

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

  • PERMISSION_DENIED para errores de acceso.
  • Es INVALID_ARGUMENT si el argumento de la consulta tiene errores de formato.
  • NOT_FOUND si no existe alguno de los usuarios especificados en los argumentos de 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 mostrados a aquellos que tienen un estudiante 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 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 devolverán. Cero o no especificado indica que el servidor puede asignar un máximo.

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

string

Es el valor nextPageToken que se muestra en una llamada a 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án. Si este campo está vacío, no habrá más resultados disponibles.

Permisos de 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.