Desenvolver com o Google Chat

Nesta página, você encontra uma visão geral da API Google Chat e dos apps do Google Chat.

Visão geral da API Google Chat

A API Chat consiste em serviços gRPC ou recursos e métodos REST que concedem acesso ao Chat, incluindo espaços, participantes do espaço, mensagens, reações a mensagens, anexos de mensagens, eventos do espaço e estados de leitura do usuário.

Conceitos

A seção a seguir define os serviços, recursos e métodos da API Chat:

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 (DMs) 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 apps do Chat. Os espaços nomeados são lugares permanentes onde as pessoas enviam mensagens, compartilham arquivos e colaboram.

Referência de recurso:

Para exemplos de uso, consulte:

Membros

Participantes são usuários e apps do Chat que entraram ou foram convidados para um espaço.

Referência de recurso:

Para exemplos de uso, consulte:

Mensagens

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

Referência de recurso:

Para exemplos de uso, consulte:

Reações

As reações representam os emojis que as pessoas usam para reagir a uma mensagem, como 👍, 🚲 e 🌞.

Referência de recurso:

Para exemplos de uso, consulte:

Emojis personalizados

Emojis personalizados representam emojis criados e compartilhados na organização no Google Chat. Os emojis personalizados podem ser incluídos no conteúdo de uma mensagem ou usados para reagir a ela.

Referência de recurso:

Mídia e anexos

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

Referência de recurso de mídia (indisponível em RPC):

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

Referência de recurso:

Para exemplos de uso, consulte:

Eventos do Space

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

Referência de recurso:

Para exemplos de uso, consulte:

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 conversa por mensagem.

Referência de recurso de estado de leitura do espaço:

Referência do recurso de estado de leitura da linha de execução:

Para exemplos de uso, consulte:

Configurações de notificação do espaço do usuário

As configurações de notificação do espaço do usuário são recursos singleton que representam as configurações de notificação de um usuário específico em um espaço do Google Chat.

Referência de recurso:

Autenticação

Chamar a API Chat 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 são compatíveis com a autenticação de usuários e de apps.

Para saber mais sobre a autenticação no Chat, consulte Visão geral da autenticação.

Bibliotecas de cliente

A maneira recomendada para a maioria dos desenvolvedores chamar a API Google Chat é com as bibliotecas de cliente do Cloud com suporte oficial para sua linguagem preferida, como Python, Java ou Node.js.

Se você estiver programando com o Google Apps Script, use o serviço avançado do Chat em vez de instalar uma biblioteca de cliente.

Criar apps do Chat

Com a API Chat, é possível criar apps do Google Chat que levam seus serviços e recursos diretamente para o Google Chat. Você pode criar apps de chat para fazer o seguinte:

  • Recuperar informações com base em consultas de texto estruturado ou livre inseridas pelo usuário.
  • Gerar relatórios de incidentes ou outros artefatos usando informações fornecidas pelo usuário.
  • Melhorar a colaboração da equipe, como fornecer "memória da equipe" ou agendar recursos.

Você pode projetar seu app de chat usando vários estilos de arquitetura diferentes, incluindo:

  • Apps interativos: respondem à interação do usuário, como @menções ou comandos de barra, e apresentam informações ou orientam os usuários em um fluxo de trabalho com cards e diálogos.
  • Apps de linha de comando ou webhooks: envie mensagens proativas, como alarmes ou notificações, de outro sistema para um espaço. Os usuários não podem interagir diretamente com esse tipo de app.
  • Apps orientados a eventos: inscreva-se e reaja à atividade em um espaço do Chat, como a entrada de um novo participante. Em resposta a um evento, o app pode enviar uma mensagem ou realizar outra ação.

Para mais detalhes sobre como criar seu app do Chat, consulte Escolher uma arquitetura de app do Google Chat.

Quer ver a API Google Chat em ação?
O canal Google Workspace Developers oferece vídeos com dicas, truques e os recursos mais recentes.