Method: courses.studentGroups.list

Retorna uma lista de grupos em um curso.

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

  • NOT_FOUND se o curso não existir.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
courseId

string

Obrigatório. O identificador do curso.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de itens a serem retornados. Zero ou não especificado indica que o servidor pode atribuir um máximo, que atualmente está definido como 75 itens.

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

string

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

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

enum (PreviewVersion)

Opcional. A versão de prévia da API. Isso precisa ser definido para acessar os novos recursos de API disponibilizados aos desenvolvedores no programa de prévia.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao listar grupos de estudantes.

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

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

object (StudentGroup)

Os grupos de estudantes.
nextPageToken

string

Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não haverá 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

Para mais informações, consulte o guia de autorização.