Este guia explica como usar o método list
no recurso Message
da
a API Google Chat para conferir uma lista paginada e filtrável de mensagens em um espaço.
O
Recurso Message
representa um
texto
ou
cartão
no Google Chat. Você pode
create
, get
, update
ou delete
uma mensagem na API Google Chat chamando
métodos correspondentes. Para saber mais sobre mensagens de texto e de card, consulte
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.
-
Criar credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar o exemplo
salve as credenciais como um arquivo JSON (
client_secrets.json
) no no diretório local.
- Escolha um escopo de autorização que ofereça suporte à autenticação de usuários.
Listar mensagens
Para listar mensagens com autenticação do usuário transmita o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.messages.readonly
ouchat.messages
. - Chame o método
Método
list
no(a) RecursoMessage
.
O exemplo a seguir lista as mensagens em um espaço do Chat enviadas depois de 16 de março de 2023:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_messages_list.py
. 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 the list of messages. print(result) if __name__ == '__main__': main()
No código, substitua
SPACE
por um nome de espaço, que que você pode conseguir na Métodospaces.list
na API Chat ou pelo URL de um espaço.No diretório de trabalho, crie e execute o exemplo:
python3 chat_messages_list.py
A API Chat retorna uma lista de mensagens enviadas no espaço especificado
após 16 de março de 2023. Se não houver mensagens na solicitação, o
A resposta da API Chat retorna um objeto vazio. Ao usar um
REST/HTTP, a resposta contém um objeto JSON vazio, {}
.
Temas relacionados
- Formatar uma mensagem.
- Excluir uma mensagem.
- Ver detalhes de uma mensagem.
- Atualizar uma mensagem.
- Enviar uma mensagem.