Method: courses.students.list

Muestra una lista de los estudiantes de este curso que el solicitante tiene permitido 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 que asignó Classroom o un alias.

Parámetros de consulta

Parámetros
pageSize

integer

Cantidad máxima de artículos que se devolverán. El valor predeterminado es 30 si no se especifica o 0.

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 alumnos.

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