Identifica y especifica los usuarios de Google Chat

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:

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, con el formato users/{user}, en el que {user} representa un identificador único y estable. users/app se puede usar como alias para 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. Para las apps de chat, el valor es BOT. Para las personas, el valor es HUMAN.

Especifica un usuario en una llamada a la API de Google Chat

A fin de 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 recurso User en la API de Chat, como users/123456789
    • El {person_id} para el nombre de un recurso Person en la API de Personas, en el que el resourceName es people/{person_id}; por ejemplo, users/123456789 en la API de Chat representa la misma persona que people/123456789 en la API de Personas.
    • El id para un recurso User en la API de Directory, por ejemplo, users/123456789 en la API de Chat representa a la misma persona que users/123456789 en la API de Directory.
  • Para un usuario de una organización externa de Google Workspace o un usuario que usa una Cuenta de Google, usa un alias de correo electrónico, por ejemplo, users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com o users/EMAIL_USERNAME@gmail.com.

Cómo identificar 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, esta recibe información sobre la interacción, incluido 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 al usuario que interactuó con una app de Chat, obtén el valor de la propiedad name en el recurso User, que puedes obtener de 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: