Esta página descreve os eventos do Google Chat que um app do Google Chat pode assinar usando a API Google Workspace Events. Depois de decidir quais tipos de eventos você precisa, crie uma assinatura para começar a receber eventos do Google Chat.
Além de se inscrever em eventos, você também pode consultar eventos chamando a API Chat. Chamar a API Chat permite extrair eventos periodicamente ou acompanhar os eventos de uma assinatura que você perdeu devido a uma interrupção. Para saber como receber e responder a eventos do Chat, consulte Trabalhar com eventos do Google Chat na documentação do Chat.
Eventos do Chat aceitos
As assinaturas do Google Workspace permitem que você receba eventos sobre os seguintes tipos de mudanças no Chat:
- Mensagens novas, atualizadas ou excluídas no espaço.
- Reações novas ou removidas de uma mensagem.
- Participantes novos, atualizados ou removidos do espaço.
- Mudanças no espaço em que você tem uma assinatura, como um nome ou descrição atualizados.
Recursos que podem ser monitorados para eventos
Para receber eventos, especifique um recurso do Chat a ser monitorado, chamado de recurso de destino da assinatura.
A API Google Workspace Events oferece suporte aos seguintes recursos de destino para o Chat:
| Recurso de destino | Formato | Limitações |
|---|---|---|
| Espaço |
em que SPACE é o ID no
nome do recurso do recurso |
O usuário do Chat que autoriza a assinatura precisa ser membro do espaço usando a Conta do Google ou do Google Workspace. |
| Todos os espaços de um usuário |
|
A assinatura só recebe eventos dos espaços em que o usuário é membro pelo Google Workspace ou pela Conta do Google. |
| Usuário |
em que USER é o ID no
nome do recurso do recurso |
A assinatura só recebe eventos sobre o usuário que autorizou a assinatura. Um usuário não pode autorizar uma assinatura em nome de outros usuários. |
Tipos de evento para criar assinaturas
Ao criar uma assinatura, você usa o campo
eventTypes[]
para especificar os tipos de eventos que quer receber. Os tipos de evento são
formatados de acordo com a especificação do CloudEvents, como
google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.
Por exemplo, para receber eventos sobre usuários que entram em um espaço do Chat, especifique o espaço como o recurso de destino e o tipo de evento como google.workspace.chat.membership.v1.created. Para receber eventos sobre um determinado usuário que entra em qualquer espaço, especifique o usuário como o recurso de destino e o tipo de evento como google.workspace.chat.membership.v1.created. Para saber mais sobre
como os eventos funcionam, consulte Estrutura dos eventos do Google
Workspace.
A tabela a seguir mostra quais tipos de evento são compatíveis com assinaturas de espaços e assinaturas de usuários. Para saber mais sobre exceções sobre o que aciona um evento, consulte Limitações.
| Tipo de evento | Formato | Dados do recurso | ||
|---|---|---|---|---|
| Assinaturas de espaços | ||||
| Uma mensagem é postada. |
|
|
||
| Uma mensagem é atualizada. |
|
|
||
| Uma mensagem é excluída. |
|
|
||
| Uma reação é criada. |
|
|
||
| Uma reação é excluída. |
|
|
||
| Um participante é adicionado ao espaço. |
|
|
||
| Um participante é atualizado no espaço. |
|
|
||
| Um participante é removido do espaço. |
|
|
||
| O espaço é atualizado. |
|
|
||
| O espaço é excluído. |
|
|
||
| Assinaturas de usuários | ||||
| O usuário se torna participante de um espaço.
Nem todos os novos membros acionam eventos. Para mais detalhes, consulte Limitações. |
|
|
||
| A associação do usuário a um espaço é atualizada. |
|
|
||
| O usuário é removido como membro direto de um espaço. |
|
|
||
Tipos de evento em lote (somente saída)
Além de receber os tipos de evento que você assina, o app Chat também pode receber eventos em lote. Um evento em lote é um evento que representa muitos eventos do mesmo tipo que ocorrem em um curto período. O payload de um evento em lote contém uma lista de todos os recursos alterados.
Por exemplo, se um usuário adicionar 20 usuários a um espaço ao mesmo tempo, seu
app de chat poderá receber um evento em lote
(google.workspace.chat.membership.v1.batchCreated). O payload do evento contém
uma lista de todos os novos recursos Membership que foram criados quando o usuário
adicionou os membros ao espaço.
Você recebe um evento em lote para qualquer tipo de evento em que se inscreveu. Portanto, não é necessário especificar eventos em lote ao criar uma assinatura. Por
exemplo, se você se inscrever em novas reações
(google.workspace.chat.reaction.v1.created), o
app Chat será configurado automaticamente para receber eventos
de reação em lote (google.workspace.chat.reaction.v1.batchCreated).
A tabela a seguir mostra os possíveis eventos em lote de uma assinatura:
| Tipo de evento em lote | Formato |
|---|---|
| Várias mensagens são postadas. |
|
| Várias mensagens são atualizadas. |
|
| Várias mensagens são excluídas. |
|
| Várias reações são criadas. |
|
| Várias reações são excluídas. |
|
| Vários participantes foram adicionados ao espaço ou o usuário foi adicionado a vários espaços. |
|
| Várias assinaturas são atualizadas no espaço ou para o usuário. |
|
| Vários participantes foram removidos do espaço ou o usuário foi removido de vários espaços. |
|
| O espaço tem várias atualizações. |
|
Dados de eventos
Esta seção descreve os dados de eventos e exemplos de payloads para eventos no Chat.
Quando sua assinatura do Google Workspace recebe um evento do
Chat, o campo
data
contém o payload do evento. Esse payload tem informações sobre o recurso do Google Workspace que foi alterado. Por exemplo, se você se inscreveu em eventos de associação em um espaço, o payload desses eventos contém informações sobre o recurso spaces.membership que foi alterado.
Dados de recursos no payload do evento
Ao criar uma assinatura, você pode especificar se o payload vai incluir detalhes sobre o recurso ou apenas o nome dele. Por exemplo, se você quiser receber eventos sobre os membros em um espaço de chat, especifique quais campos de um recurso de participação você quer receber no payload do evento.
A tabela a seguir mostra exemplos de payloads JSON para uma assinatura do espaço de chat spaces/AAAABBBBBB. Para cada evento que a
assinatura recebe, o payload aparece no campo data do evento:
| Exemplo | Tipo de evento | Payload do JSON |
|---|---|---|
Um usuário posta uma mensagem no espaço que diz "Olá, mundo". |
|
Inclui dados de recursos
{
"message":
{
"name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD",
"sender":
{
"name": "users/1234567890987654321",
"type": "HUMAN"
},
"createTime": "2023-09-07T21:37:36.260127Z",
"text": "Hello world",
"thread":
{
"name": "spaces/AAAABBBBBB/threads/EEEEEEEEEEEE"
},
"space":
{
"name": "spaces/AAAABBBBBB"
},
"argumentText": "Hello world"
}
}
Exclui dados de recursos
{
"message":
{
"name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD"
}
}
|
| Um usuário se torna administrador do espaço. |
|
Inclui dados de recursos
{
"membership":
{
"name": "spaces/AAAABBBBBB/members/1234567890987654321",
"state": "JOINED",
"member":
{
"name": "users/1234567890987654321",
"type": "HUMAN"
},
"createTime": "1970-01-01T00:00:00Z",
"role": "ROLE_MANAGER"
}
}
Exclui dados de recursos
{
"membership":
{
"name": "spaces/AAAABBBBBB/members/1234567890987654321"
}
}
|
| Um usuário atualiza a descrição do espaço para "Equipe de vendas da Cymbal Labs". | google.workspace.chat.space.v1.updated |
Inclui dados de recursos
{
"space":
{
"name": "spaces/AAAABBBBBB",
"displayName": "Cymbal Sales",
"spaceThreadingState": "THREADED_MESSAGES",
"spaceType": "SPACE",
"spaceDetails":
{
"description": "Sales team for Cymbal Labs."
},
"spaceHistoryState": "HISTORY_ON"
}
}
Exclui dados de recursos
{
"space":
{
"name": "spaces/AAAABBBBBB"
}
}
|
| Dois usuários do Chat foram adicionados ao espaço ao mesmo tempo. | google.workspace.chat.membership.v1.batchCreated |
Inclui dados de recursos
{
"memberships": [
{
"membership": {
"name": "spaces/AAAABBBBBB/members/1234567890987654321",
"state": "JOINED",
"member":
{
"name": "users/1234567890987654321",
"type": "HUMAN"
},
"createTime": "1970-01-01T00:00:00Z",
"role": "ROLE_MEMBER"
}
},
{
"membership": {
"name": "spaces/AAAABBBBBB/members/987654321234567890",
"state": "JOINED",
"member":
{
"name": "users/987654321234567890",
"type": "HUMAN"
},
"createTime": "1970-01-01T00:00:00Z",
"role": "ROLE_MEMBER"
}
}
]
}
Exclui dados de recursos
{
"memberships": [
{
"membership": {
"name": "spaces/AAAABBBBBB/members/1234567890987654321"
}
},
{
"membership": {
"name": "spaces/AAAABBBBBB/members/98765432123456789019"
}
}
]
}
|
| Um usuário reage a uma mensagem com o emoji 😊. | google.workspace.chat.reaction.v1.created |
Inclui dados de recursos
{
"reaction":
{
"name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
"user":
{
"name": "users/1234567890987654321",
"type": "HUMAN"
},
"emoji":
{
"unicode": "😊"
}
}
}
Omite dados de recursos
{
"reaction":
{
"name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
}
}
|
| Os usuários reagem a uma mensagem com os emojis 😊 e 😸. | google.workspace.chat.reaction.v1.batchCreated |
Inclui dados de recursos
{
"reactions": [
{
"reaction": {
"name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
"user":
{
"name": "users/1234567890987654321",
"type": "HUMAN"
},
"emoji":
{
"unicode": "😊"
}
}
},
{
"reaction": {
"name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
"user":
{
"name": "users/98765431234564321",
"type": "HUMAN"
},
"emoji":
{
"unicode": "😸"
}
}
}
]
}
Omite dados de recursos
{
"reactions": [
{
"reaction": {
"name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
},
"reaction": {
"name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
}
}
]
}
|
Limitações
-
Para assinaturas de usuários, eventos sobre novos membros em mensagens diretas ou chats em grupo sem nome (
google.workspace.chat.membership.v1.created), só acione depois que a primeira mensagem for postada. - Para receber eventos de participação, o usuário precisa ser um participante direto do espaço. Se um usuário foi adicionado, atualizado ou removido indiretamente de um espaço por um Grupo do Google, a assinatura não recebe esses eventos de participação. Para entender como funciona a associação a grupos do Google, consulte Adicionar um grupo do Google a um espaço.
Temas relacionados
- Estrutura dos eventos do Google Workspace
- Escolher escopos do OAuth
- Criar uma assinatura para receber eventos do Chat