Method: courses.list

Retorna uma lista de cursos que o usuário solicitante tem permissão para ver, restritos àqueles que correspondem à solicitação. Os cursos retornados são ordenados por horário de criação, e os criados mais recentemente são os primeiros.

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

  • PERMISSION_DENIED para erros de acesso.
  • INVALID_ARGUMENT se o argumento da consulta estiver incorreto.
  • NOT_FOUND se algum usuário especificado nos argumentos da consulta não existir.

Solicitação HTTP

GET https://classroom.googleapis.com/v1/courses

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

Parâmetros de consulta

Parâmetros
studentId

string

Restringe os cursos devolvidos àqueles que tenham um estudante com o identificador especificado. O identificador pode ser um dos seguintes:

  • o identificador numérico do usuário
  • o endereço de e-mail do usuário
  • o literal de string "me", indicando o usuário solicitante
teacherId

string

Restringe os cursos devolvidos àqueles que têm um professor com o identificador especificado. O identificador pode ser um dos seguintes:

  • o identificador numérico do usuário
  • o endereço de e-mail do usuário
  • o literal de string "me", indicando o usuário solicitante
courseStates[]

enum (CourseState)

Restringe os cursos retornados a quem estiver em um dos estados especificados. O valor padrão é ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

Número máximo de itens a serem devolvidos. Zero ou não especificado indica que o servidor pode atribuir um máximo.

O servidor pode retornar menos do que o número especificado de resultados.
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 cursos.

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

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

object (Course)

Cursos 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 haverá mais resultados disponíveis.

Escopos de autorização

Requer um dos seguintes escopos de 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.