Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Questa pagina spiega come configurare ed eseguire il deployment di un'app Google Chat
come componente aggiuntivo di Google Workspace.
Per eseguire il deployment e testare un componente aggiuntivo di Google Workspace che estende Chat,
devi attivare e configurare un'app Chat utilizzando l'API Google Chat. Le impostazioni di configurazione dell'API Chat sono il punto in cui
specificare tutti i dettagli sull'app di chat, inclusi
nome, avatar, deployment e funzionalità interattive che vuoi utilizzare.
Scegliere un nome visualizzato, un avatar e una descrizione per l'app Chat
Il nome, l'avatar e la descrizione dell'app Chat vengono
mostrati agli utenti nell'interfaccia utente di Chat. Per interagire con
le app di chat, gli utenti visualizzano o utilizzano queste informazioni nei seguenti
modi:
@menziona l'app Chat per aggiungerla a uno spazio o
inviarle un messaggio.
Trova e avvia un messaggio diretto con l'app Chat.
Nel menu App, i messaggi diretti mostrano il nome e l'avatar dell'app Chat.
Dalla barra di composizione, gli utenti possono sfogliare le app di Chat e visualizzare
il nome, l'avatar e la descrizione.
Prima di configurare un'app di chat, devi preparare le
seguenti informazioni:
Campo
Descrizione
Formato
Nome dell'app
Il nome visualizzato dell'app Chat.
Fino a 25 caratteri alfanumerici
URL avatar
L'immagine visualizzata come avatar
dell'app Chat.
Un URL HTTPS che rimanda a un'immagine grafica quadrata (PNG o JPEG).
Le dimensioni consigliate sono 256 x 256 pixel o superiori.
Descrizione
Una breve descrizione dello scopo dell'app Chat.
Fino a 40 caratteri alfanumerici
Nella sezione seguente, specifichi queste informazioni nelle impostazioni di configurazione dell'API Chat.
Configurare l'app Chat nella console Google Cloud
Nella console Google Cloud, configuri i dettagli della tua
app Chat che vengono visualizzati dagli utenti in Chat,
inclusi nome visualizzato, avatar e descrizione. Questi dettagli vengono visualizzati
solo in Chat. Per pubblicare la tua app di chat su Marketplace, devi anche specificare i dettagli che vengono visualizzati nella scheda del Marketplace della tua app di chat.
Una volta ottenuti i dettagli dell'app Chat, apri il tuo
progetto cloud e configura l'API Chat:
Nella console Google Cloud, vai alla pagina dell'API Chat e fai clic sulla pagina
Configurazione:
Nella sezione Informazioni sull'applicazione, compila i campi Nome app, URL avatar
e Descrizione.
In Funzionalità interattive, fai clic su Attiva funzionalità interattive
per attivare l'opzione e completa i seguenti passaggi:
In Funzionalità, seleziona Partecipa a spazi e conversazioni di gruppo
per rendere disponibile l'installazione e l'utilizzo della tua app di chat.
Per impostazione predefinita, gli utenti possono installare l'app Chat e inviare messaggi in uno spazio dedicato tra l'utente e l'app Chat. Gli utenti possono anche aggiungere l'app Chat e interagire con essa in spazi con più persone.
Nella sezione Impostazioni di connessione, seleziona l'architettura che vuoi utilizzare per ricevere oggetti evento da Chat:
Per utilizzare un servizio HTTP, seleziona URL dell'endpoint HTTP e fornisci un
URL.
Per utilizzare un progetto Google Apps Script, seleziona
Apps Script e fornisci un
ID deployment per il progetto.
(Facoltativo) Per ricevere oggetti evento in più di un endpoint o una funzione, vai a Impostazioni di connessione>Trigger e fornisci o
aggiorna le funzioni di callback per i seguenti
trigger di chat:
Aggiunta allo spazio: un utente aggiunge l'app Chat a una conversazione di gruppo o a uno spazio oppure installa l'app Chat per i messaggi 1:1.
Messaggio: un utente invia un messaggio all'app Chat. Ad esempio, invia un messaggio diretto all'app Chat o @menziona l'app Chat in uno spazio con più persone.
Rimosso dallo spazio: un utente disinstalla o rimuove l'app
Chat da uno spazio.
Comando dell'app: un utente utilizza un comando rapido o un comando slash dall'app Chat.
In Visibilità, specifica la tua email in modo da poter
installare e testare l'app di chat
prima di pubblicarla su Google Workspace Marketplace. Puoi specificare
fino a cinque persone o uno o più gruppi Google della tua
organizzazione Google Workspace.
(Facoltativo) In Log, seleziona la casella di controllo Registra errori in Logging per
utilizzare Google Cloud Logging. Per saperne di più, consulta
Eseguire query sui log degli errori per le app Chat
nella documentazione dell'API Chat.
Fai clic su Salva.
Dopo aver salvato la configurazione, chiunque tu abbia specificato nell'impostazione Visibilità dell'API Chat può installare, testare o utilizzare l'app Chat. Per iniziare a testare ed eseguire il debug dell'app Chat, consulta Testare le funzionalità interattive per le app Google Chat nella documentazione dell'API Chat.
Considerazioni per i componenti aggiuntivi di Google Workspace esistenti
Le app di chat richiedono una configurazione diversa rispetto ai componenti aggiuntivi di Google Workspace che estendono altre applicazioni Google Workspace.
Se il tuo componente aggiuntivo estende altre
applicazioni Google Workspace, tieni presente i seguenti requisiti
per la configurazione dell'app di Chat:
Sia i privati che gli amministratori di Google Workspace devono essere in grado di installare
il tuo componente aggiuntivo da
Marketplace. Configura queste impostazioni di installazione
nell'SDK di Google Workspace Marketplace.
Le app di chat non utilizzano il nome e il logo che configuri
per altre applicazioni
Google Workspace nell'oggetto addons.common del manifest.
Per i componenti aggiuntivi pubblicati su
Google Workspace Marketplace, non puoi salvare una bozza delle modifiche alle
impostazioni di configurazione dell'API Google Chat.
Dopo aver aggiornato e salvato le impostazioni di configurazione dell'API Chat, l'app di chat aggiornata è disponibile per tutti gli utenti esistenti. Per aggiornare la tua scheda del Marketplace, puoi
creare una bozza
prima di inviare le modifiche.
Se hai creato il componente aggiuntivo utilizzando
Apps Script:
Devi utilizzare lo stesso ID deployment di Apps Script che
utilizzi per il resto della configurazione del componente aggiuntivo.
Se hai creato il componente aggiuntivo utilizzando un servizio HTTP,
ometti tutti i dettagli di configurazione dell'app Chat nel
manifest e nei deployment che crei utilizzando l'API Google Workspace Add-ons. I deployment HTTP specificati nell'SDK di Google Workspace Marketplace vengono utilizzati solo per altre applicazioni Google Workspace.
Argomenti correlati
Per gestire l'accesso all'API Chat, consulta
Configurare l'API Google Chat
nella documentazione dell'API Google Chat.
[null,null,["Ultimo aggiornamento 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)"]]
