Identificar e especificar usuários do Google Chat

Esta página explica como os apps do Google Chat podem identificar ou especificar Usuários do Chat.

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

Como o Chat identifica os usuários

A API Google Chat gera uma Recurso User para cada pessoa que usa o Chat. A seguir, são dois importantes Campos User:

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

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

Para especificar um usuário, use os seguintes valores para o valor {user}:

  • Para os usuários na sua organização do Google Workspace, use um dos as seguintes abordagens:

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

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

Identificar um usuário de 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 interação e o usuário. Por exemplo, quando um se o usuário mencionar um app do Chat em uma mensagem, o app de chat recebe informações sobre a interação. incluindo o que a mensagem diz e quem a enviou. Apps de chat fazem referência aos usuários ao recuperar informações sobre os recursos do Chat.

Para identificar o usuário que interagiu com um app do Chat, acesse o valor da propriedade name no Recurso User, que você pode conseguir 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 para um app do Chat acesse o valor da propriedade name no User usando um dos seguinte: