Method: courses.announcements.list

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

Os estudantes do curso só podem acessar os avisos PUBLISHED. Professores de cursos e administradores de domínio podem acessar 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 em caso de erros de acesso.
  • INVALID_ARGUMENT se a solicitação estiver incorreta.
  • 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 o atribuído pelo Google Sala de Aula ou um alias.

Parâmetros de consulta

Parâmetros
announcementStates[]

enum (AnnouncementState)

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

string

Ordem de classificação opcional para os resultados. Uma lista de campos separados por vírgulas com uma palavra-chave opcional de direção de ordenação. O campo compatível é updateTime. As palavras-chave de direção aceitas são asc e desc. Se não for especificado, o comportamento padrão será updateTime desc. Exemplos: updateTime asc, updateTime
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 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 há mais resultados disponíveis.

Escopos de autorização

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