Este guia explica como usar o método
update()
no recurso Message
da API Google Chat para atualizar uma mensagem de texto ou cartão
em um espaço. Atualizar uma mensagem para mudar os atributos dela, como o
conteúdo de um card. Também é possível adicionar uma mensagem de texto a uma
mensagem de cartão ou anexar um cartão a uma mensagem de texto.
Na API Chat, uma mensagem é representada pelo
recurso Message
.
Enquanto os usuários do Chat só podem enviar mensagens de texto,
os apps de chat podem usar muitos outros recursos de mensagens, incluindo
a exibição de interfaces de usuário estáticas ou interativas, a coleta de informações dos
usuários e o envio de mensagens particulares. Para saber mais sobre os recursos de mensagens
disponíveis para a API Chat, consulte a
Visão geral das mensagens do Google Chat.
Pré-requisitos
Node.js
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Instale o Node.js biblioteca de cliente do Cloud.
- Crie credenciais de acesso com base em como você quer autenticar na API Google Chat
solicitação:
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credentials e salve-as como um arquivo JSON chamado
client_secrets.json
ao diretório local. - Para fazer a autenticação como o app de chat,
crie credenciais da conta de serviço e salve-as como um arquivo JSON chamado
credentials.json
.
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credentials e salve-as como um arquivo JSON chamado
- Escolha um escopo de autorização com base em se você quer autenticar como um usuário ou o app Chat.
Python
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Instale o Python biblioteca de cliente do Cloud.
- Crie credenciais de acesso com base em como você quer autenticar na API Google Chat
solicitação:
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credentials e salve-as como um arquivo JSON chamado
client_secrets.json
ao diretório local. - Para autenticar como o app do Chat, faça o seguinte:
criar conta de serviço
credentials e salve-as como um arquivo JSON chamado
credentials.json
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credentials e salve-as como um arquivo JSON chamado
- Escolha um escopo de autorização com base em se você quer autenticar como um usuário ou o app Chat.
Java
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud para Java.
- Crie credenciais de acesso com base na forma como você quer se autenticar na solicitação da API Google Chat:
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credentials e salve-as como um arquivo JSON chamado
client_secrets.json
ao diretório local. - Para autenticar como o app do Chat, faça o seguinte:
criar conta de serviço
credentials e salve-as como um arquivo JSON chamado
credentials.json
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credentials e salve-as como um arquivo JSON chamado
- Escolha um escopo de autorização para autenticar como usuário ou como App Chat.
Apps Script
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome. o ícone e a descrição do app do Chat.
- Crie um projeto independente do Apps Script, e ative o serviço avançado de chat.
- Neste guia, você deve usar as funções de usuário ou autenticação de apps. Para autenticar como o app do Chat, crie credenciais da conta de serviço. Para conferir as etapas, consulte Autenticar e autorizar como um app Google Chat.
- Escolha um escopo de autorização com base em se você quer autenticar como um usuário ou o app Chat.
Atualizar uma mensagem em nome de um usuário
Com a autenticação de usuários, somente o texto da mensagem pode ser atualizado.
Para atualizar uma mensagem com a autenticação do usuário, transmita o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.messages
. - Chame o método
UpdateMessage()
. - Transmita
message
como uma instância deMessage
com o seguinte:- O campo
name
definido como a mensagem a ser atualizada, que inclui um ID do espaço e um ID da mensagem. - O campo
text
definido com o novo texto.
- O campo
- Transmita
updateMask
com o valortext
.
Se a mensagem atualizada for uma mensagem do cartão, Em seguida, o texto é anexado aos cards, que continuam sendo exibidos.
Veja como atualizar uma mensagem ou incluir uma mensagem de texto no início de uma mensagem de card com a autenticação de usuários:
Node.js
Python
Java
Apps Script
Para executar este exemplo, substitua o seguinte:
SPACE_NAME
: o ID doname
do espaço. Você pode obter o ID chamando oListSpaces()
ou do URL do espaço.MESSAGE_NAME
: o ID da mensagemname
. Você pode obter o ID no corpo da resposta retornada após criar uma de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
A API Chat retorna uma instância de
Message
que detalha a mensagem atualizada.
Atualizar uma mensagem como o app Chat
Com a autenticação de apps, o texto e os cards de uma mensagem podem ser atualizados.
Para atualizar uma mensagem com autenticação de app, transmita o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.bot
. - Chame o método
UpdateMessage()
. - Transmita
message
como uma instância doMessage
pelo seguinte:- O campo
name
definido como a mensagem a ser atualizada, que inclui um ID do espaço e um ID da mensagem. - O campo
text
definido com o novo texto, se precisar ser atualizado. - O campo
cardsV2
definido com os novos cards, se eles precisarem ser atualizados.
- O campo
- Transmita
updateMask
com a lista de campos para atualizações, comotext
ecardsV2
.
Se a mensagem atualizada for uma mensagem de cartão e o texto for atualizado, o texto atualizado será adicionado aos cards (que continuam sendo exibidos). Se a mensagem atualizada for uma mensagem de texto e cards são atualizados, os cards atualizados são anexados ao texto (que continua exibição).
Veja como atualizar o texto e os cards de uma mensagem com autenticação de apps:
Node.js
Python
Java
Apps Script
Para executar este exemplo, substitua o seguinte:
SPACE_NAME
: o ID do espaço.name
. Você pode obter o ID chamando oListSpaces()
ou do URL do espaço.MESSAGE_NAME
: o ID doname
da mensagem. É possível receber o ID do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem na criação.
A API Chat retorna uma instância do
Message
que detalha a mensagem atualizada.
Temas relacionados
- Formatar uma mensagem.
- Excluir uma mensagem.
- Ver detalhes de uma mensagem.
- Listar mensagens em um espaço
- Enviar uma mensagem.