User
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
کاربر در چت گوگل. هنگامی که به عنوان خروجی از یک درخواست برگردانده می شود، اگر برنامه چت شما به عنوان یک کاربر احراز هویت شود ، خروجی یک منبع User
فقط name
و type
کاربر را پر می کند.
نمایندگی JSON |
---|
{
"name": string,
"displayName": string,
"domainId": string,
"type": enum (Type ),
"isAnonymous": boolean
} |
فیلدها |
---|
name | string نام منبع برای user گپ Google . قالب: users/{user} . users/app را می توان به عنوان نام مستعار برای کاربر bot برنامه تماس گیرنده استفاده کرد. برای human users ، {user} همان شناسه کاربری است که: id Person in the People API. به عنوان مثال، users/123456789 در Chat API همان شخص را نشان میدهد که شناسه نمایه 123456789 شخص در People API. id یک کاربر در Admin SDK Directory API. آدرس ایمیل کاربر را می توان به عنوان نام مستعار برای {user} در درخواست های API استفاده کرد. به عنوان مثال، اگر شناسه نمایه افراد API People برای 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 ، کاربر حذف می شود یا نمایه او قابل مشاهده نیست. |
تایپ کنید
Enums |
---|
TYPE_UNSPECIFIED | مقدار پیش فرض برای enum. استفاده نکنید. |
HUMAN | کاربر انسانی. |
BOT | کاربر برنامه چت. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]