Receber detalhes sobre uma mensagem

Neste guia, explicamos como usar o método get no recurso Message da API Google Chat para retornar detalhes sobre uma mensagem de texto ou card.

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
  • 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. O recebimento de uma mensagem aceita os dois métodos de autenticação:

    • A autenticação do usuário, com o escopo de autorização chat.messages.readonly ou chat.messages, pode receber mensagens a que o usuário tem acesso.
    • A autenticação de apps, com o escopo de autorização chat.bot, pode receber mensagens enviadas ao app.

Receber uma mensagem com a autenticação do usuário

Para receber detalhes sobre uma mensagem com a autenticação do usuário, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.messages.readonly ou chat.messages.
  • Chame o método get no recurso Message.
  • Defina name como o nome do recurso da mensagem a ser recebida.

O exemplo a seguir recebe uma mensagem com a autenticação do usuário:

Python

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

  2. Inclua o seguinte código em chat_message_get_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.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets 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)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().messages().get(

        # The message to get.
        #
        # 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'

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

  4. No diretório de trabalho, crie e execute a amostra:

    python3 chat_message_get_user.py

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

Receber uma mensagem com a autenticação de app

Para conferir detalhes sobre 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 get no recurso Message.
  • Defina name como o nome do recurso da mensagem a ser recebida.

O exemplo a seguir recebe uma mensagem com autenticação de app:

Python

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

  2. Inclua o seguinte código em chat_get_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)

# Get a Chat message.
result = chat.spaces().messages().get(

    # The message to get.
    #
    # 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'

  ).execute()

# Print Chat API's response in your command line interface.
print(result)

  3. No código, substitua o seguinte:

    • SPACE: o name do espaço em que a mensagem é postada, que pode ser acessado no método spaces.list na API Chat ou no URL de um espaço.

    • MESSAGE: o nome da mensagem, que pode ser obtido 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 a amostra:

    python3 chat_get_message_app.py

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