Listar mensagens

Neste guia, explicamos como usar o método list no recurso Message da API Google Chat para conferir uma lista paginada e filtrável de mensagens em um espaço.

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. A listagem de mensagens exige a autenticação do usuário com o escopo de autorização chat.messages.readonly ou chat.messages.

Listar mensagens

Para listar mensagens com autenticação do usuário, transmita o seguinte em sua solicitação:

O exemplo a seguir lista as mensagens em um espaço do Chat enviadas após 16 de março de 2023:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_messages_list.py.
  2. Inclua o seguinte código em chat_messages_list.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 lists messages in a space sent after March 16, 2023.
        '''
    
        # 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().list(
    
              # The space for which to list messages.
              parent = 'spaces/SPACE',
    
              # An optional filter that returns messages
              # created after March 16, 2023.
              filter = 'createTime > "2023-03-16T00:00:00-00:00"'
    
          ).execute()
    
        # Prints details about the created membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. No código, substitua SPACE por um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.

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

    python3 chat_messages_list.py
    

A API Google Chat retorna uma lista de mensagens enviadas no espaço especificado após 16 de março de 2023.