Visão geral da API Google Chat

Nesta seção, explicamos como um app do Google Chat pode chamar a API Chat, o que permite que os apps do Chat realizem tarefas como criar um espaço, adicionar pessoas a ele e postar uma mensagem sem que um evento de interação com o app do Chat solicite.

Proporção de Eficiência Energética (EER)

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 realizar ações ou acessar dados em nome de um usuário) ou autenticação de app (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 de API

Os recursos e métodos REST concedem acesso assíncrono a espaços do Chat, participantes do espaço, mensagens, reações e anexos de mensagens.

Espaços

Os espaços são lugares onde as pessoas e os apps podem conversar e compartilhar arquivos. Há vários tipos de espaços. As mensagens diretas (DMs, na sigla em inglês) 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 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.
• Configurar um espaço para criá-lo e adicionar pessoas e apps do Chat a ele.
• Acesse um espaço para conferir os detalhes dele.
• Listar espaços para ver uma lista paginada e filtrável de espaços.
• Atualizar 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 uma mensagem direta entre um usuário e os apps de chamada do Chat.

Membros

Participantes são usuários e apps do Chat que entraram 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.
• Receber uma assinatura para ver detalhes sobre uma assinatura.
• Listar associações para ver uma lista paginada e filtrável de associações em um espaço.
• Atualizar uma associação para mudar os atributos de uma associação. Por exemplo, mudar um participante para administrador do espaço 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 card postadas nos espaços. As mensagens podem ter arquivos anexados. As pessoas podem anexar emojis a elas para reagir.

O recurso spaces.messages representa 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 sobre uma mensagem, como quando ela foi enviada 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 mudar os atributos dela, como o conteúdo dela. Também é possível anexar texto a uma mensagem de cartão 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 recentemente.

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 anexar 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

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

O recurso media representa mídia anexada a mensagens.

Os 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 a uma mensagem.

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

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

Eventos do espaço

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

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

Os eventos de espaço são compatíveis com os seguintes métodos:

• Encontrar 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 em um espaço.

Estados de leitura do usuário (prévia para desenvolvedores)

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

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 conversa de mensagens.

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

• Acessar o estado de leitura do espaço para retornar detalhes sobre o estado de leitura de um usuário em um espaço.
• Atualizar 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