User
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Un usuario en Google Chat Cuando se muestra como resultado de una solicitud, si tu app de Chat se autentica como usuario, el resultado de un recurso User solo propaga los datos de name y type del usuario.
| Representación JSON |
{
"name": string,
"displayName": string,
"domainId": string,
"type": enum (Type),
"isAnonymous": boolean
} |
| Campos |
name |
string
Nombre de recurso de user de Google Chat. Formato: users/{user}. users/app se puede usar como alias para el usuario bot de la app que realiza la llamada. Para human users, {user} es el mismo identificador de usuario que:
id para Person en la API de People Por ejemplo, users/123456789 en la API de Chat representa a la misma persona que el ID de perfil de persona 123456789 de la API de People.
id para un usuario en la API de Directory del SDK de Admin
La dirección de correo electrónico del usuario se puede usar como un alias para {user} en las solicitudes a la API. Por ejemplo, si el ID de perfil de persona de la API de People para user@example.com es 123456789, puedes usar users/user@example.com como alias para hacer referencia a users/123456789. La API solo mostrará el nombre del recurso canónico (por ejemplo, users/123456789).
|
displayName |
string
Solo salida. El nombre visible del usuario.
|
domainId |
string
Es el identificador único del dominio de Google Workspace del usuario.
|
type |
enum (Type)
Tipo de usuario.
|
isAnonymous |
boolean
Solo salida. Cuando sea true, se borrará el usuario o su perfil no será visible.
|
Tipo
| Enumeraciones |
TYPE_UNSPECIFIED |
Valor predeterminado de la enumeración. NO USAR. |
HUMAN |
Usuario humano. |
BOT |
Usuario de la app de Chat |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]
