Visão geral da API Google Chat

Esta seção explica como um app do Google Chat pode chamar a API Chat, que permite que os apps do Chat façam coisas como criar um espaço, adicionar pessoas a ele e postar uma mensagem sem receber uma solicitação de um evento de interação com o app do Chat.

Autenticação

Chamar a API Chat de forma assíncrona exige autenticação. Cada método da API Chat exige autenticação do usuário (para realizar ações ou acessar dados em nome de um usuário) ou autenticação do app (para realizar ações ou acessar dados como um app do Chat). Alguns métodos oferecem suporte à autenticação do usuário e do app.

Para saber mais sobre a autenticação no Chat, consulte 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, mensagens, reações e anexos de mensagens.

Espaços

Os espaços são lugares onde pessoas e apps podem conversar e compartilhar arquivos. Há 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. Os chats em grupo são conversas entre três ou mais usuários e os apps do Chat. Os espaços nomeados são lugares persistentes onde as pessoas enviam mensagens, compartilham arquivos e colaboram.

O recurso spaces representa 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 e adicionar pessoas e apps do Chat.
• Adquirir um espaço para ver os detalhes de um espaço.
• 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 visível ao usuário, a descrição e as diretrizes.
• 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 do Chat que fez a chamada.

Membros

Os participantes são usuários e apps do Chat que participaram ou foram convidados para um espaço.

O recurso spaces.members representa um membro.

Os membros aceitam os seguintes métodos:

• Crie uma assinatura para adicionar um usuário ou app a um espaço.
• Assine para conferir os detalhes de uma assinatura.
• Listar associações para ver uma lista paginada e filtrável de associações em um espaço.
• Atualize uma associação para mudar os atributos relacionados, como mudar um participante para administrador ou mudar de administrador para participante.
• Excluir 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. As pessoas podem reagir às mensagens adicionando emojis a elas.

O recurso spaces.messages representa uma mensagem.

As mensagens oferecem suporte aos seguintes métodos:

• Crie uma mensagem para postar uma mensagem de texto ou card. Você também pode iniciar ou responder a uma conversa.
• Receber uma mensagem para ver detalhes sobre uma mensagem, como a data de envio ou o que ela diz.
• Listar mensagens para ver uma lista paginada e filtrável de mensagens em um espaço.
• Atualizar uma mensagem para alterar os atributos da mensagem, como o que ela diz. Também é possível anexar texto a uma mensagem de card ou um card 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, como 👍, 🚲 e 📣.

O recurso spaces.messages.reactions representa uma reação.

As reações são compatíveis com os seguintes métodos:

• Crie uma reação para incluir um emoji em uma mensagem.
• Liste reações para conferir 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

Media representa um arquivo enviado para o Google Chat, como imagens, vídeos e documentos.

O recurso media representa a mídia anexada às mensagens.

Anexos são instâncias de mídia (arquivos) anexadas às mensagens.

O recurso spaces.messages.attachments representa um anexo. Um anexo inclui a mídia e os metadados associados anexados a uma mensagem.

Mídia e anexos são compatíveis com os seguintes métodos:

• Faça upload de mídia como um anexo para fazer upload de mídia no Google Chat e anexe-a a uma mensagem.
• Faça o download de mídia como um anexo para salvar a mídia do Google Chat como um arquivo binário.
• Receba um anexo para recuperar metadados sobre um anexo de mensagem.

Eventos do espaço

Os eventos do espaço representam mudanças em um espaço ou nos recursos filhos dele, incluindo participantes, mensagens e reações.

O recurso spaces.spaceEvent representa um evento do espaço.

Os eventos espaciais são compatíveis com os seguintes métodos:

• Gere um evento do espaço para retornar detalhes sobre um evento que ocorreu em um espaço.
• Listar eventos do espaço para acessar uma lista dos eventos que ocorreram nele.

Estados de leitura do usuário

Os estados de leitura do usuário são recursos singleton que representam detalhes sobre a última mensagem lida de um usuário especificado em um espaço do Google Chat ou em uma linha de execução de mensagens.

O recurso users.spaces representa o estado de leitura de um usuário em um espaço.

O recurso users.spaces.threads representa o estado de leitura de um usuário em uma linha de execução de mensagens.

Os estados de leitura do usuário oferecem suporte aos seguintes métodos:

• Receber o estado de leitura do espaço para retornar detalhes sobre o estado de leitura de um usuário em um espaço.
• Atualize o estado de leitura do espaço para atualizar o estado de leitura de um usuário em um espaço.
• Receber o estado de leitura da linha de execução para retornar detalhes sobre o estado de leitura de um usuário em uma linha de execução.

Temas relacionados

• Documentação de referência da API Google Chat