Esta página foi traduzida pela API Cloud Translation.

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 alterar os atributos dela, como o texto dela ou o conteúdo de um card. Também é possível anexar um cartão a uma mensagem de texto ou incluir um cartão nele antes do início de 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. Você pode usar create, get, update ou delete em 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 superior
A ferramenta de gerenciamento de pacotes pip
As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte na interface de linha de comando:
```
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
```
Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.
Autorização configurada para o app do Chat:
- A atualização de uma mensagem de texto tem suporte aos dois métodos de autenticação a seguir:
  - A autenticação do usuário, com o escopo de autorização chat.messages, pode atualizar mensagens criadas por esse usuário.
  - A autenticação de apps com o escopo de autorização chat.bot pode atualizar mensagens criadas por esse aplicativo.
- A atualização de uma mensagem do cartão requer autenticação do app com o escopo de autorização chat.bot.

Atualizar ou adicionar uma mensagem de texto antes de uma mensagem de cartão usando 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 continua sendo exibida).

Veja como atualizar uma mensagem de texto ou preparar uma mensagem de texto para uma mensagem de cartão com autenticação de usuário:

Python

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

if __name__ == '__main__':
    main()

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 obtido no corpo da resposta retornado depois de criar uma mensagem de maneira assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.
No diretório de trabalho, crie e execute a amostra:
```
python3 chat_update_text_message_user.py
```

Atualize uma mensagem de texto ou inclua uma mensagem de texto no início de uma mensagem de cartão usando a autenticação de app.

Para atualizar uma 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'
Um body que especifica a mensagem atualizada.

Se a mensagem atualizada for uma mensagem de cartão, ela será anexada à mensagem do cartão (que continua sendo exibida).

Saiba como atualizar uma mensagem de texto para uma mensagem de texto ou adicionar uma mensagem de cartão ao início com autenticação de app:

Python

No 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 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 obtido no corpo da resposta retornado depois de criar uma mensagem de maneira assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.
No diretório de trabalho, crie e execute a amostra:
```
python3 chat_update_text_message_app.py
```

Atualizar ou anexar uma mensagem de card a uma mensagem de texto

Para atualizar uma 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 requer autenticação de 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 a ela (que continuará sendo exibida). Se a mensagem atualizada for um cartão, então o cartão exibido será atualizado.

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

Python

No 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 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 obtido no corpo da resposta retornado depois de criar uma mensagem de maneira assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.
No diretório de trabalho, crie e execute a amostra:
```
python3 chat_update_card_message.py
```

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