User
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משתמש ב-Google Chat. כשמוחזר מפלט כפלט מבקשה, אם אפליקציית Chat ביצעה אימות כמשתמש, הפלט של המשאב User יאכלס רק את ה-name וה-type של המשתמש.
| ייצוג JSON |
{
"name": string,
"displayName": string,
"domainId": string,
"type": enum (Type),
"isAnonymous": boolean
} |
| שדות |
name |
string
השם של משאב user ב-Google Chat. פורמט: users/{user} אפשר להשתמש באפליקציה users/app ככינוי שמשויך לאפליקציית השיחות bot. בשביל human users, {user} הוא אותו מזהה משתמש כמו:
השדה id של האדם ב-People API. לדוגמה, users/123456789 ב-Chat API מייצג את אותו אדם שמייצג את מזהה פרופיל המשתמש 123456789 ב-People API. השדה id של משתמש ב-Admin SDK Directory API. כתובת האימייל של המשתמש יכולה לשמש ככינוי עבור {user} בבקשות API. לדוגמה, אם מזהה פרופיל המשתמש של People API של user@example.com הוא 123456789, אפשר להשתמש ב-users/user@example.com ככינוי כדי לציין את users/123456789. רק השם הקנוני של המשאב (לדוגמה users/123456789) יוחזר מה-API.
|
displayName |
string
פלט בלבד. השם המוצג של המשתמש.
|
domainId |
string
המזהה הייחודי של דומיין Google Workspace של המשתמש.
|
type |
enum (Type)
סוג המשתמש.
|
isAnonymous |
boolean
פלט בלבד. כאשר true, המשתמש נמחק או שהפרופיל שלו לא גלוי.
|
סוג
| טיפוסים בני מנייה (enum) |
TYPE_UNSPECIFIED |
ערך ברירת המחדל של enum. לא לשימוש. |
HUMAN |
משתמש אנושי. |
BOT |
משתמש באפליקציית Chat. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eThe \u003ccode\u003eUser\u003c/code\u003e resource represents a Google Chat user, which can be a human or a Chat app.\u003c/p\u003e\n"],["\u003cp\u003eA user's resource name is formatted as \u003ccode\u003eusers/{user}\u003c/code\u003e, with various identifiers like email or People API ID usable for \u003ccode\u003e{user}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eWhen a Chat app authenticates as a user, the API response for the \u003ccode\u003eUser\u003c/code\u003e resource only includes the \u003ccode\u003ename\u003c/code\u003e and \u003ccode\u003etype\u003c/code\u003e fields.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etype\u003c/code\u003e field indicates whether the user is \u003ccode\u003eHUMAN\u003c/code\u003e or \u003ccode\u003eBOT\u003c/code\u003e, while \u003ccode\u003eisAnonymous\u003c/code\u003e signifies a deleted or invisible profile.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edisplayName\u003c/code\u003e and \u003ccode\u003edomainId\u003c/code\u003e provide additional user information but might not be populated in all contexts.\u003c/p\u003e\n"]]],["The JSON representation defines a user with fields including `name` (resource identifier), `displayName` (user's name), `domainId` (Google Workspace domain), `type` (user or bot), and `isAnonymous` (deleted/hidden profile status). The `name` field uses aliases like email or People API ID. User types include `HUMAN` and `BOT`. Authenticated Chat app users only show `name` and `type` in request outputs. `type` is an enum with possible values like `HUMAN` and `BOT`.\n"],null,["# User\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Type](#Type)\n\nA user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"domainId\": string, \"type\": enum (/workspace/chat/api/reference/rest/v1/User#Type), \"isAnonymous\": boolean } ``` |\n\n| Fields ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Resource name for a Google Chat [user](/workspace/chat/api/reference/rest/v1/User). Format: `users/{user}`. `users/app` can be used as an alias for the calling app [bot](/workspace/chat/api/reference/rest/v1/User#Type.ENUM_VALUES.BOT) user. For [human users](/workspace/chat/api/reference/rest/v1/User#Type.ENUM_VALUES.HUMAN), `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. |\n| `displayName` | `string` Output only. The user's display name. |\n| `domainId` | `string` Unique identifier of the user's Google Workspace domain. |\n| `type` | `enum (`[Type](/workspace/chat/api/reference/rest/v1/User#Type)`)` User type. |\n| `isAnonymous` | `boolean` Output only. When `true`, the user is deleted or their profile is not visible. |\n\nType\n----\n\n| Enums ||\n|--------------------|-----------------------------------------|\n| `TYPE_UNSPECIFIED` | Default value for the enum. DO NOT USE. |\n| `HUMAN` | Human user. |\n| `BOT` | Chat app user. |"]]
