Method: courses.list

Muestra una lista de los cursos que el usuario solicitante puede ver, restringidos a los que coinciden con la solicitud. Los cursos devueltos se ordenan según la hora de creación, y la más reciente se crea 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 es incorrecto
  • NOT_FOUND si no existen 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 devueltos 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 devueltos a los profesores que tienen 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 que se muestran a uno de los estados especificados. El valor predeterminado es ACTIVE, ARCHIVED, PROVISIONED y RECHAZADO.

pageSize

integer

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

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

pageToken

string

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

De lo contrario, la solicitud de 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

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

Respuesta al enumerar los cursos.

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

object (Course)

Cursos que coinciden con la solicitud de la lista.

nextPageToken

string

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