Method: courses.aliases.list

Retorna uma lista de aliases para um curso.

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

  • PERMISSION_DENIED se o usuário solicitante não tiver permissão para acessar o curso ou em caso de erros de acesso.
  • NOT_FOUND se o curso não existir.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
courseId

string

O 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. Zero ou indefinido indica que o servidor pode atribuir um valor máximo.

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 os aliases do curso.

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

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

object (CourseAlias)

Os aliases do curso.
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.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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