En esta página, se explican las formas en que las apps de Google Chat pueden identificar o especificar usuarios de Chat.
Para realizar alguna de las siguientes acciones, una app de Chat debe especificar un usuario:
- Crea un mensaje que @ mencione a un usuario.
- Invita a un usuario o agrégalo a un espacio existente, o bien a un espacio nuevo.
- Busca mensajes directos entre la app de Chat y un usuario específico, o entre dos usuarios.
- Obtén los detalles de la membresía de un usuario en un espacio.
- Envía un mensaje privado a un usuario.
Cómo identifica Chat a los usuarios
La API de Google Chat genera un recurso User
para cada persona que usa Chat. Los siguientes son dos campos User
importantes:
name
es el nombre del recurso del recurso, con el formatousers/{user}
, en el que{user}
representa un identificador único y estable. Se puede usarusers/app
como alias de la app de Chat que realiza la llamada.type
es el tipo de usuario. Este tipo le indica a Chat si el usuario es una app de Chat o una persona. En el caso de las apps de Chat, el valor esBOT
. Para las personas, el valor esHUMAN
.
Especifica un usuario en una llamada a la API de Google Chat
Para especificar un usuario, usa los siguientes valores para el valor {user}
:
Para los usuarios de tu organización de Google Workspace, usa uno de los siguientes enfoques:
- El
name
del recursoUser
en la API de Chat, comousers/123456789
- El
{person_id}
para el nombre de un recursoPerson
en la API de People, en el queresourceName
espeople/{person_id}
; por ejemplo,users/123456789
en la API de Chat representa a la misma persona quepeople/123456789
en la API de People - El
id
de un recursoUser
en la API de Directory, por ejemplo,users/123456789
en la API de Chat representa a la misma persona queusers/123456789
en la API de Directory.
- El
Para un usuario de una organización externa de Google Workspace o un usuario que usa una Cuenta de Google, utiliza un alias de correo electrónico, por ejemplo,
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com
ousers/EMAIL_USERNAME@gmail.com
.
Identifica a un usuario a partir de un evento de interacción
Cada vez que un usuario interactúa con una app de Chat, Chat envía un evento de interacción con información sobre la interacción y el usuario. Por ejemplo, cuando un usuario menciona una app de Chat en un mensaje, la app recibe información sobre la interacción, lo que incluye lo que dice el mensaje y quién lo envió. Las apps de Chat hacen referencia a los usuarios cuando recuperan información sobre los recursos de Chat.
Para identificar el usuario que interactuó con una app de Chat,
obtén el valor de la propiedad name
en el
recurso User
,
que puedes obtener en
Event.user.name
.
En el siguiente ejemplo de JSON, se muestra el formato esperado de la identidad del usuario en una interacción con una app de Chat:
{
...,
"user": {
"name": "users/12345678901234567890",
"displayName": "Sasha",
"avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
"email": "sasha@example.com"
}
}
Un mensaje es un tipo específico de interacción. Para identificar a un usuario que envió un mensaje a una app de Chat, obtén el valor de la propiedad name
en el recurso User
mediante una de las siguientes opciones:
Temas relacionados
- Agrega un usuario a un espacio.
- Administra los miembros de un espacio
- @ menciona a un usuario en un mensaje.