Method: courses.announcements.patch

Met à jour un ou plusieurs champs d'une annonce.

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

  • PERMISSION_DENIED si le projet de développement à l'origine de la demande n'a pas créé l'annonce correspondante ou en cas d'erreurs d'accès.
  • INVALID_ARGUMENT si le format de la requête est incorrect.
  • FAILED_PRECONDITION si l'annonce demandée a déjà été supprimée
  • NOT_FOUND si le cours ou l'annonce demandés n'existent pas

Requête HTTP

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

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.

id

string

Identifiant de l'annonce.

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

Masque qui identifie les champs de l'annonce à mettre à jour. Ce champ est obligatoire pour effectuer une mise à jour. La mise à jour échoue si des champs non valides sont spécifiés. Si un champ accepte les valeurs vides, il peut être effacé en le spécifiant dans le masque de mise à jour et non dans l'objet Annonce. Si un champ qui n'accepte pas les valeurs vides est inclus dans le masque de mise à jour et n'est pas défini dans l'objet Annonce, une erreur INVALID_ARGUMENT est renvoyée.

Les enseignants peuvent spécifier les champs suivants:

  • text
  • state
  • scheduledTime

Il s'agit d'une liste de noms complets de champs séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

Le corps de la requête contient une instance Announcement.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Announcement.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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