Google Chat-App konfigurieren

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 Google 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 interaktiver Funktionen, die Sie verwenden möchten.

Vorbereitung

HTTP

Apps Script

Anzeigenamen, Avatar und Beschreibung für Ihre Chat-App auswählen

Der Name, der Avatar und die Beschreibung der Chat-App werden Nutzern in der Chat-Benutzeroberfläche angezeigt. Wenn Nutzer mit Chat-Apps interagieren, sehen oder verwenden sie diese Informationen auf folgende Weise:

  • Erwähnen Sie die Chat-App, um sie einem Gruppenbereich hinzuzufügen, oder senden Sie ihr eine Nachricht.
  • Suchen Sie nach der Chat-App und starten Sie eine Direktnachricht. Im Menü Apps werden in Direktnachrichten der Name und der Avatar der Chat-App angezeigt.
  • Über die Eingabeleiste können Nutzer Chat-Apps durchsuchen und ihren Namen, Avatar und ihre Beschreibung sehen.

Bevor Sie eine Chat-App konfigurieren, müssen Sie die folgenden Informationen vorbereiten:

Feld Beschreibung Format
App-Name Der Anzeigename für die Google 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 Grafikbild (PNG oder JPEG) verweist. Die empfohlene Größe ist 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 in der Chat API an.

Chat-App in der Google Cloud Console konfigurieren

Wenn Sie die Details Ihrer Chat-App haben, öffnen Sie Ihr Cloud-Projekt und konfigurieren Sie die Chat API:

  1. Rufen Sie in der Google Cloud Console die Seite „Chat API“ auf und klicken Sie auf Konfiguration:

    Seite „Chat API-Konfiguration“ aufrufen

  2. Füllen Sie unter App-Informationen die Felder App-Name, Avatar-URL und Beschreibung aus.

  3. Aktivieren Sie unter Interaktive Funktionen die Option Interaktive Funktionen aktivieren und führen Sie die folgenden Schritte aus:

    1. Aktivieren Sie unter Funktionen ein oder mehrere Kästchen, damit Ihre Chat-App installiert und verwendet werden kann:

      • 1:1-Nachrichten empfangen: Nutzer können die Chat-App installieren und Nachrichten in einem speziellen Bereich zwischen dem Nutzer und der Chat-App senden.

      • Gruppenbereichen und Gruppenunterhaltungen beitreten: Nutzer können die Chat-App in Gruppenbereichen mit mehreren Personen hinzufügen und mit ihr interagieren.

    2. Wählen Sie unter Verbindungseinstellungen die Architektur aus, mit der Sie Ereignisobjekte aus Google Chat empfangen 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.

    3. Optional: Wenn Sie Ereignisobjekte an mehr als einen Endpunkt oder eine Funktion senden möchten, rufen Sie Erweiterte Einstellungen > Trigger auf und geben Sie die Rückruffunktionen für die folgenden Chat-Trigger an oder aktualisieren Sie sie:

      • ADDED_TO_SPACE: Ein Nutzer fügt der Chat-App eine Gruppenunterhaltung oder einen Gruppenbereich hinzu oder installiert die Chat-App für 1:1-Nachrichten.
      • MESSAGE: Ein Nutzer sendet eine Nachricht an die Chat App. Das kann beispielsweise eine Direktnachricht an die Chat App oder eine @Erwähnung der Chat App in einem Gruppenbereich mit mehreren Personen sein.
      • REMOVED_FROM_SPACE: Ein Nutzer deinstalliert die Google Chat App oder entfernt sie aus einem Gruppenbereich.

    4. Optional: Fügen Sie weitere interaktive Funktionen wie Schrägstricheingaben oder Linkvorschauen hinzu.

    5. 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.

  4. Optional: Klicken Sie unter Protokolle das Kästchen Fehler in Cloud Logging protokollieren an, um Google Cloud Logging zu verwenden. Weitere Informationen finden Sie in der Chat API-Dokumentation unter Abfragefehlerprotokolle für Chat-Apps.

  5. Klicken Sie auf Speichern.

Nachdem Sie die Konfiguration gespeichert haben, kann die Chat-App von allen Personen installiert, getestet oder verwendet werden, die Sie in der Einstellung Sichtbarkeit der Chat API angegeben haben. Informationen zum Testen und Entwickeln 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, beachten Sie die folgenden Anforderungen für die Konfiguration der Chat-App:

  • Sowohl Einzelpersonen als auch Google Workspace-Administratoren müssen Ihr Add-on aus dem Marketplace installieren können. Sie konfigurieren diese Installationseinstellungen im Google Workspace Marketplace SDK.
  • Für Chat-Apps werden nicht der Name und das Logo verwendet, die Sie für andere Google Workspace-Anwendungen im addons.common-Objekt des manifest konfigurieren.
  • Bei Add-ons, die im Google Workspace Marketplace veröffentlicht werden, können Sie keinen Entwurf für Änderungen an den Konfigurationseinstellungen der Google Chat API speichern. Nachdem Sie die Konfigurationseinstellungen der Chat API aktualisiert und gespeichert haben, ist die aktualisierte Chat-App für alle bestehenden Nutzer verfügbar. Wenn Sie Ihren Marktplatzeintrag aktualisieren möchten, können Sie einen Entwurf erstellen, bevor Sie Änderungen einreichen.

  • Wenn Sie Ihr Add-on mit Apps Script erstellt haben:

  • Wenn Sie Ihr Add-on mit einem HTTP-Dienst erstellt haben, lassen Sie alle Konfigurationsdetails für die Chat-App im Manifest und in den Bereitstellungen aus, 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.