Method: courses.students.list

Devuelve una lista de estudiantes de este curso que el solicitante puede ver.

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

Solicitud HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
courseId

string

Es el identificador del curso. Este identificador puede ser el asignado por Classroom o un alias.

Parámetros de consulta

Parámetros
pageSize

integer

Cantidad máxima de elementos que se mostrarán. El valor predeterminado es 30 si no se especifica o es 0.

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

string

Es el valor de nextPageToken que se muestra desde 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

Responder cuando se enumeran los estudiantes.

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

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

object (Student)

Los estudiantes que coinciden con la solicitud de lista.
nextPageToken

string

Token que identifica la página siguiente de resultados que se mostrarán. Si está vacío, no habrá más resultados disponibles.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

Para obtener más información, consulta la Guía de autorización.