Method: courses.patch
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Met à jour un ou plusieurs champs d'un cours.
Cette méthode renvoie les codes d'erreur suivants :
PERMISSION_DENIED si l'utilisateur qui envoie la requête n'est pas autorisé à modifier le cours demandé ou en cas d'erreur d'accès.NOT_FOUND si aucun cours n'existe avec l'ID demandé.INVALID_ARGUMENT si des champs non valides sont spécifiés dans le masque de mise à jour ou si aucun masque de mise à jour n'est fourni.FAILED_PRECONDITION pour les erreurs de requête suivantes :
- CourseNotModifiable
- InactiveCourseOwner
- IneligibleOwner
- CourseTitleCannotContainUrl
Requête HTTP
PATCH https://classroom.googleapis.com/v1/courses/{id}
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
id |
string
Identifiant du cours à modifier. Cet identifiant peut être celui attribué par Classroom ou un alias.
|
Paramètres de requête
| Paramètres |
updateMask |
string (FieldMask format)
Masque qui identifie les champs du cours à mettre à jour. Ce champ est obligatoire pour effectuer une mise à jour. La mise à jour échouera si des champs non valides sont spécifiés. Les champs suivants sont valides :
namesectiondescriptionHeadingdescriptionroomcourseStateownerId Remarque : Les modifications apportées à ownerId sont considérées comme effectives immédiatement, mais en pratique, le transfert de propriété de toutes les ressources concernées peut prendre un certain temps. Lorsqu'il est défini dans un paramètre de requête, ce champ doit être spécifié comme suit : updateMask=<field1>,<field2>,...
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 Course.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de Course.
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/classroom.courses
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/08/08 (UTC).
[null,null,["Dernière mise à jour le 2025/08/08 (UTC)."],[],[],null,["# Method: courses.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 in a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if no course exists with the requested ID.\n- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.\n- `FAILED_PRECONDITION` for the following [request errors](/workspace/classroom/reference/Request.Errors):\n - CourseNotModifiable\n - InactiveCourseOwner\n - IneligibleOwner\n - CourseTitleCannotContainUrl\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier of the course to update. 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| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: - `name` - `section` - `descriptionHeading` - `description` - `room` - `courseState` - `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...` 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 [Course](/workspace/classroom/reference/rest/v1/courses#Course).\n\n### Response body\n\nIf successful, the response body contains an instance of [Course](/workspace/classroom/reference/rest/v1/courses#Course).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
