Configurar um app do Google Chat

Nesta página, explicamos 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, é necessário ativar e configurar um app do Chat usando a API Google Chat. As configurações de configuração da API Chat são onde você especifica todos os detalhes sobre o app do Chat, incluindo o nome, o avatar, a implantação e os recursos interativos que você quer usar.

Pré-requisitos

• Uma conta do Google Workspace Business ou Enterprise com acesso ao Google Chat.

• Um projeto do Google Cloud. Para criar um, consulte Criar um projeto do Google Cloud.

• Configure a tela de permissão OAuth.
• Ative a API Google Chat.

Escolher um nome de exibição, avatar e descrição para o app do Chat

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

• Mencione o app do Chat para adicioná-lo a um espaço ou enviar uma mensagem.
• Encontre e inicie uma mensagem direta com o app do Chat. No menu Apps, as mensagens diretas mostram o nome e o avatar do app do Chat.
• Na barra de escrita, os usuários podem navegar pelos apps do Chat e ver o nome, o avatar e a descrição deles.

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

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

Na seção a seguir, especifique essas informações nas configurações de configuração da API Chat.

Configurar o app do Chat no console do Google Cloud

No console do Google Cloud, você configura os detalhes sobre o app do Chat que aparecem para os usuários no Chat, incluindo um nome de exibição, avatar e descrição. Esses detalhes só aparecem no Chat. Para publicar o app do Chat no Marketplace, você também precisa especificar os detalhes que aparecem na listagem do Marketplace do app do Chat.

Quando tiver os detalhes do app do Chat, abra o projeto na nuvem e configure a API Chat:

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

   Acessar 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 a posição ativada e conclua o seguinte:

   1. Em Funcionalidade, selecione Participar de espaços e conversas em grupo para disponibilizar o app do Chat para instalação e uso.

      Por padrão, os usuários podem instalar e enviar mensagens com o app do Chat em um espaço dedicado entre o usuário e o app do Chat. Os usuários também podem adicionar e interagir com o app do 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 forneça um URL.
      • Para usar um projeto do Google Apps Script, selecione Apps Script e forneça um ID de implantação para o projeto.
      • Para usar um agente do Dialogflow, selecione Dialogflow, selecione Dialogflow CX ou Dialogflow ES e forneça o nome do recurso do agente.
      • Para usar o Pub/Sub, selecione Cloud Pub/Sub e insira o nome do tópico.
      Aviso: se um ID de implantação do Apps Script já estiver preenchido, o projeto na nuvem estará conectado a um complemento do Google Workspace. Se você atualizar o ID de implantação na API Chat, o ID de implantação será atualizado para o complemento e poderá afetar sua listagem no Google Workspace Marketplace. Para revisar a configuração do seu complemento, consulte Configurar seu app no SDK do Google Workspace Marketplace na documentação do Google Workspace Marketplace.

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

      **Observação**: para o Apps Script, se você não atualizar os acionadores, será necessário usar as funções de callback correspondentes que são preenchidas nesta seção (como onMessage, onAddedToSpace, e onRemovedFromSpace).
      • Adicionado ao espaço: um usuário adiciona o app do Chat a uma conversa em grupo ou espaço ou instala o app do Chat para mensagens 1:1.
      • Mensagem: um usuário envia uma mensagem para o app do Chat. Por exemplo, envia uma mensagem direta para o app do Chat ou @menciona o app do Chat em um espaço com várias pessoas.
      • Removido do espaço: um usuário desinstala ou remove o app do Chat de um espaço.
      • Comando do app: um usuário usa um comando rápido ou de barra do app do Chat.

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

   5. Em Visibilidade, especifique seu e-mail para que você possa 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 Registros, 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 para 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 do Chat. Para começar a testar e depurar o app do Chat, consulte Testar recursos interativos para apps do Google Chat na documentação da API Chat.

Considerações sobre complementos do Google Workspace

Os apps do Chat exigem uma configuração diferente em comparação com os 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 do Chat:

• Tanto pessoas quanto administradores do Google Workspace precisam poder instalar o complemento no Marketplace. Você configura essas configurações de instalação no SDK do Google Workspace Marketplace.
• Os apps do Chat não usam o nome e o logotipo configurados para outros aplicativos do Google Workspace no objeto addons.common do manifesto.
• Para complementos publicados no Google Workspace Marketplace, não é possível salvar um rascunho de nenhuma mudança nas configurações de configuração da API Google Chat. Depois de atualizar e salvar as configurações de configuração da API Chat, o app do Chat atualizado fica disponível para todos os usuários atuais. Para atualizar a listagem do Marketplace, você pode criar um rascunho antes de enviar as mudanças.

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

  • É necessário usar o mesmo ID de implantação do Apps Script usado para o restante da configuração do complemento.
  • Não é possível usar o editor de script do Apps Script para instalar implantações de teste no Chat. Em vez disso, é necessário instalá-las diretamente na interface do Chat.

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

Temas relacionados

• Para gerenciar o acesso à API Chat, consulte Configurar a API Google Chat na documentação da API Google Chat.
• Testar recursos interativos para apps do Google Chat