Visão geral da API Google Chat

Esta seção explica como um app do Google Chat pode chamar a API Chat, que permite aos apps do Chat fazer coisas como criar um espaço, adicionar pessoas e postar uma mensagem sem que alguém peça Evento de interação com o app do Chat.

Autenticação

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

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 ao 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. Grupo bate-papos são conversas entre três ou mais usuários e Apps de chat Os espaços nomeados são lugares que as pessoas costumam enviar e-mails trocar mensagens, compartilhar arquivos e colaborar.

A Recurso spaces representa um espaço.

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

• Criar um espaço, um lugar onde pessoas e apps podem conversar e compartilhar arquivos.
• Configurar um espaço para criar o espaço e adicionar pessoas e apps do Chat a ele espaço.
• Acessar os detalhes de um espaço para conferir detalhes sobre um espaço.
• Listar espaços para conferir uma lista de espaços paginada e filtrável.
• Atualizar um espaço para mudar os atributos de um espaço, como o nome de exibição visível ao usuário, descrição e diretrizes.
• Excluir um espaço quando não forem mais necessários.
• Encontrar uma mensagem direta (DM) retornar uma mensagem direta entre dois usuários ou uma mensagem direta entre um usuário e a pessoa que está ligando Apps de chat

Membros

Os participantes são usuários e apps do Chat que participaram ou estão participando. foi convidado para um espaço.

A Recurso spaces.members representa um membro.

Os membros aceitam os seguintes métodos:

• Criar uma assinatura para adicionar um usuário ou app a um espaço.
• Assinar para conferir os detalhes de uma assinatura.
• Assinaturas de listas para conferir uma lista paginada e filtrável de associações a um espaço.
• Atualizar uma assinatura para mudar atributos, como mudar um participante do espaço a mudança de um administrador para participante do espaço;
• Excluir uma assinatura para remover um usuário ou app de um espaço.

Mensagens

As mensagens incluem texto e card de comunicação postadas nos espaços. As mensagens podem ter arquivos anexados. As pessoas podem reagir às mensagens adicionando emojis a elas.

A Recurso spaces.messages representa uma mensagem.

As mensagens oferecem suporte aos seguintes métodos:

• Criar uma mensagem para postar uma mensagem de texto ou cartão. Você também pode iniciar ou responder a uma conversa;
• Receber uma mensagem para receber detalhes sobre uma mensagem, como quando ela foi enviada ou o que ela diz.
• Listar mensagens para conferir uma lista paginada e filtrável de mensagens em um espaço.
• Atualizar uma mensagem para alterar atributos da mensagem, como o que ela diz. Também é possível anexar texto para um mensagem do cartão, ou um cartão para um mensagem de texto.
• Excluir uma mensagem quando não forem mais necessários.

Reações

As reações representam o emoji que as pessoas usam para reagir a uma mensagem, como 👍, 🚲 e 🎆

A Recurso spaces.messages.reactions representa uma reação.

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

• Criar uma reação para adicionar um emoji a uma mensagem.
• Listar 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

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

A Recurso media representa mídias anexadas às mensagens.

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

A Recurso spaces.messages.attachments representa um anexo. Um anexo inclui a mídia e a metadados anexados a uma mensagem.

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

• Fazer upload de mídia como anexo para fazer upload de mídia no Google Chat e anexar à mensagem.
• Fazer o download de mídia como um anexo para fazer o download de mídia do Google Chat como um arquivo binário.
• Receber 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 na recursos filhos, incluindo participantes, mensagens e reações.

O recurso spaces.spaceEvent representa um evento espacial.

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

• Participar de um evento espacial 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

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

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 sequência 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.
• Ver 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