Method: courses.announcements.list

Renvoie une liste d'annonces que le demandeur est autorisé à consulter.

Les élèves du cours ne peuvent voir que les annonces PUBLISHED. Les enseignants de cours et les administrateurs de domaine peuvent consulter toutes les annonces.

Cette méthode renvoie les codes d'erreur suivants:

  • PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à accéder au cours demandé ou en cas d'erreurs d'accès.
  • INVALID_ARGUMENT si le format de la requête est incorrect.
  • NOT_FOUND si le cours demandé n'existe pas.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Identifiant du cours. Il peut s'agir de l'identifiant attribué par Classroom ou d'un alias.

Paramètres de requête

Paramètres
announcementStates[]

enum (AnnouncementState)

Restriction concernant le state des annonces renvoyées. Si cet argument n'est pas spécifié, la valeur par défaut est PUBLISHED.
orderBy

string

Ordre de tri facultatif des résultats. Liste de champs séparés par une virgule avec un mot clé d'ordre de tri facultatif. Le champ compatible est updateTime. Les mots clés d'itinéraire acceptés sont asc et desc. Si aucune valeur n'est spécifiée, updateTime desc est le comportement par défaut. Exemples: updateTime asc, updateTime
pageSize

integer

Nombre maximal d'articles à renvoyer. "0" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer moins de résultats que le nombre spécifié.
pageToken

string

Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée.

Par ailleurs, la requête list doit être identique à celle qui a généré ce jeton.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse à la liste des devoirs.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Champs
announcements[]

object (Announcement)

Éléments d'annonce correspondant à la requête.
nextPageToken

string

Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, aucun autre résultat n'est disponible.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le Guide relatif aux autorisations.