Method: courses.announcements.list

Retorna uma lista de avisos que o solicitante tem permissão para ver.

Os alunos do curso só podem ver PUBLISHED avisos. Professores do curso e administradores do domínio têm acesso a todos os avisos.

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 solicitado ou devido a erros de acesso.
  • INVALID_ARGUMENT se a solicitação for inválida.
  • NOT_FOUND se o curso solicitado não existir.

Solicitação HTTP

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

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 pelo Google Sala de Aula ou um alias.

Parâmetros de consulta

Parâmetros
announcementStates[]

enum (AnnouncementState)

A restrição de state dos avisos retornados. Se esse argumento não for especificado, o valor padrão será PUBLISHED.
orderBy

string

Ordem de classificação opcional dos resultados. Uma lista de campos separada por vírgulas com uma palavra-chave opcional de direção de classificação. O campo aceito é updateTime. As palavras-chave de direção aceitas são asc e desc. Se não for especificado, updateTime desc será o comportamento padrão. Exemplos: updateTime asc, updateTime
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 o trabalho do curso.

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

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

object (Announcement)

Itens de aviso que correspondem à solicitação.
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.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

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