REST Resource: userProfiles
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משאב: UserProfile
| ייצוג ב-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 אימת אותו במפורש כמורה. השדה הזה תמיד יהיה שקר אם המשתמש לא חבר בדומיין של Google Workspace for Education. קריאה בלבד
|
שם
| ייצוג ב-JSON |
{
"givenName": string,
"familyName": string,
"fullName": string
} |
| שדות |
givenName |
string
השם הפרטי של המשתמש. קריאה בלבד.
|
familyName |
string
שם המשפחה של המשתמש. קריאה בלבד.
|
fullName |
string
השם המלא של המשתמש שנוצר על ידי שרשור הערכים של השם הפרטי ושם המשפחה. קריאה בלבד.
|
GlobalPermission
תיאור של הרשאת המשתמש ברמת הארגון.
הרשאה
| טיפוסים בני מנייה (enum) |
PERMISSION_UNSPECIFIED |
לא צוינה הרשאה. הערך הזה לא מוחזר והוא לא ערך חוקי. |
CREATE_COURSE |
המשתמש רשאי ליצור קורס. |
Methods |
|
|
הפונקציה מחזירה אם משתמש יכול להשתמש ביכולת שצוינה ב-Classroom. |
|
|
הפונקציה מחזירה פרופיל משתמש. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. 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. |"]]
