Method: courses.students.list

Retorna uma lista de estudantes 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 o atribuído pelo Google Sala de Aula ou um alias.

Parâmetros de consulta

Parâmetros
pageSize

integer

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

O servidor pode retornar menos resultados do que o especificado.
pageToken

string

O 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 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)

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

string

Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não há mais resultados disponíveis.

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.