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 do Chat é representada pelo recurso Message
.
Os usuários do Chat só podem enviar mensagens de texto, mas os apps do Chat podem usar muitos outros recursos de mensagens, incluindo mostrar interfaces de usuário estáticas ou interativas, coletar informações dos usuários e enviar 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 do Google Workspace Business ou Enterprise com acesso ao Google Chat.
- Configure seu ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão 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 do Node.js.
-
Crie credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar a amostra neste
guia, salve as credenciais como um arquivo JSON chamado
credentials.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 um no Chat, acesse a documentação da Central de Ajuda.
Python
- Uma conta do Google Workspace Business ou Enterprise com acesso ao Google Chat.
- Configure seu ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão 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 Python.
-
Crie credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar a amostra neste
guia, salve as credenciais como um arquivo JSON chamado
credentials.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 um no Chat, acesse a documentação da Central de Ajuda.
Java
- Uma conta do Google Workspace Business ou Enterprise com acesso ao Google Chat.
- Configure seu ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão 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 Java.
-
Crie credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar a amostra neste
guia, salve as credenciais como um arquivo JSON chamado
credentials.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 um no Chat, acesse a documentação da Central de Ajuda.
Apps Script
- Uma conta do Google Workspace Business ou Enterprise com acesso ao Google Chat.
- Configure seu ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome, um ícone e uma 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 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 um 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()
.
O exemplo a seguir lista 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 no URL do espaço.
A API Chat retorna uma
lista de mensagens
enviadas no espaço especificado. Se não houver mensagens na solicitação, a resposta da API
Chat vai 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.
- Receber detalhes sobre uma mensagem.
- Atualizar uma mensagem.
- Enviar uma mensagem.