Google Classroom-Add-ons sind jetzt allgemein für Entwickler verfügbar. Weitere Informationen finden Sie in der
Dokumentation zu Add-ons.
Method: userProfiles.guardianInvitations.patch
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ändert eine Einladung für Erziehungsberechtigte.
Derzeit ist die einzige gültige Änderung, den Wert von state von PENDING in COMPLETE zu ändern. Dadurch wird die Einladung zurückgezogen.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED, wenn der aktuelle Nutzer nicht berechtigt ist, Erziehungsberechtigte zu verwalten, Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder bei anderen Zugriffsfehlern.FAILED_PRECONDITION, wenn der Link zum Erziehungsberechtigten nicht den Status PENDING hat.INVALID_ARGUMENT, wenn das Format der angegebenen Schüler-/Studenten-ID nicht erkannt werden kann (es handelt sich nicht um eine E-Mail-Adresse oder eine userId aus dieser API), oder wenn die übergebene GuardianInvitation eine andere state als COMPLETE hat oder andere Felder als state geändert werden.NOT_FOUND, wenn die angegebene Schüler-/Studenten-ID gültig ist, aber in Classroom keine Daten zu diesem Schüler/Studenten vorhanden sind, oder wenn sich das Feld id nicht auf eine Erziehungsberechtigten-Einladung bezieht, die in Classroom bekannt ist.
HTTP-Anfrage
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter |
studentId |
string
Die ID des Schülers oder Studenten, dessen Einladung für Erziehungsberechtigte geändert werden soll.
|
invitationId |
string
Das Feld id der zu ändernden GuardianInvitation.
|
Abfrageparameter
| Parameter |
updateMask |
string (FieldMask format)
Maske, die angibt, welche Felder im Kurs aktualisiert werden sollen. Dieses Feld ist für eine Aktualisierung erforderlich. Die Aktualisierung schlägt fehl, wenn ungültige Felder angegeben werden. Die folgenden Felder sind zulässig:
Wenn dieses Feld in einem Abfrageparameter festgelegt wird, sollte es so angegeben werden: 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 GuardianInvitation.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von GuardianInvitation.
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
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-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: userProfiles.guardianInvitations.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\nModifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n- `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|-----------------------------------------------------------------------------|\n| `studentId` | `string` The ID of the student whose guardian invitation is to be modified. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` to be modified. |\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 fails if invalid fields are specified. The following fields are valid: - `state` 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 [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Response body\n\nIf successful, the response body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
