Configurar um app do Google Chat

Esta página explica como configurar e implantar um app do Google Chat como um complemento do Google Workspace.

Para implantar e testar um complemento do Google Workspace que estende o Chat, ative e configure um app do Chat usando a API Google Chat. Nas configurações da API Chat, você especifica todos os detalhes sobre o app Chat, incluindo o nome, o avatar, a implantação e os recursos interativos que você quer usar.

Pré-requisitos

HTTP

Apps Script

Escolha um nome de exibição, um avatar e uma descrição para o app de chat

O nome, o avatar e a descrição do app Chat são mostrados aos usuários na interface do Chat. Para interagir com apps de chat, os usuários podem conferir ou usar essas informações das seguintes maneiras:

  • @mencionar o app do Chat para adicionar a um espaço ou enviar uma mensagem.
  • Encontre e inicie uma mensagem direta com o app Chat. No menu Apps, as mensagens diretas mostram o nome e o avatar do app Chat.
  • Na barra de criação, os usuários podem navegar pelos apps de chat e conferir o nome, o avatar e a descrição deles.

Antes de configurar um app de chat, prepare as seguintes informações:

Campo Descrição Formato
Nome do app O nome de exibição do app Chat. Até 25 caracteres alfanuméricos
URL do avatar A imagem que aparece como o avatar do seu app de chat. Um URL HTTPS que aponta para uma imagem gráfica quadrada (PNG ou JPEG). O tamanho recomendado é de 256 x 256 pixels ou mais.
Descrição Uma breve descrição da finalidade do app Chat. Até 40 caracteres alfanuméricos

Na seção a seguir, você especifica essas informações nas configurações da API Chat.

Configurar o app de chat no console do Google Cloud

Quando você tiver os detalhes do app Chat, abra seu projeto do Cloud e configure a API Chat:

  1. No console do Google Cloud, acesse a página da API Chat e clique em Configuração:

    Acesse a página de configuração da API Chat

  2. Em Informações do aplicativo, preencha os campos Nome do app, URL do avatar e Descrição.

  3. Em Recursos interativos, clique em Ativar recursos interativos para ativar a opção e faça o seguinte:

    1. Em Funcionalidade, marque uma ou mais caixas de seleção para disponibilizar o app do Chat para instalação e uso:

      • Receber mensagens individuais: os usuários podem instalar e enviar mensagens com o app Chat em um espaço dedicado entre o usuário e o app Chat.

      • Participar de espaços e conversas em grupo: os usuários podem adicionar e interagir com o app Chat em espaços com várias pessoas.

    2. Em Configurações de conexão, selecione a arquitetura que você quer usar para receber objetos de evento do Chat:

      • Para usar um serviço HTTP, selecione URL do endpoint HTTP e informe um URL.
      • Para usar um projeto do Google Apps Script, selecione Apps Script e informe um ID de implantação.

    3. Opcional: para receber objetos de evento em mais de um endpoint ou função, acesse Configurações avançadas > Acionadores e forneça ou atualize as funções de callback para os seguintes acionadores de chat:

      • ADDED_TO_SPACE: um usuário adiciona o app Chat a uma conversa em grupo ou espaço ou instala o app Chat para mensagens individuais.
      • MESSAGE: um usuário envia uma mensagem para o app Chat. Por exemplo, envia uma mensagem direta para o app Chat ou @menciona o app Chat em um espaço com várias pessoas.
      • REMOVED_FROM_SPACE: um usuário desinstala ou remove o app Chat de um espaço.

    4. Opcional: adicione outros recursos interativos, como comandos de barra ou visualizações de links.

    5. Em Visibilidade, especifique seu e-mail para instalar e testar o app do Chat antes de publicar no Google Workspace Marketplace. É possível especificar até cinco pessoas ou um ou mais Grupos do Google da sua organização do Google Workspace.

  4. Opcional: em Logs, marque a caixa de seleção Registrar erros no Logging para usar o Google Cloud Logging. Para mais informações, consulte Consultar registros de erros de apps do Chat na documentação da API Chat.

  5. Clique em Salvar.

Depois de salvar a configuração, qualquer pessoa especificada na configuração de Visibilidade da API Chat poderá instalar, testar ou usar o app Chat. Para começar a testar e depurar seu app Chat, consulte Testar recursos interativos para apps do Google Chat na documentação da API Chat.

Considerações sobre os complementos do Google Workspace

Os apps de chat exigem uma configuração diferente dos complementos do Google Workspace que estendem outros aplicativos do Google Workspace. Se o complemento estender outros aplicativos do Google Workspace, considere os seguintes requisitos para configurar o app Chat:

  • Tanto indivíduos quanto administradores do Google Workspace precisam conseguir instalar seu complemento no Marketplace. Configure essas configurações de instalação no SDK do Google Workspace Marketplace.
  • Os apps de chat não usam o nome e o logotipo configurados para outros aplicativos do Google Workspace no objeto addons.common do manifest.
  • Para complementos publicados no Google Workspace Marketplace, não é possível salvar um rascunho de mudanças nas configurações da API Google Chat. Depois de atualizar e salvar as configurações da API Chat, o app atualizado vai ficar disponível para todos os usuários. Para atualizar a página de detalhes do produto no Marketplace, crie um rascunho antes de enviar as alterações.

  • Se você criou o complemento usando o Apps Script:

  • Se você criou o complemento usando um serviço HTTP, omita todos os detalhes de configuração do app Chat no manifesto e nas implantações que você criou usando a API Google Workspace Add-ons. As implantações HTTP especificadas no SDK do Google Workspace Marketplace são usadas apenas para outros aplicativos do Google Workspace.