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.create
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Erstellt eine Einladung für den Erziehungsberechtigten und sendet ihm eine E-Mail, in der er gebeten wird, zu bestätigen, dass er der Erziehungsberechtigte des Schülers oder Studenten ist.
Sobald der Erziehungsberechtigte die Einladung angenommen hat, ändert sich sein state
in COMPLETED
und er erhält Benachrichtigungen für Erziehungsberechtigte. Außerdem wird eine Guardian
-Ressource erstellt, die den aktiven Erziehungsberechtigten darstellt.
Für das Anfrageobjekt müssen die Felder studentId
und invitedEmailAddress
festgelegt sein. Wenn diese Felder nicht festgelegt oder andere Felder in der Anfrage festgelegt werden, führt dies zu einem Fehler.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn der aktuelle Nutzer nicht berechtigt ist, Erziehungsberechtigte zu verwalten, wenn der betreffende Erziehungsberechtigte bereits zu viele Anfragen für diesen Schüler/Studenten abgelehnt hat, wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder bei anderen Zugriffsfehlern.
RESOURCE_EXHAUSTED
, wenn der Schüler oder Erziehungsberechtigte die maximale Anzahl von Verknüpfungen mit Erziehungsberechtigten überschritten hat.
INVALID_ARGUMENT
, wenn die E-Mail-Adresse des Erziehungsberechtigten ungültig ist (z. B. zu lang) oder das Format der angegebenen Schüler-/Studentennummer nicht erkannt werden kann (es handelt sich nicht um eine E-Mail-Adresse oder eine userId
aus dieser API). Dieser Fehler wird auch zurückgegeben, wenn schreibgeschützte Felder festgelegt sind oder das Feld state
auf einen anderen Wert als PENDING
gesetzt ist.
NOT_FOUND
: Die angegebene Schüler-/Studenten-ID ist gültig, aber in Classroom ist kein Eintrag für diesen Schüler/Studenten vorhanden.
ALREADY_EXISTS
, wenn für den Schüler/Studenten bereits eine ausstehende Einladung für Erziehungsberechtigte vorliegt und invitedEmailAddress
angegeben wurde, oder wenn die angegebene invitedEmailAddress
mit dem Google-Konto einer vorhandenen Guardian
für diesen Nutzer übereinstimmt.
HTTP-Anfrage
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
guardianInvitation.studentId |
string
ID des Schülers/Studenten (im Standardformat)
|
Anfragetext
Der Anfragetext enthält eine Instanz von GuardianInvitation
.
Antworttext
Bei Erfolg enthält der Antworttext eine neu erstellte 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.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `studentId` and `invitedEmailAddress` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit.\n- `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student.\n- `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invitedEmailAddress` provided, or if the provided `invitedEmailAddress` matches the Google account of an existing `Guardian` for this user.\n\n### HTTP request\n\n`POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------------------|-------------------------------------------------|\n| `guardianInvitation.studentId` | `string` ID of the student (in standard format) |\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 a newly created 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)."]]