REST Resource: userProfiles
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурс: Профиль пользователя
Глобальная информация для пользователя.
JSON-представление |
---|
{
"id": string,
"name": {
object (Name )
},
"emailAddress": string,
"photoUrl": string,
"permissions": [
{
object (GlobalPermission )
}
],
"verifiedTeacher": boolean
} |
Поля |
---|
id | string Идентификатор пользователя. Только для чтения. |
name | object ( Name ) Имя пользователя. Только для чтения. |
emailAddress | string Адрес электронной почты пользователя. Необходимо запросить область https://www.googleapis.com/auth/classroom.profile.emails для заполнения этого поля в тексте ответа. Только для чтения. |
photoUrl | string URL фотографии профиля пользователя. Необходимо запросить область https://www.googleapis.com/auth/classroom.profile.photos для заполнения этого поля в тексте ответа. Только для чтения. |
permissions[] | object ( GlobalPermission ) Глобальные права пользователя. Только для чтения. |
verifiedTeacher | boolean Показывает, подтвердил ли администратор домена пользователя Google Workspace for Education явным образом его статус преподавателя. Это поле всегда имеет значение false, если пользователь не является участником домена Google Workspace for Education. Только чтение |
Имя
Подробная информация об имени пользователя.
JSON-представление |
---|
{
"givenName": string,
"familyName": string,
"fullName": string
} |
Поля |
---|
givenName | string Имя пользователя. Только для чтения. |
familyName | string Фамилия пользователя. Только для чтения. |
fullName | string Полное имя пользователя формируется путем объединения значений имени и фамилии. Только для чтения. |
Глобальное разрешение
Описание глобальных разрешений пользователя.
JSON-представление |
---|
{
"permission": enum (Permission )
} |
Поля |
---|
permission | enum ( Permission ) Значение разрешения. |
Разрешение
Возможные разрешения, которые может иметь пользователь.
Перечисления |
---|
PERMISSION_UNSPECIFIED | Разрешение не указано. Это значение не возвращается и не является допустимым значением. |
CREATE_COURSE | Пользователю разрешено создавать курс. |
Методы |
---|
| Возвращает, может ли пользователь использовать указанную возможность Класса. |
| Возвращает профиль пользователя. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],null,["# REST Resource: userProfiles\n\n- [Resource: UserProfile](#UserProfile)\n - [JSON representation](#UserProfile.SCHEMA_REPRESENTATION)\n - [Name](#UserProfile.Name)\n - [JSON representation](#UserProfile.Name.SCHEMA_REPRESENTATION)\n - [GlobalPermission](#UserProfile.GlobalPermission)\n - [JSON representation](#UserProfile.GlobalPermission.SCHEMA_REPRESENTATION)\n - [Permission](#UserProfile.Permission)\n- [Methods](#METHODS_SUMMARY)\n\nResource: UserProfile\n---------------------\n\nGlobal information for a user.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": { object (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Name) }, \"emailAddress\": string, \"photoUrl\": string, \"permissions\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.GlobalPermission) } ], \"verifiedTeacher\": boolean } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier of the user. Read-only. |\n| `name` | `object (`[Name](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Name)`)` Name of the user. Read-only. |\n| `emailAddress` | `string` Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only. |\n| `photoUrl` | `string` URL of user's profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only. |\n| `permissions[]` | `object (`[GlobalPermission](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.GlobalPermission)`)` Global permissions of the user. Read-only. |\n| `verifiedTeacher` | `boolean` Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only |\n\n### Name\n\nDetails of the user's name.\n\n| JSON representation |\n|---------------------------------------------------------------------------|\n| ``` { \"givenName\": string, \"familyName\": string, \"fullName\": string } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------|\n| `givenName` | `string` The user's first name. Read-only. |\n| `familyName` | `string` The user's last name. Read-only. |\n| `fullName` | `string` The user's full name formed by concatenating the first and last name values. Read-only. |\n\n### GlobalPermission\n\nGlobal user permission description.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------|\n| ``` { \"permission\": enum (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Permission) } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------|\n| `permission` | `enum (`[Permission](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Permission)`)` Permission value. |\n\n### Permission\n\nPossible permissions that a user may have.\n\n| Enums ||\n|--------------------------|----------------------------------------------------------------------------|\n| `PERMISSION_UNSPECIFIED` | No permission is specified. This is not returned and is not a valid value. |\n| `CREATE_COURSE` | User is permitted to create a course. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [checkUserCapability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability) | | **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240930_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more. Returns whether a user may use the specified Classroom capability. |\n| ### [get](/workspace/classroom/reference/rest/v1/userProfiles/get) | Returns a user profile. |"]]