Method: userProfiles.guardianInvitations.create
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Создает приглашение опекуна и отправляет опекуну электронное письмо с просьбой подтвердить, что он является опекуном учащегося.
Как только опекун примет приглашение, его state изменится на COMPLETED , и он начнет получать уведомления опекуна. Ресурс Guardian также будет создан для представления активного хранителя.
В объекте запроса должны быть установлены поля studentId и invitedEmailAddress . Если не задать эти поля или задать какие-либо другие поля в запросе, возникнет ошибка.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED если у текущего пользователя нет разрешения на управление опекунами, если соответствующий опекун уже отклонил слишком много запросов для этого учащегося, если опекуны не включены для рассматриваемого домена или в случае других ошибок доступа . -
RESOURCE_EXHAUSTED , если учащийся или опекун превысил лимит ссылок опекуна. -
INVALID_ARGUMENT если адрес электронной почты опекуна недействителен (например, если он слишком длинный) или если формат предоставленного идентификатора учащегося не может быть распознан (это не адрес электронной почты и не userId из этого API). Эта ошибка также будет возвращена, если установлены поля, доступные только для чтения, или если для поля state установлено значение, отличное от PENDING . -
NOT_FOUND если предоставленный идентификатор учащегося является действительным, но в Классе нет записей об этом учащемся. -
ALREADY_EXISTS если уже имеется ожидающее приглашение опекуна для учащегося и предоставленный invitedEmailAddress , или если указанный invitedEmailAddress соответствует учетной записи Google существующего Guardian для этого пользователя.
HTTP-запрос
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры |
|---|
guardianInvitation.studentId | string ID студента (в стандартном формате) |
Тело запроса
Тело запроса содержит экземпляр GuardianInvitation .
Тело ответа
В случае успеха тело ответа содержит вновь созданный экземпляр GuardianInvitation .
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/classroom.guardianlinks.students
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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)."]]
