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

Vorbereitung

Anzeigename, 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-UI angezeigt. Wenn Nutzer mit Chat-Apps interagieren, sehen oder verwenden sie diese Informationen auf folgende Weise:

  • Sie können die Chat-App mit einer @-Erwähnung zu einem Gruppenbereich hinzufügen oder ihr eine Nachricht senden.
  • Sie können eine Direktnachricht an die Chat-App senden. Im Menü Apps werden in Direktnachrichten der Name und der Avatar der Chat-App angezeigt.
  • Über die Eingabezeile können Nutzer nach Chat-Apps suchen 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 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 Google Chat angezeigt werden, einschließlich Anzeigename, Avatar und Beschreibung. Diese Details werden nur in Google 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 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 die Seite Konfiguration:

    Zur Seite „Chat API-Konfiguration“

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

  3. Klicken Sie unter Interaktive Funktionen auf Interaktive Funktionen aktivieren , um die Funktion zu aktivieren, und führen Sie die folgenden Schritte aus:

    1. Wählen Sie unter Funktionalität 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 speziellen Gruppenbereich zwischen dem Nutzer und der Chat-App installieren und Nachrichten senden. Nutzer können die Chat-App auch in Gruppenbereichen mit mehreren Personen hinzufügen und mit ihr interagieren.

    2. Wählen Sie unter Verbindungseinstellungen die Architektur aus, die Sie verwenden möchten, um Ereignisobjekte von Google Chat zu empfangen:

      • 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.
      • Wenn Sie einen Dialogflow-Agent verwenden möchten, wählen Sie Dialogflow und dann Dialogflow CX oder Dialogflow ES aus und geben Sie den Ressourcennamen des Agenten an.
      • Wenn Sie Pub/Sub verwenden möchten, wählen Sie Cloud Pub/Sub aus und geben Sie den Namen des Themas ein.

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

      • Zu Gruppenbereich hinzugefügt: Ein Nutzer fügt die Chat-App einer Gruppenunterhaltung oder einem Gruppenbereich hinzu oder installiert die Chat-App für Direktnachrichten.
      • Nachricht: Ein Nutzer sendet eine Nachricht an die Chat-App. Er kann beispielsweise eine Direktnachricht an die Chat-App senden oder die Chat-App in einem Gruppenbereich mit mehreren Personen mit einer @-Erwähnung erwähnen.
      • Aus Gruppenbereich entfernt: Ein Nutzer deinstalliert die Chat-App oder entfernt sie aus einem Gruppenbereich.
      • App-Befehl: Ein Nutzer verwendet einen Schnellbefehl oder einen Slash-Befehl aus der Chat-App.

    4. Optional: Fügen Sie weitere interaktive Funktionen wie Schnellbefehle, Schrägstrichbefehle, 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 Logs 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 Fehlerlogs für Chat-Apps abfragen.

  5. 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 Debugging Ihrer Chat-App finden Sie in der Chat API-Dokumentation unter Interaktive Funktionen für Google Chat-Apps testen.

Hinweise für vorhandene 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 im 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 Objekt addons.common des Manifests konfigurieren.
  • Bei Add‑ons, die im Google Workspace Marketplace veröffentlicht werden, können Sie keinen Entwurf von Änderungen an den Konfigurationseinstellungen der Google Chat API speichern. Nachdem Sie die Konfigurationseinstellungen der Chat API aktualisiert und gespeichert haben, steht die aktualisierte Chat-App allen vorhandenen 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-Bereitstellungs-ID verwenden, die Sie für die restliche Add‑on-Konfiguration verwenden.
    • Sie können den Apps Script-Editor nicht verwenden, um Testbereitstellungen in Google Chat zu installieren. Stattdessen müssen Sie sie direkt über die Google Chat-UI installieren.

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