Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Auf dieser Seite wird erläutert, wie Sie eine Google Chat-App als Google Workspace-Add‑on konfigurieren und bereitstellen.
Wenn Sie ein Google Workspace-Add‑on bereitstellen und testen möchten, das Chat erweitert, müssen Sie eine Chat-App mit der Google Chat API aktivieren und konfigurieren. In den Konfigurationseinstellungen der Chat API geben Sie alle Details zur Chat-App an, einschließlich Name, Avatar, Bereitstellung und interaktive Funktionen, die Sie verwenden möchten.
Anzeigenamen, Avatar und Beschreibung für Ihre Chat-App auswählen
Der Name, der Avatar und die Beschreibung der Chat-App werden den Nutzern in der Chat-Benutzeroberfläche angezeigt. Nutzer interagieren mit Chat-Apps und sehen oder verwenden diese Informationen auf folgende Weise:
Erwähnen Sie die Chat-App mit „@“, um sie einem Gruppenbereich hinzuzufügen oder ihr eine Nachricht zu senden.
Suchen Sie die Chat App und starten Sie eine Direktnachricht.
Im Menü Apps werden in Direktnachrichten der Name und der Avatar der Chat App angezeigt.
Über die Leiste zum Verfassen von Nachrichten können Nutzer Chat-Apps aufrufen und sich ihren Namen, Avatar und ihre Beschreibung ansehen.
Bevor Sie eine Chat-App konfigurieren, müssen Sie die folgenden Informationen vorbereiten:
Feld
Beschreibung
Format
App-Name
Der Anzeigename für die Chat-App.
Bis zu 25 alphanumerische Zeichen
Avatar-URL
Das Bild, das als Avatar Ihrer Chat-App angezeigt wird.
Eine HTTPS-URL, die auf ein quadratisches Bild (PNG oder JPEG) verweist.
Die empfohlene Größe beträgt mindestens 256 × 256 Pixel.
Beschreibung
Eine kurze Beschreibung des Zwecks der Chat-App.
Bis zu 40 alphanumerische Zeichen
Im folgenden Abschnitt geben Sie diese Informationen in den Konfigurationseinstellungen der Chat API an.
Chat-App in der Google Cloud Console konfigurieren
In der Google Cloud Console konfigurieren Sie die Details zu Ihrer Chat-App, die Nutzern in Chat angezeigt werden, einschließlich eines Anzeigenamens, eines Avatars und einer Beschreibung. Diese Informationen werden nur in Chat angezeigt. Wenn Sie Ihre Chat-App im Marketplace veröffentlichen möchten, müssen Sie auch die Details angeben, die im Marketplace-Eintrag Ihrer Chat-App angezeigt werden.
Wenn Sie die Details zu Ihrer Chat-App haben, öffnen Sie Ihr Cloud-Projekt und konfigurieren Sie die Chat API:
Rufen Sie in der Google Cloud Console die Seite „Chat API“ auf und klicken Sie auf die Seite Konfiguration:
Füllen Sie unter Anwendungsinformationen die Felder Name der App, Avatar-URL und Beschreibung aus.
Klicken Sie unter Interaktive Funktionen auf Interaktive Funktionen aktivieren, um die Funktion zu aktivieren, und gehen Sie so vor:
Wählen Sie unter Funktionsweise die Option Gruppenbereichen und Gruppenunterhaltungen beitreten aus, damit Ihre Chat-App installiert und verwendet werden kann.
Standardmäßig können Nutzer die Chat-App in einem dedizierten Bereich zwischen dem Nutzer und der Chat-App installieren und Nachrichten mit ihr austauschen. Nutzer können die Chat-App auch Gruppenbereichen mit mehreren Personen hinzufügen und mit ihr interagieren.
Wählen Sie unter Verbindungseinstellungen die Architektur aus, die Sie zum Empfangen von Ereignisobjekten aus Chat verwenden möchten:
Wenn Sie einen HTTP-Dienst verwenden möchten, wählen Sie HTTP-Endpunkt-URL aus und geben Sie eine URL an.
Wenn Sie ein Google Apps Script-Projekt verwenden möchten, wählen Sie Apps Script aus und geben Sie eine Bereitstellungs-ID für das Projekt an.
Optional: Wenn Sie Ereignisobjekte an mehr als einen Endpunkt oder eine Funktion senden möchten, gehen Sie zu Verbindungseinstellungen>Trigger und geben Sie die Callback-Funktionen für die folgenden Chat-Trigger an oder aktualisieren Sie sie:
Dem Gruppenbereich hinzugefügt: Ein Nutzer fügt die Chat-App einer Gruppenunterhaltung oder einem Gruppenbereich hinzu oder installiert die Chat-App für persönliche Nachrichten.
Nachricht: Ein Nutzer sendet eine Nachricht an die Chat-App, z. B. eine Direktnachricht an die Chat-App oder eine @Erwähnung der Chat-App in einem Gruppenbereich mit mehreren Personen.
Aus Gruppenbereich entfernt: Ein Nutzer deinstalliert die Chat-App oder entfernt sie aus einem Gruppenbereich.
App-Befehl: Ein Nutzer verwendet einen Schnellbefehl oder Slash-Befehl in der Chat-App.
Geben Sie unter Sichtbarkeit Ihre E-Mail-Adresse an, damit Sie die Chat-App installieren und testen können, bevor Sie sie im Google Workspace Marketplace veröffentlichen. Sie können bis zu fünf Personen oder eine oder mehrere Google-Gruppen aus Ihrer Google Workspace-Organisation angeben.
Optional: Wählen Sie unter Logs das Kästchen Fehler in Logging protokollieren aus, um Google Cloud Logging zu verwenden. Weitere Informationen finden Sie in der Chat API-Dokumentation unter Fehlerlogs für Chat-Apps abfragen.
Klicken Sie auf Speichern.
Nachdem Sie die Konfiguration gespeichert haben, können alle Nutzer, die Sie in der Einstellung Sichtbarkeit der Chat API angegeben haben, die Chat-App installieren, testen oder verwenden. Informationen zum Testen und Debuggen Ihrer Chat-App finden Sie in der Chat API-Dokumentation unter Interaktive Funktionen für Google Chat-Apps testen.
Hinweise zu vorhandenen Google Workspace-Add‑ons
Chat-Apps erfordern eine andere Konfiguration als Google Workspace-Add‑ons, die andere Google Workspace-Anwendungen erweitern.
Wenn Ihr Add‑on andere Google Workspace-Anwendungen erweitert, gelten die folgenden Anforderungen für die Konfiguration der Chat-App:
Sowohl Einzelpersonen als auch Google Workspace-Administratoren müssen Ihr Add‑on über den Marketplace installieren können. Sie konfigurieren diese Installationseinstellungen im Google Workspace Marketplace SDK.
Chat-Apps verwenden nicht den Namen und das Logo, die Sie für andere Google Workspace-Anwendungen im addons.common-Objekt des Manifests konfigurieren.
Bei Add‑ons, die im Google Workspace Marketplace veröffentlicht werden, können Sie keinen Entwurf von Änderungen an den Konfigurationseinstellungen für die Google Chat API speichern.
Nachdem Sie die Konfigurationseinstellungen der Chat API aktualisiert und gespeichert haben, steht die aktualisierte Chat-App allen bestehenden Nutzern zur Verfügung. Wenn Sie Ihren Marketplace-Eintrag aktualisieren möchten, können Sie einen Entwurf erstellen, bevor Sie Änderungen einreichen.
Wenn Sie Ihr Add‑on mit Apps Script erstellt haben:
Sie müssen dieselbe Apps Script-Deployment-ID verwenden, die Sie für die restliche Add-on-Konfiguration verwenden.
Wenn Sie Ihr Add‑on mit einem HTTP-Dienst erstellt haben, lassen Sie alle Konfigurationsdetails der Chat-App im Manifest und in den Bereitstellungen weg, die Sie mit der Google Workspace-Add‑ons API erstellen. Die HTTP-Bereitstellungen, die Sie im Google Workspace Marketplace SDK angeben, werden nur für andere Google Workspace-Anwendungen verwendet.
Weitere Informationen
Informationen zum Verwalten des Zugriffs auf die Chat API finden Sie in der Google Chat API-Dokumentation unter Google Chat API konfigurieren.
[null,null,["Zuletzt aktualisiert: 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)"]]
