Este guia explica como usar o método patch
no recurso Message
da
a API Google Chat para atualizar uma mensagem de texto ou card em um espaço. Atualize um
para alterar os atributos da mensagem, como o que ela diz, ou o conteúdo de uma
carda. Você também pode adicionar uma mensagem de texto ao início
mensagem de cartão ou anexar um cartão a uma mensagem de texto.
A API Chat também oferece suporte à
método update
,
mas recomendamos que você chame
Método patch
porque usa uma solicitação HTTP PATCH
enquanto
update
usa uma
solicitação HTTP PUT
. Para saber mais, consulte a
Seção PATCH
e PUT
do AIP-134.
Na API Chat, uma mensagem do Chat é representada por
Recurso Message
.
Os usuários do Chat só podem enviar mensagens com texto,
Os apps de chat podem usar muitos outros recursos de mensagens, incluindo
exibir interfaces do usuário estáticas ou interativas, coletar informações de
usuários e na entrega de mensagens com privacidade. Para saber mais sobre mensagens
recursos disponíveis para a API Chat, consulte o
Visão geral das mensagens do Google Chat.
Pré-requisitos
Python
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Python 3.6 ou superior
- a ferramenta de gerenciamento de pacotes PIP;
- As bibliotecas de cliente mais recentes do Google. Para instalar ou atualizar esses recursos,
execute o seguinte comando na interface de linha de comando:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- 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. o ícone e a descrição do app do Chat.
- Crie credenciais de acesso com base em como você quer autenticar sua API Google Chat
solicitação:
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credenciais e salvá-las 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
credenciais e salvá-las como um arquivo JSON chamado
credentials.json
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credenciais e salvá-las como um arquivo JSON chamado
- Escolha um escopo de autorização para autenticar como usuário ou como App Chat.
Atualizar uma mensagem de texto ou incluir uma mensagem de texto no início de uma mensagem do cartão usando a autenticação do usuário
Para atualizar um mensagem de texto com autenticação do usuário, aprovação o seguinte na sua solicitação:
- O escopo de autorização
chat.messages
. - O
name
da mensagem a ser atualizada. updateMask='text'
- Uma
body
que especifica a mensagem atualizada.
Se a mensagem atualizada for uma mensagem do cartão, Em seguida, a mensagem de texto é anexada à mensagem do cartão (que continua a ser exibida).
Veja como atualizar mensagem de texto ou incluir uma mensagem de texto no início mensagem do card com Autenticação do usuário:
Python
- Em seu diretório de trabalho, crie um arquivo chamado
chat_update_text_message_user.py
: Inclua o seguinte código em
chat_update_text_message_user.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.messages"] def main(): ''' Authenticates with Chat API via user credentials, then updates a message. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='text', body={'text': 'Updated message!'} ).execute() # Prints details about the updated message. print(result) if __name__ == '__main__': main()
No código, substitua o seguinte:
SPACE
: um nome de espaço, que você pode conferir em as Métodospaces.list
na API Chat ou pelo URL de um espaço.MESSAGE
: um nome de mensagem, que você pode acessar do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_update_text_message_user.py
Atualizar uma mensagem de texto ou incluir uma mensagem de texto no início de uma mensagem do cartão usando a autenticação do app
Para atualizar um mensagem de texto com autenticação de apps transmita o seguinte na sua solicitação:
- O escopo de autorização
chat.bot
. - O
name
da mensagem a ser atualizada. updateMask='text'
- Uma
body
que especifica a mensagem atualizada.
Se a mensagem atualizada for uma mensagem do cartão, Em seguida, a mensagem de texto é anexada à mensagem do cartão (que continua a ser exibida).
Veja como atualizar um mensagem de texto a uma mensagem de texto ou inclua uma mensagem de texto no início mensagem do card com autenticação de apps:
Python
- Em seu diretório de trabalho, crie um arquivo chamado
chat_update_text_message_app.py
: Inclua o seguinte código em
chat_update_text_message_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='text', body={'text': 'Updated message!'} ).execute() # Print Chat API's response in your command line interface. print(result)
No código, substitua o seguinte:
SPACE
: um nome de espaço, que você pode conferir em as Métodospaces.list
na API Chat ou pelo URL de um espaço.MESSAGE
: um nome de mensagem, que você pode acessar do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_update_text_message_app.py
Atualizar uma mensagem de card ou anexar uma mensagem de card a uma mensagem de texto
Para atualizar um mensagem do cartão, transmita o seguinte na sua solicitação:
- O escopo de autorização
chat.bot
. A atualização de uma mensagem de cartão exige autenticação de apps. - O
name
da mensagem a ser atualizada. updateMask='cardsV2'
- Uma
body
que especifica a mensagem atualizada.
Se a mensagem atualizada for uma mensagem de texto, Em seguida, um cartão é anexado à mensagem de texto (que continua sendo exibido). Se o a mensagem atualizada é uma card, o cartão exibido será atualizado.
Veja como atualizar uma mensagem para um mensagem do cartão:
Python
- Em seu diretório de trabalho, crie um arquivo chamado
chat_update_card_message.py
: Inclua o seguinte código em
chat_update_card_message.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='cardsV2', body= { 'cardsV2': [{ 'cardId': 'updateCardMessage', 'card': { 'header': { 'title': 'An Updated Card Message!', 'subtitle': 'Updated with Chat REST API', 'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png', 'imageType': 'CIRCLE' }, 'sections': [ { 'widgets': [ { 'buttonList': { 'buttons': [ { 'text': 'Read the docs!', 'onClick': { 'openLink': { 'url': 'https://developers.google.com/chat' } } } ] } } ] } ] } }] } ).execute() # Print Chat API's response in your command line interface. print(result)
No código, substitua o seguinte:
SPACE
: um nome de espaço, que você pode conferir em as Métodospaces.list
na API Chat ou pelo URL de um espaço.MESSAGE
: um nome de mensagem, que você pode acessar do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_update_card_message.py
A API Chat retorna uma instância do
Message
que detalha a mensagem atualizada.
Atualizar uma mensagem com vários caminhos de campo simultaneamente
Quando uma mensagem é atualizada, você pode atualizar vários caminhos de campo de mensagem no
tempo de resposta. Por exemplo, em uma solicitação de atualização de mensagem, é possível especificar uma alteração na
Os caminhos do campo text
e cardsv2
ao mesmo tempo, o que atualiza os dois
o texto e o card da mensagem. Se a mensagem incluir apenas texto e nenhum cartão, um cartão
é adicionado à mensagem. Para mais informações sobre os caminhos de campo compatíveis,
ver
Parâmetros updateMask
.
Para atualizar o valor-chave
text
e
card
de uma mensagem com
autenticação do usuário
transmita o seguinte na sua solicitação:
- O escopo de autorização
chat.messages
. - O
name
da mensagem a ser atualizada. Uma
updateMask
que especifica os caminhos do campo de mensagem a serem atualizados, separados por vírgulas:updateMask='text', 'cardsV2'
.Um
body
que especifica a mensagem atualizada, incluindo todos os campos atualizados. caminhos de rede.
Veja como atualizar os caminhos de campo text
e cardsV2
em um
enviar mensagem com
autenticação do usuário:
Python
- Em seu diretório de trabalho, crie um arquivo chamado
chat_update_text_message_user.py
: Inclua o seguinte código em
chat_update_text_message_user.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.messages"] def main(): ''' Authenticates with Chat API via user credentials, then updates a message. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='text,cardsV2', body= {'text': 'Updated message!', 'cardsV2': [{ 'cardId': 'updateCardMessage', 'card': { 'header': { 'title': 'An Updated Card Message!', 'subtitle': 'Updated with Chat REST API', 'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png', 'imageType': 'CIRCLE' }, 'sections': [ { 'widgets': [ { 'buttonList': { 'buttons': [ { 'text': 'Read the docs!', 'onClick': { 'openLink': { 'url': 'https://developers.google.com/chat' } } } ] } } ] } ] } }] } ).execute() # Prints details about the updated message. print(result) if __name__ == '__main__': main()
No código, substitua o seguinte:
SPACE
: um nome de espaço, que você pode conferir em as Métodospaces.list
na API Chat ou pelo URL de um espaço.MESSAGE
: um nome de mensagem, que você pode acessar do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_update_text_message_user.py
Temas relacionados
- Formatar uma mensagem.
- Excluir uma mensagem.
- Ver detalhes sobre uma mensagem.
- Listar mensagens em um espaço
- Enviar uma mensagem.