Esta página explica as maneiras como os apps do Google Chat podem identificar ou especificar usuários do Chat.
Para realizar qualquer uma das seguintes ações, um app de chat precisa especificar um usuário:
- Crie uma mensagem que @ menciona um usuário.
- Convide ou adicione um usuário a um espaço que já existe ou adicione um usuário a um novo espaço.
- Encontre mensagens diretas entre o app do Chat e um usuário específico ou entre dois usuários.
- Conferir os detalhes dos participantes de um espaço.
- Envie uma mensagem privada para 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 comousers/{user}
, em que{user}
representa um identificador exclusivo e estável.users/app
pode 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 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 os seguintes valores para o valor de {user}
:
Para os usuários na organização do Google Workspace, use uma das seguintes abordagens:
- O
name
do recursoUser
na API Chat, comousers/123456789
. - O
{person_id}
para o nome de um recursoPerson
na API People, em queresourceName
épeople/{person_id}
. Por exemplo,users/123456789
na API Chat representa a mesma pessoa quepeople/123456789
na API People. - O
id
de um recursoUser
na API Directory, por exemplo,users/123456789
na API Chat representa a mesma pessoa queusers/123456789
na API Directory.
- O
Para um usuário em uma organização externa do Google Workspace ou um usuário que usa uma Conta do Google, use um alias de e-mail, por exemplo,
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com
ouusers/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, o app do Chat recebe informações sobre a interação, incluindo o que a mensagem diz e quem a enviou. Os apps de chat fazem referência aos usuários ao extrair 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 obtido em
Event.user.name
.
O exemplo 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,
acesse o valor da propriedade name
no
recurso User
usando uma destas
opções:
Temas relacionados
- Adicionar um usuário a um espaço.
- Gerenciar os participantes de um espaço
- @ Mencionar um usuário em uma mensagem