Method: courses.list

Muestra una lista de cursos que el usuario solicitante puede ver, restringida a los que coinciden con la solicitud. Los cursos que se muestran están ordenados por fecha de creación, y el más reciente aparece 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 existe ningún usuario especificado 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 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 cadena "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 cadena "me", que indica el usuario solicitante
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

Es la cantidad máxima de elementos que se mostrarán. Cero o no especificado indica que el servidor puede asignar un máximo.

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

string

Es el valor de nextPageToken que se muestra de una llamada list anterior y que indica que se debe mostrar la página de resultados posterior.

De lo contrario, 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)

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 mostrará. Si está vacío, significa que 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.