Method: courses.announcements.list

Restituisce un elenco di annunci che il richiedente è autorizzato a visualizzare.

Gli studenti del corso possono visualizzare solo gli annunci relativi a PUBLISHED. Gli insegnanti del corso e gli amministratori di dominio possono visualizzare tutti gli annunci.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED se l'utente che ha inviato la richiesta non è autorizzato ad accedere al corso richiesto o per errori di accesso.
  • INVALID_ARGUMENT se la richiesta non è valida.
  • NOT_FOUND se il corso richiesto non esiste.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
courseId

string

Identificatore del corso. Questo identificatore può essere l'identificatore assegnato da Classroom o un alias.

Parametri di query

Parametri
announcementStates[]

enum (AnnouncementState)

Limitazione del state degli annunci restituiti. Se questo argomento non viene specificato, il valore predefinito è PUBLISHED.
orderBy

string

Ordinamento facoltativo dei risultati. Un elenco di campi separati da virgole con una parola chiave facoltativa per la direzione di ordinamento. Il campo supportato è updateTime. Le parole chiave per le indicazioni stradali supportate sono asc e desc. Se non specificato, updateTime desc è il comportamento predefinito. Esempi: updateTime asc, updateTime
pageSize

integer

Numero massimo di articoli da restituire. Zero o non specificato indica che il server può assegnare un numero massimo.

Il server potrebbe restituire un numero di risultati inferiore a quello specificato.
pageToken

string

Valore nextPageToken restituito da una chiamata list precedente, che indica che deve essere restituita la pagina dei risultati successiva.

La richiesta list deve essere altrimenti identica a quella che ha generato questo token.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta quando elenca i lavori del corso.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Campi
announcements[]

object (Announcement)

Elementi dell'annuncio che corrispondono alla richiesta.
nextPageToken

string

Token che identifica la pagina successiva di risultati da restituire. Se viene lasciato vuoto, non sono disponibili altri risultati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.