Method: courses.announcements.patch
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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éveloppeur à l'origine de la demande n'a pas créé l'annonce correspondante ou en cas d'erreurs d'accès.INVALID_ARGUMENT si la requête est incorrecte.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. Cet identifiant peut être l'identifiant attribué par Classroom ou 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 des valeurs vides, vous pouvez le supprimer 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:
Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"
|
Corps de la requête
Le corps de la requête contient une instance de 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 d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: courses.announcements.patch\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates one or more fields of an announcement.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `FAILED_PRECONDITION` if the requested announcement has already been deleted.\n- `NOT_FOUND` if the requested course or announcement does not exist\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{id}`\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| `id` | `string` Identifier of the announcement. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: - `text` - `state` - `scheduledTime` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Announcement](/workspace/classroom/reference/rest/v1/courses.announcements#Announcement).\n\n### Response body\n\nIf successful, the response body contains an instance of [Announcement](/workspace/classroom/reference/rest/v1/courses.announcements#Announcement).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.announcements`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
