Method: userProfiles.guardianInvitations.get
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Возвращает приглашение конкретного опекуна.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED
если запрашивающему пользователю не разрешено просматривать приглашения опекунов для учащегося, определенного studentId
, если опекуны не включены для рассматриваемого домена или в случае других ошибок доступа . -
INVALID_ARGUMENT
если указан studentId
, но его формат не может быть распознан (это не адрес электронной почты, не studentId
из API и не литеральная строка me
). -
NOT_FOUND
, если Классу не удается найти записи данного учащегося или invitationId
. Также может быть возвращено, если учащийся существует, но запрашивающий пользователь не имеет доступа к просмотру этого учащегося.
HTTP-запрос
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
studentId | string Идентификатор студента, чье приглашение опекуна запрашивается. |
invitationId | string Поле id запрашиваемого GuardianInvitation . |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит экземпляр GuardianInvitation
.
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
-
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.get\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\nReturns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `studentId`, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if a `studentId` is specified, but its format cannot be recognized (it is not an email address, nor a `studentId` from the API, nor the literal string `me`).\n- `NOT_FOUND` if Classroom cannot find any record of the given student or `invitationId`. May also be returned if the student exists, but the requesting user does not have access to see that student.\n\n### HTTP request\n\n`GET 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 being requested. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` being requested. |\n\n### Request body\n\nThe request body must be empty.\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 one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly`\n- `\n https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]