Method: courses.students.list

Muestra una lista de alumnos 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

Identificador del curso. Este identificador puede ser el identificador 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 0.

Es posible que el servidor muestre menos datos que la cantidad especificada.

pageToken

string

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

La solicitud list debe ser idéntica a la que dio como resultado 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 a la lista de alumnos.

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

object (Student)

Los alumnos que coincidan con la solicitud de lista.

nextPageToken

string

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

Alcances de la 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 Descripción general de OAuth 2.0.