Method: userProfiles.guardianInvitations.patch
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Изменяет приглашение опекуна.
В настоящее время единственной допустимой модификацией является изменение state с PENDING на COMPLETE . Это приведет к отзыву приглашения.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED если у текущего пользователя нет разрешения на управление хранителями, если стражи не включены для рассматриваемого домена или в случае других ошибок доступа . -
FAILED_PRECONDITION , если защитная ссылка не находится в состоянии PENDING . -
INVALID_ARGUMENT если формат предоставленного идентификатора студента не может быть распознан (это не адрес электронной почты или идентификатор userId из этого API), или если переданное GuardianInvitation имеет state отличное от COMPLETE , или если оно изменяет поля, отличные от state . -
NOT_FOUND , если предоставленный идентификатор учащегося является действительным идентификатором учащегося, но в Классе нет записи об этом учащемся или если поле id не относится к приглашению опекуна, известному Классу.
HTTP-запрос
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры |
|---|
studentId | string Идентификатор учащегося, приглашение опекуна которого необходимо изменить. |
invitationId | string Поле id GuardianInvitation , которое необходимо изменить. |
Параметры запроса
| Параметры |
|---|
updateMask | string ( FieldMask format) Маска, определяющая, какие поля курса необходимо обновить. Это поле необходимо для обновления. Обновление завершается неудачно, если указаны недопустимые поля. Следующие поля действительны: Если это поле задано в параметре запроса, оно должно быть указано как updateMask=<field1>,<field2>,... Это разделенный запятыми список полных имен полей. Пример: "user.displayName,photo" . |
Тело запроса
Тело запроса содержит экземпляр 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.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)."]]
