Method: courses.announcements.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Restituisce un elenco di annunci che il richiedente è autorizzato a visualizzare.
Gli studenti del corso possono visualizzare solo gli PUBLISHED
annunci. 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 effettua 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 l'ordinamento. Il campo supportato è updateTime . Le parole chiave per le direzioni supportate sono asc e desc . Se non specificato, updateTime desc è il comportamento predefinito. Esempi: updateTime asc , updateTime
|
pageSize |
integer
Il numero massimo di elementi da restituire. Zero o non specificato indica che il server può assegnare un valore massimo. Il server potrebbe restituire meno del numero di risultati specificato.
|
pageToken |
string
Valore nextPageToken restituito da una chiamata list precedente, che indica che deve essere restituita la pagina di 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 si elenca il lavoro 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 corrispondenti alla richiesta.
|
nextPageToken |
string
Token che identifica la pagina di risultati successiva da restituire. Se è 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.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: courses.announcements.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAnnouncementsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `announcementStates[]` | `enum (`[AnnouncementState](/workspace/classroom/reference/rest/v1/courses.announcements#AnnouncementState)`)` Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. |\n| `orderBy` | `string` Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime` |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.announcements/list#body.ListAnnouncementsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.announcements/list#google.classroom.v1.Work.ListAnnouncements) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.announcements/list#google.classroom.v1.Work.ListAnnouncements) request must be otherwise identical to the one that resulted in this token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course work.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"announcements\": [ { object (/workspace/classroom/reference/rest/v1/courses.announcements#Announcement) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `announcements[]` | `object (`[Announcement](/workspace/classroom/reference/rest/v1/courses.announcements#Announcement)`)` Announcement items that match the request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.announcements`\n- `\n https://www.googleapis.com/auth/classroom.announcements.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]