Identificar e especificar usuários do Google Chat

Nesta página, explicamos como os apps do Google Chat podem identificar ou especificar usuários do Chat.

Para realizar uma destas ações, um app do Chat precisa especificar um usuário:

Como o Chat identifica os usuários

A API Google Chat gera um recurso User para cada pessoa que usa o Chat. Veja a seguir dois campos User importantes:

  • name é o nome do recurso, formatado como users/{user}, em que {user} representa um identificador exclusivo e estável. users/app pode ser usado como um alias do app de chamada do Chat.
  • type é o tipo de usuário. Esse tipo informa ao Chat se o usuário é um app do Chat ou uma pessoa. Para apps do Chat, o valor é BOT. Para pessoas, o valor é HUMAN.

Especificar um usuário em uma chamada para a API Google Chat

Para especificar um usuário, use estes valores de {user}:

  • Para usuários na sua organização do Google Workspace, use uma das seguintes abordagens:

    • O name do recurso User na API Chat, como users/123456789.
    • O {person_id} para o nome de um recurso Person na API People, em que resourceName é people/{person_id}. Por exemplo, users/123456789 na API Chat representa a mesma pessoa que people/123456789 na API People.
    • O id de um recurso User na API Directory, por exemplo, users/123456789 na API Chat representa a mesma pessoa que users/123456789 na API Directory.

  • Para um usuário em uma organização externa do Google Workspace ou um usuário que utiliza uma Conta do Google, use um alias de e-mail, por exemplo, users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com ou users/EMAIL_USERNAME@gmail.com.

Identificar um usuário em um evento de interação

Sempre que um usuário interage com um app do Chat, o Chat envia um evento de interação com informações sobre a interação e o usuário. Por exemplo, quando um usuário menciona um app do Chat em uma mensagem, esse app recebe informações sobre a interação, incluindo o que diz a mensagem e quem a enviou. Os apps de chat referenciam os usuários ao recuperar informações sobre os recursos do Chat.

Para identificar o usuário que interagiu com um app do Chat, extraia o valor da propriedade name no recurso User, que pode ser encontrado em Event.user.name.

O exemplo de JSON a seguir mostra o formato esperado da identidade do usuário em uma interação com um app do Chat:

{
  ...,
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Sasha",
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "sasha@example.com"
  }
}

Uma mensagem é um tipo específico de interação. Para identificar um usuário que enviou uma mensagem a um app do Chat, extraia o valor da propriedade name no recurso User usando uma das seguintes opções: