Os guias desta seção explicam como um app do Google Chat pode chamar a API Chat. Com ela, os apps do Chat podem criar um espaço, adicionar pessoas e postar uma mensagem sem que um evento de interação com o app do Chat solicite.
Autenticação
Chamar a API do Chat de forma assíncrona exige autenticação. Cada método da API Chat requer a autenticação do usuário (para executar ações ou acessar dados em nome de um usuário) ou autenticação de aplicativo (para realizar ações ou acessar dados como um app do Chat). Alguns métodos são compatíveis com a autenticação do usuário e do app.
Para saber mais sobre a autenticação no Chat, consulte a Visão geral da autenticação.
Recursos e métodos da API
Os recursos e métodos REST concedem acesso assíncrono a espaços do Chat, participantes de espaços, mensagens, reações e anexos de mensagens.
- Espaços
Os espaços são lugares onde pessoas e apps podem conversar e compartilhar arquivos. Existem vários tipos de espaços. As mensagens diretas são conversas individuais entre dois usuários ou um usuário e um app do Chat. Chats em grupo são conversas entre três ou mais usuários e apps do Chat. Os espaços nomeados são lugares persistentes onde as pessoas enviam mensagens, compartilham arquivos e colaboram.
O recurso
Spacerepresenta um espaço.Os espaços são compatíveis com os seguintes métodos:
- Crie um espaço, um lugar onde pessoas e apps podem conversar e compartilhar arquivos.
- Configure um espaço para criar o espaço e adicionar pessoas e apps do Chat a ele.
- Acessar um espaço para ver detalhes sobre ele.
- Listar espaços para ver uma lista paginada e filtrável de espaços
- Atualize um espaço para mudar os atributos dele, como o nome de exibição, a descrição e as diretrizes visíveis ao usuário.
- Exclua um espaço quando ele não for mais necessário.
- Encontre uma mensagem direta para retornar uma mensagem direta entre dois usuários ou entre um usuário e os apps de chamada do Chat.
- Membros
Participantes são usuários e apps de chat que entraram em um espaço ou foram convidados.
O recurso
Memberrepresenta um membro.Os membros oferecem suporte aos seguintes métodos:
- Crie uma assinatura para adicionar um usuário ou app a um espaço.
- Assinar para ver detalhes sobre uma assinatura.
- Listar associações para ver uma lista paginada e filtrável de associações em um espaço.
- Exclua uma assinatura para remover um usuário ou app de um espaço.
- Mensagens
As mensagens incluem comunicações de texto e cartão postadas nos espaços. As mensagens podem ter arquivos anexados a elas. As pessoas podem adicionar emojis a mensagens para reagir a elas.
O recurso
Messagerepresenta uma mensagem.As mensagens aceitam os seguintes métodos:
- Crie uma mensagem para postar uma mensagem de texto ou cartão. Você também pode iniciar ou responder a um agrupamento de mensagens.
- Receba uma mensagem para ver detalhes, como quando ela foi enviada ou o que está escrito.
- Listar mensagens para ver uma lista paginada e filtrável de mensagens em um espaço.
- Atualize uma mensagem para alterar os atributos dela, como o que ela diz. Também é possível anexar texto a uma mensagem do cartão ou um cartão a uma mensagem de texto.
- Exclua uma mensagem quando ela não for mais necessária.
- Reações
As reações representam os emojis que as pessoas usam para reagir a uma mensagem, por exemplo, 👍, 🚲 e easing.
O recurso
Reactionrepresenta uma reação.As reações são compatíveis com os seguintes métodos:
- Crie uma reação para adicionar um emoji a uma mensagem.
- Listar reações para ver uma lista paginada e filtrável de reações a uma mensagem.
- Excluir uma reação para remover um emoji da mensagem.
- Mídia e anexos
Mídia representa um arquivo enviado para o Google Chat, como imagens, vídeos e documentos.
O recurso
Mediarepresenta a mídia anexada às mensagens.Anexos são instâncias de mídia (arquivos) anexadas a mensagens.
O recurso
Attachmentrepresenta um anexo. Um anexo inclui a mídia e os metadados associados a uma mensagem.A mídia e os anexos são compatíveis com os seguintes métodos:
- Faça upload de mídia como anexo para enviar uma mídia ao Google Chat e anexar a uma mensagem.
- Faça o download de mídia como anexo para fazer o download de mídia do Google Chat como um arquivo binário.
- Acesse um anexo para recuperar metadados sobre um anexo de mensagem.
Localizar o documento de descoberta
O documento de descoberta dessa API está localizado no seguinte URL: