Method: userProfiles.guardians.get
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Возвращает конкретного опекуна.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED
если запрашивающему пользователю не виден ни один пользователь, соответствующий предоставленному studentId
, если запрашивающему пользователю не разрешено просматривать информацию об опекуне для учащегося, определенного идентификатором studentId
, если опекуны не включены для рассматриваемого домена или при других ошибках доступа . -
INVALID_ARGUMENT
если указан studentId
, но его формат не может быть распознан (это не адрес электронной почты, не studentId
из API и не литеральная строка me
). -
NOT_FOUND
если запрашивающему пользователю разрешено просматривать опекунов для запрошенного studentId
, но для этого учащегося не существует записи Guardian
, соответствующей предоставленному guardianId
.
HTTP-запрос
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
studentId | string Студент, чей опекун запрашивается. Одно из следующих: - числовой идентификатор пользователя
- адрес электронной почты пользователя
- строковый литерал
"me" , указывающий запрашивающего пользователя
|
guardianId | string Поле id из Guardian . |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит экземпляр Guardian
.
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
-
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.guardians.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.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if no user that matches the provided `studentId` is visible to the requesting user, if the requesting user is not permitted to view guardian information 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 the requesting user is permitted to view guardians for the requested `studentId`, but no `Guardian` record exists for that student that matches the provided `guardianId`.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` The student whose guardian is being requested. One of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `guardianId` | `string` The `id` field from a `Guardian`. |\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 [Guardian](/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly`\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)."]]