Atualizar uma mensagem

Neste guia, explicamos como usar o método patch no recurso Message da API Google Chat para atualizar uma mensagem de texto ou card em um espaço. Atualize uma mensagem para mudar os atributos dela, como o que ela diz ou o conteúdo de um card. Também é possível anexar uma mensagem de texto a uma mensagem de cartão ou anexar um cartão a uma mensagem de texto.

A API Chat também oferece suporte ao método update, mas recomendamos chamar o método patch, porque ele 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.

O recurso Message representa uma mensagem de texto ou card no Google Chat. É possível create, get, update ou delete uma mensagem na API Google Chat chamando métodos correspondentes. Para saber mais sobre mensagens de texto e cards, consulte Visão geral das mensagens do Google Chat.

Pré-requisitos

Python

  • Python 3.6 ou posterior
  • A ferramenta de gerenciamento de pacotes pip

  • As bibliotecas de cliente mais recentes do Google para Python. Para instalá-los ou atualizá-los, execute o seguinte comando na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client

  • Um app do Chat publicado. Para criar e publicar um app do Chat, consulte Criar um app do Google Chat.

  • Autorização configurada para o app do Chat:

Atualizar ou adicionar uma mensagem de texto a uma mensagem de texto com a autenticação do usuário

Para atualizar uma mensagem de texto com autenticação do usuário, transmita o seguinte na solicitação:

  • O escopo de autorização chat.messages.
  • O name da mensagem a ser atualizada.
  • updateMask='text'
  • Um body que especifica a mensagem atualizada.

Se a mensagem atualizada for uma mensagem de cartão, a mensagem de texto será anexada à mensagem do cartão, que continuará sendo exibida.

Veja como atualizar uma mensagem de texto ou anexar uma mensagem de texto a uma mensagem do card com autenticação de usuário:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_update_text_message_user.py.

  2. Inclua o seguinte código em chat_update_text_message_user.py:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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 created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.
    • MESSAGE: um nome de mensagem, que pode ser conseguido no corpo da resposta retornado depois de criar uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_update_text_message_user.py

Atualizar ou adicionar uma mensagem de texto a uma mensagem de cartão usando a autenticação de apps

Para atualizar uma mensagem de texto com autenticação de app, transmita o seguinte na solicitação:

  • O escopo de autorização chat.bot.
  • O name da mensagem a ser atualizada.
  • updateMask='text'
  • Um body que especifica a mensagem atualizada.

Se a mensagem atualizada for uma mensagem de cartão, a mensagem de texto será anexada à mensagem do cartão, que continuará sendo exibida.

Veja como transformar uma mensagem de texto em uma mensagem de texto ou adicionar uma mensagem no cartão ao início dela com autenticação de apps:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_update_text_message_app.py.

  2. Inclua o seguinte código em chat_update_text_message_app.py:

    from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
  'credentials.json', SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http()))

# 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)

  3. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.
    • MESSAGE: um nome de mensagem, que pode ser conseguido no corpo da resposta retornado depois de criar uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.

  4. 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 a uma mensagem de texto

Para atualizar uma mensagem do cartão, transmita o seguinte em sua solicitação:

  • O escopo de autorização chat.bot. A atualização de uma mensagem de cartão requer a autenticação do app.
  • O name da mensagem a ser atualizada.
  • updateMask='cardsV2'
  • Um body que especifica a mensagem atualizada.

Se a mensagem atualizada for uma mensagem de texto, um card será anexado à mensagem, que continuará sendo mostrada. Se a mensagem atualizada for um card, o cartão exibido será atualizado.

Veja como atualizar uma mensagem para uma mensagem de cartão:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_update_card_message.py.

  2. Inclua o seguinte código em chat_update_card_message.py:

    from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
  'credentials.json', SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http()))

# 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)

  3. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.

    • MESSAGE: um nome de mensagem, que pode ser conseguido no corpo da resposta retornado depois de criar uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_update_card_message.py

A API Chat retorna uma instância de Message que detalha a mensagem que é atualizada.

Atualizar uma mensagem com vários caminhos de campo simultaneamente

Quando uma mensagem é atualizada, é possível atualizar vários caminhos de campo de mensagem simultaneamente. Por exemplo, em uma solicitação de mensagem de atualização, é possível especificar uma mudança nos caminhos dos campos text e cardsv2 ao mesmo tempo, o que atualiza o texto e o card da mensagem. Se a mensagem incluir apenas texto e nenhum cartão, um card será adicionado à mensagem. Para mais informações sobre os caminhos de campo compatíveis, consulte Parâmetros updateMask.

Para atualizar o text e o card de uma mensagem com a autenticação do usuário, transmita o seguinte na solicitação:

  • O escopo de autorização chat.messages.
  • O name da mensagem a ser atualizada.

  • Um 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 caminhos de campo atualizados.

Veja como atualizar os caminhos dos campos text e cardsV2 em uma mensagem com autenticação do usuário:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_update_text_message_user.py.

  2. Inclua o seguinte código em chat_update_text_message_user.py:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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 created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.
    • MESSAGE: um nome de mensagem, que pode ser conseguido no corpo da resposta retornado depois de criar uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_update_text_message_user.py