Method: courses.students.list

Retorna uma lista de alunos deste curso que o solicitante tem permissão para visualizar.

Esse método retorna os seguintes códigos de erro:

  • NOT_FOUND se o curso não existir.
  • PERMISSION_DENIED para erros de acesso.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
courseId

string

Identificador do curso. Esse identificador pode ser atribuído ao Google Sala de Aula ou alias.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de itens a serem retornados. O padrão será 30, se não for especificado, ou 0.

O servidor pode retornar menos resultados que o especificado.
pageToken

string

Valor nextPageToken retornado de uma chamada list anterior, indicando que a página de resultados subsequente precisa ser retornada.

A solicitação list precisa ser idêntica à que resultou nesse token.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao listar os estudantes.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
Campos
students[]

object (Student)

Estudantes que correspondem à solicitação de lista.
nextPageToken

string

Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, nenhum outro resultado estará disponível.

Escopos de autorização

Requer um dos seguintes escopos do 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 mais informações, consulte o Guia de autorização.