Dodatki do Google Classroom są teraz ogólnie dostępne dla programistów. Więcej informacji znajdziesz w
dokumentacji dodatków.
Method: userProfiles.guardianInvitations.create
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Tworzy zaproszenie dla opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest on opiekunem ucznia.
Gdy opiekun zaakceptuje zaproszenie, jego state zmieni się na COMPLETED, a on sam zacznie otrzymywać powiadomienia. Utworzony zostanie też zasób Guardian reprezentujący aktywnego opiekuna.
Obiekt żądania musi zawierać ustawione pola studentId i invitedEmailAddress. Nieustawienie tych pól lub ustawienie innych pól w żądaniu spowoduje błąd.
Ta metoda zwraca te kody błędów:
PERMISSION_DENIED jeśli bieżący użytkownik nie ma uprawnień do zarządzania opiekunami, jeśli dany opiekun odrzucił już zbyt wiele próśb dotyczących tego ucznia, jeśli opiekunowie nie są włączeni w danej domenie lub z innych powodów związanych z błędami dostępu.RESOURCE_EXHAUSTED jeśli uczeń lub opiekun przekroczył limit połączeń z opiekunem.INVALID_ARGUMENT jeśli adres e-mail opiekuna jest nieprawidłowy (na przykład zbyt długi) lub jeśli nie można rozpoznać formatu podanego identyfikatora ucznia (nie jest to adres e-mail ani userId z tego interfejsu API). Ten błąd będzie też zwracany, jeśli pola tylko do odczytu są ustawione lub jeśli pole state ma wartość inną niż PENDING.NOT_FOUND jeśli podany identyfikator ucznia jest prawidłowy, ale Classroom nie ma informacji o tym uczniu.ALREADY_EXISTS jeśli dla ucznia i adresu invitedEmailAddress istnieje już oczekujące zaproszenie dla opiekuna lub jeśli podany adres invitedEmailAddress pasuje do istniejącego konta Guardian tego użytkownika.
Żądanie HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
guardianInvitation.studentId |
string
dokument tożsamości ucznia (w standardowym formacie)
|
Treść żądania
Treść żądania zawiera wystąpienie elementu GuardianInvitation.
Treść odpowiedzi
Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierała nowo utworzoną instancję GuardianInvitation.
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]
