Este guia explica como usar o método
list()
no recurso Message
da API Google Chat para ver uma lista paginada e
filtrável de mensagens em um espaço.
Na API Chat, uma mensagem é representada pelo
recurso Message
.
Enquanto os usuários do Chat só podem enviar mensagens de texto,
os apps do Chat podem usar muitos outros recursos de mensagens, incluindo
a exibição de interfaces de usuário estáticas ou interativas, a coleta de informações dos
usuários e o envio de mensagens particulares. Para saber mais sobre os recursos de mensagens
disponíveis para a API Chat, consulte a
Visão geral das mensagens do Google Chat.
Pré-requisitos
Node.js
- Uma conta empresarial ou corporativa do Google Workspace com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud para Node.js.
-
Crie credenciais do ID do cliente do OAuth para um aplicativo de computador. Para executar o exemplo neste
guia, salve as credenciais como um arquivo JSON chamado
client_secrets.json
no seu diretório local.
- Escolha um escopo de autorização que ofereça suporte à autenticação do usuário.
- Um espaço do Google Chat. Para criar um usando a API Google Chat, consulte Criar um espaço. Para criar uma no Chat, acesse a documentação da Central de Ajuda.
Python
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, um ícone e uma descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud para Python.
-
Crie credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar a amostra deste guia, salve as credenciais como um arquivo JSON chamado
client_secrets.json
no seu diretório local.
- Escolha um escopo de autorização compatível com a autenticação do usuário.
- Um espaço do Google Chat. Para criar um usando a API Google Chat, consulte Criar um espaço. Para criar uma no Chat, acesse a documentação da Central de Ajuda.
Java
- Uma conta do Google Workspace para empresas ou empresas com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Instale a biblioteca de cliente do Cloud para Java.
-
Crie credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar o exemplo neste
guia, salve as credenciais como um arquivo JSON chamado
client_secrets.json
no seu diretório local.
- Escolha um escopo de autorização compatível com a autenticação do usuário.
- Um espaço do Google Chat. Para criar um usando a API Google Chat, consulte Criar um espaço. Para criar um no Chat, acesse a documentação da Central de Ajuda.
Apps Script
- Uma conta empresarial ou corporativa do Google Workspace com acesso ao Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de consentimento OAuth.
- Ative e configure a API Google Chat com um nome, ícone e descrição para seu app do Chat.
- Crie um projeto independente do Apps Script e ative o Serviço avançado de chat.
- Escolha um escopo de autorização compatível com a autenticação do usuário.
- Um espaço do Google Chat. Para criar um usando a API Google Chat, consulte Criar um espaço. Para criar uma no Chat, acesse a documentação da Central de Ajuda.
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
ListMessages()
.
Este exemplo lista as mensagens em um espaço do Chat:
Node.js
Python
Java
Apps Script
Para executar este exemplo, substitua SPACE_NAME
pelo ID do campo
name
do espaço. Você pode conseguir o ID chamando o método
ListSpaces()
ou pelo URL do espaço.
A API Chat retorna uma
lista de mensagens
enviadas no espaço especificado. Se não houver mensagens da solicitação, a resposta da API Chat retornará um objeto vazio. Ao usar uma interface REST/HTTP, a resposta contém um objeto JSON vazio, {}
.
Temas relacionados
- Formatar uma mensagem.
- Excluir uma mensagem.
- Conferir detalhes sobre uma mensagem.
- Atualizar uma mensagem.
- Enviar uma mensagem.