Google Classroom-Add-ons sind jetzt allgemein für Entwickler verfügbar. Weitere Informationen finden Sie in der
Dokumentation zu Add-ons.
Method: courses.patch
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Aktualisiert ein oder mehrere Felder in einem Kurs.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn der anfragende Nutzer nicht berechtigt ist, den angeforderten Kurs zu ändern, oder bei Zugriffsfehlern.
NOT_FOUND
, wenn kein Kurs mit der angeforderten ID vorhanden ist.
INVALID_ARGUMENT
, wenn in der Aktualisierungsmaske ungültige Felder angegeben sind oder keine Aktualisierungsmaske angegeben wurde.
FAILED_PRECONDITION
für die folgenden Anfragefehler:
- CourseNotModifiable
- InactiveCourseOwner
- IneligibleOwner
- CourseTitleCannotContainUrl
HTTP-Anfrage
PATCH https://classroom.googleapis.com/v1/courses/{id}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
id |
string
Kennung des Kurses, der aktualisiert werden soll. Diese Kennung kann entweder die von Classroom zugewiesene Kennung oder eine alias sein.
|
Abfrageparameter
Parameter |
updateMask |
string (FieldMask format)
Maske, die angibt, welche Felder des Kurses aktualisiert werden sollen. Dieses Feld ist für ein Update erforderlich. Die Aktualisierung schlägt fehl, wenn ungültige Felder angegeben sind. Die folgenden Felder sind gültig:
name
section
descriptionHeading
description
room
courseState
ownerId
Hinweis: Änderungen an ownerId werden zwar sofort wirksam, in der Praxis kann es jedoch einige Zeit dauern, bis die Übertragung der Inhaberschaft aller betroffenen Ressourcen abgeschlossen ist. Wenn dieses Feld in einem Abfrageparameter festgelegt wird, sollte es als updateMask=<field1>,<field2>,...
Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo" .
|
Anfragetext
Der Anfragetext enthält eine Instanz von Course
.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Course
.
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/classroom.courses
Weitere Informationen finden Sie im Autorisierungsleitfaden.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-08-08 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]