Desenvolver com o Google Chat

Esta página oferece 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 de 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

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:

Confira alguns exemplos de uso:

Membros

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

Referência de recurso:

Confira alguns exemplos de uso:

Mensagens

Mensagens incluem comunicações de texto e cards postados em espaços. As mensagens podem ter arquivos anexados. As pessoas podem reagir às mensagens anexando emojis.

Referência de recurso:

Confira alguns exemplos de uso:

Reações

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

Referência de recurso:

Confira alguns exemplos de uso:

Emojis personalizados

Emojis personalizados representam emojis personalizados 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 uma mensagem.

Referência de recurso:

Confira alguns exemplos de uso:

Seções

Seções são maneiras de os usuários agruparem as conversas e personalizarem a lista de espaços exibida no painel de navegação do Google Chat. Há seções do sistema predefinidas e seções personalizadas definidas pelo usuário.

Referência de recurso:

Confira alguns exemplos de uso:

Mídia e anexos

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

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

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

Referência de recurso:

Confira alguns exemplos de uso:

Eventos de espaço

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

Referência de recurso:

Confira alguns exemplos de uso:

Estados de leitura do usuário

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

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

Referência de recurso de estado de leitura da conversa:

Confira alguns exemplos de uso:

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

Configurações de notificação do espaço do usuário são recursos únicos que representam as configurações de notificação de um usuário especificado em um espaço do Chat.

Referência de recurso:

Autenticação

É necessário autenticar a chamada da API Chat. 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.

Bibliotecas de cliente

A maneira recomendada para a maioria dos desenvolvedores chamar a API Google Chat é com nossas bibliotecas de cliente do Cloud com suporte oficial Cloud Client Libraries para a linguagem de programação preferida, como Python, Java ou Node.js.

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

Criar apps do Chat

A API Chat permite criar apps do Google Chat que levam seus serviços e recursos diretamente para o Google Chat. É possível criar apps do 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 as informações fornecidas pelo usuário.
  • Melhorar a colaboração da equipe, como fornecer "memória da equipe" ou programar recursos.

É possível projetar o app do 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 caixas de diálogo.
  • Aplicativos de linha de comando ou webhooks: enviam 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: assinam e reagem à atividade em um espaço do Chat, como a participação de um novo membro. Em resposta a um evento, o app pode enviar uma mensagem ou realizar outra ação.

Para mais detalhes sobre como projetar o 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 sobre dicas, truques e os recursos mais recentes.