Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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 Chat, incluindo
o nome, o avatar, a implantação e os recursos interativos que você quer usar.
Escolher um nome de exibição, um avatar e uma descrição para seu app de 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 apps de chat, os usuários veem ou usam essas informações das seguintes maneiras:
@mencione o app do Chat para adicioná-lo a um espaço ou
envie uma mensagem para ele.
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 composição, 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 Chat.
Até 25 caracteres alfanuméricos
URL do avatar
A imagem que aparece como avatar do app 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 de chat.
Até 40 caracteres alfanuméricos
Na seção a seguir, especifique essas informações nas configurações
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 seu app de chat no
Marketplace, você também precisa especificar os detalhes que
aparecem na
página do Marketplace do app.
Quando tiver os detalhes do app do Chat, abra o projeto do Cloud e configure a API Chat:
No console do Google Cloud, acesse a página da API Chat e clique em Configuração:
Em Informações do aplicativo, preencha os campos Nome do app, URL do avatar e Descrição.
Em Recursos interativos, clique em Ativar recursos interativos
para a posição "Ativado" e conclua o seguinte:
Em Funcionalidade, selecione Participar de espaços e conversas em grupo
para disponibilizar o app Chat para instalação e uso.
Por padrão, os usuários podem instalar e enviar mensagens com o app Chat em um espaço dedicado entre o usuário e o app. Eles também podem adicionar e interagir com o app em espaços com várias pessoas.
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.
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 de chat:
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 individuais.
Mensagem: 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.
Removido do espaço: um usuário desinstala ou remove o
app Chat de um espaço.
Comando de app: um usuário usa um comando rápido ou de barra no
app Chat.
Em Visibilidade, especifique seu e-mail para poder 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.
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 de apps de chat
na documentação da API Chat.
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 o app Chat, consulte Testar recursos interativos para apps do Google Chat na documentação da API Chat.
Considerações para complementos do Google Workspace
Os apps do Chat exigem uma configuração diferente dos complementos do Google Workspace que estendem outros apps do Google Workspace.
Se o complemento estender outros aplicativos do Google Workspace, considere os seguintes requisitos para configurar o app do Chat:
As pessoas e os administradores do Google Workspace precisam conseguir instalar
seu complemento no
Marketplace. Você configura essas opções de instalação no SDK do Google Workspace Marketplace.
Os apps de chat não usam o nome e o logotipo que você configura
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 mudanças nas
configurações da API Google Chat.
Depois de atualizar e salvar as configurações de configuração da API Chat, o
app Chat atualizado fica disponível para todos os usuários
atuais. Para atualizar sua página no Marketplace, você pode
criar um rascunho
antes de enviar as mudanças.
Se você criou o complemento usando o
Apps Script:
Use o mesmo ID de implantação do Apps Script que você
usa para o restante da configuração do complemento.
Se você criou o complemento usando um serviço HTTP, omita os detalhes de configuração do app do Chat no manifesto e nas implantações criadas com 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.
[null,null,["Última atualização 2025-08-04 UTC."],[[["\u003cp\u003eThis guide explains how to set up a Google Chat app as a Google Workspace add-on using either Apps Script or an HTTP service.\u003c/p\u003e\n"],["\u003cp\u003eYou'll need a Google Workspace account, a Google Cloud project, and necessary API configurations to get started.\u003c/p\u003e\n"],["\u003cp\u003eThe setup involves choosing a display name, avatar, and description for your app, and configuring its interactive features in the Google Cloud console.\u003c/p\u003e\n"],["\u003cp\u003eFor existing Google Workspace add-ons, specific considerations apply when integrating Chat app functionalities.\u003c/p\u003e\n"],["\u003cp\u003eThis feature is part of the Google Workspace Developer Preview Program, granting early access before public release.\u003c/p\u003e\n"]]],["To configure a Chat app, use the Google Cloud console to access the Chat API page. Input the app's name, avatar URL, and description. Enable interactive features, choosing to receive 1:1 messages or join group conversations. Select either an HTTP endpoint URL or an Apps Script deployment ID for connection settings. Optionally, set triggers, add quick/slash commands, and specify visibility. Save configurations; users listed in \"Visibility\" can then test the Chat app.\n"],null,["# Configure a Google Chat app\n\nThis page explains how to configure and deploy a Google Chat app\nas a Google Workspace add-on.\n\nTo deploy and test a Google Workspace add-on that extends Chat,\nyou must enable and configure a Chat app using the\nGoogle Chat API. The Chat API configuration settings are where you\nspecify all the details about the Chat app, including\nthe name, avatar, deployment, and interactive features that you want to use.\n| **Note:** This page explains how to configure a Chat app using Apps Script or an HTTP service. [Dialogflow](/workspace/chat/build-dialogflow-chat-app-natural-language) and [Pub/Sub](/workspace/chat/quickstart/pub-sub) are unavailable. For details, see [Limitations and known issues](/workspace/add-ons/chat#limitations-known-issues).\n\nPrerequisites\n-------------\n\n- A Business or Enterprise [Google Workspace](https://support.google.com/a/answer/6043576) account with access to [Google Chat](https://workspace.google.com/products/chat/).\n- A Google Cloud project. To create one, see\n [Create a Google Cloud project](/workspace/guides/create-project).\n\n- [Configure the OAuth consent screen](/workspace/guides/configure-oauth-consent).\n- [Enable the Google Chat API](/workspace/guides/enable-apis).\n\nChoose a display name, avatar, and description for your Chat app\n----------------------------------------------------------------\n\nThe Chat app's name, avatar, and description are\ndisplayed to users in the Chat UI. To interact with\nChat apps, users see or use this information in the following\nways:\n\n- @mention the Chat app to add it to a space or send it a message.\n- Find and start a direct message with the Chat app. In the **Apps** menu, direct messages display the Chat app's name and avatar.\n- From the compose bar, users can browse Chat apps and see their name, avatar, and description.\n\nBefore you configure a Chat app, you must prepare the\nfollowing information:\n\n| Field | Description | Format |\n|-------------|-----------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| App name | The display name for the Chat app. | Up to 25 alphanumeric characters |\n| Avatar URL | The image that displays as your Chat app's avatar. | An HTTPS URL pointing to a square graphics image (PNG or JPEG). Recommended size is 256 by 256 pixels or more. |\n| Description | A brief description of the purpose of the Chat app. | Up to 40 alphanumeric characters |\n\nIn the following section, you specify this information in the configurations\nsettings in the Chat API.\n\nConfigure your Chat app in the Google Cloud console\n---------------------------------------------------\n\nIn the Google Cloud console, you configure the details about your\nChat app that appear to users in Chat,\nincluding a display name, avatar, and description. These details only appear\nin Chat. To publish your Chat app to the\nMarketplace, you must also specify the details that\nappear in your Chat app's\n[Marketplace listing](/workspace/marketplace/create-listing).\n\nWhen you have your Chat app details, open your\nCloud project and configure the Chat API:\n\n1. In the Google Cloud console, go to the Chat API page and click the\n **Configuration** page:\n\n [Go to the Chat API Configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)\n2. Under **Application info** , fill out the **App name** , **Avatar URL** ,\n and **Description** fields.\n\n3. Under **Interactive features** , click the **Enable interactive features**\n to the on position and complete the following:\n\n 1. Under **Functionality** , select **Join spaces and group conversations**\n to make your Chat app available to install and use.\n\n By default, Users can install and message with the\n Chat app in a dedicated space between\n the user and Chat app. Users can also add and interact\n with the Chat app in spaces with multiple\n people.\n 2. Under **Connection settings** , select the architecture that you want to\n use to receive\n [event objects from Chat](/workspace/add-ons/chat/build#event-objects):\n\n - To use an HTTP service, select **HTTP endpoint URL** and provide a URL.\n - To use a Google Apps Script project, select **Apps Script** and provide a [deployment ID](/apps-script/concepts/deployments) for the project.\n\n | **Warning:** If an Apps Script deployment ID is already populated, the Cloud project is connected to an existing Google Workspace add-on. If you update the deployment ID in the Chat API, the deployment ID is updated for your add-on and could affect your listing in the Google Workspace Marketplace. To review your add-on configuration, see [Configure your app in the Google Workspace Marketplace SDK](/workspace/marketplace/enable-configure-sdk) in the Google Workspace Marketplace documentation.\n 3. Optional: To receive event objects to more than one endpoint or\n function, go to **Connection settings**\n \\\u003e **Triggers** and provide or\n update the callback functions for the following\n [Chat triggers](/workspace/add-ons/chat/build#triggers):\n\n | **Note:** For Apps Script, if you don't update the triggers, you must use the corresponding callback functions that are populated in this section (such as `onMessage`, `onAddedToSpace`, and `onRemovedFromSpace`).\n - **Added to space**: A user adds the Chat app to a group conversation or space, or installs the Chat app for 1:1 messages.\n - **Message**: A user sends a message to the Chat app. For example, sends a direct message to the Chat app or @mentions the Chat app in a space with multiple people.\n - **Removed from space**: A user uninstalls or removes the Chat app from a space.\n - **App command**: A user uses a quick command or slash command from the Chat app.\n 4. Optional: Add other interactive features such as\n [quick commands](/workspace/add-ons/chat/quick-commands),\n [slash commands](/workspace/add-ons/chat/slash-commands),\n or [link previews](/workspace/add-ons/chat/preview-links).\n\n 5. Under **Visibility** , specify your email so that you can\n [install and test the Chat app](/workspace/chat/test-interactive-features)\n before you publish to the Google Workspace Marketplace. You can specify\n up to five individuals, or one or more Google Groups from your\n Google Workspace organization.\n\n4. Optional: Under **Logs** , select the **Log errors to Logging** checkbox to\n use Google Cloud Logging. For more information, see\n [Query error logs for Chat apps](/workspace/chat/query-logs)\n in the Chat API documentation.\n\n5. Click **Save**.\n\nAfter you save the configuration, anyone that you specified in the\nChat API's **Visibility** setting can install, test, or use the\nChat app. To start testing and debugging your\nChat app, see\n[Test interactive features for Google Chat apps](/workspace/chat/test-interactive-features)\nin the Chat API documentation.\n\nConsiderations for existing Google Workspace add-ons\n----------------------------------------------------\n\nChat apps require a different configuration compared to\nGoogle Workspace add-ons that extend other Google Workspace applications.\nIf your add-on extends other\nGoogle Workspace applications, consider the following requirements\nfor configuring the Chat app:\n\n- Both individuals and Google Workspace administrators must be able to install your add-on from the Marketplace. You configure these installation settings in the Google Workspace Marketplace SDK.\n- Chat apps don't use the name and logo that you configure for other Google Workspace applications in the `addons.common` object of the [manifest](/workspace/add-ons/concepts/workspace-manifests).\n- For add-ons that are published to the Google Workspace Marketplace, you can't save a draft of any changes to the [Google Chat API configuration settings](/workspace/add-ons/chat/configure). After you update and save the Chat API configuration settings, the updated Chat app is available to all existing users. To update your Marketplace listing, you can [create a draft](/workspace/marketplace/manage-app-listing#draft-app-listing) before submitting any changes.\n- If you built your add-on using\n Apps Script:\n\n - You must use the same Apps Script deployment ID that you use for the rest of your add-on configuration.\n - You can't use the Apps Script editor to install [test deployments](/workspace/add-ons/how-tos/testing-workspace-addons#install_an_unpublished) in Chat. Instead, you must [install them directly from the\n Chat UI](/workspace/chat/test-interactive-features).\n- If you built your add-on using an HTTP service,\n omit any Chat app configuration details in the\n manifest and deployments that you create using the Google Workspace add-ons API. The\n HTTP deployments that you specify in the Google Workspace Marketplace SDK are\n only used for other Google Workspace applications.\n\nRelated topics\n--------------\n\n- To manage access to the Chat API, see [Configure the Google Chat API](/workspace/chat/configure-chat-api#grant-access) in the Google Chat API documentation.\n- [Test interactive features for Google Chat apps](/workspace/chat/test-interactive-features)"]]
