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 cualquiera 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 use Chat. Estos son dos aspectos importantes Campos User:

  • name es el nombre del recurso, con el formato users/{user}. donde {user} representa un identificador único y estable. users/app puede usarse como un alias para la app de Chat que realiza la llamada.
  • type es el tipo de usuario. que le indica a Chat si usuario es una app de Chat o una persona. Para 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

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 los siguientes enfoques:

    • El name del Recurso User en la API de Chat, como users/123456789.
    • El {person_id} para el nombre de un El recurso Person en la API de People en el que resourceName es people/{person_id}, por ejemplo, users/123456789 en la API de Chat representa a la misma persona. como people/123456789 en la API de People.
    • 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. como 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 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 el la interacción y el usuario. Por ejemplo, cuando un el usuario menciona una app de Chat en un mensaje, La app de Chat recibe información sobre la interacción incluidos lo que dice el mensaje y quién lo envió. Apps de chat hacer referencia a los usuarios cuando recuperen información sobre los recursos de Chat.

Para identificar a los usuarios que interactuaron con la app de Chat, sigue estos pasos: obtén el valor de la propiedad name en la Recurso User, que puedes obtener de Event.user.name

El siguiente ejemplo de JSON 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 la Recurso User, mediante cualquiera de los lo siguiente: