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 zur Erweiterung von Chat bereitstellen und testen möchten, 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 des Namens, des Avatars, der Bereitstellung und der interaktiven Funktionen, die Sie verwenden möchten.

Vorbereitung

HTTP

Apps Script

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

Der Name, der Avatar und die Beschreibung der Chat-App werden Nutzern in der Chat-UI angezeigt. Um mit Chat-Apps zu interagieren, können Nutzer diese Informationen so sehen oder verwenden:

  • @Erwähnen Sie die Chat-App, um sie einem Gruppenbereich hinzuzufügen, oder senden Sie ihr eine Nachricht.
  • Suchen und starten Sie eine Direktnachricht mit der Chat-App. Im Menü Apps werden Direktnachrichten mit dem Namen und dem Avatar der Chat-App angezeigt.
  • Über die Eingabezeile können Nutzer in Chat-Apps suchen und ihren Namen, ihren 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 der Chat-App angezeigt wird. Eine HTTPS-URL, die auf ein quadratisches Grafikbild (PNG oder JPEG) verweist. Die empfohlene Größe ist 256 × 256 Pixel oder mehr.
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

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

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

    Zur Konfigurationsseite der Chat API

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

  3. Stellen Sie unter Interaktive Features die Option Interaktive Features aktivieren auf "Ein" und gehen Sie so vor:

    1. Klicken Sie unter Funktionen ein oder mehrere Kästchen an, um die Chat-App zur Installation und Verwendung verfügbar zu machen:

      • 1:1-Nachrichten empfangen: Nutzer können die Chat-App an einem dafür vorgesehenen Bereich zwischen dem Nutzer und der Chat-App installieren und Nachrichten an sie senden.

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

    2. Wählen Sie unter Verbindungseinstellungen die Architektur aus, über die 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 empfangen möchten, rufen Sie Verbindungseinstellungen > Trigger auf 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 1:1-Nachrichten.
      • Nachricht: Ein Nutzer sendet eine Nachricht an die Chat-App, z. B. eine Direktnachricht an die Chat-App oder @erwähnt die 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 einen Slash-Befehl in der Chat-App.

    4. Optional: Fügen Sie weitere interaktive Funktionen wie Schnellbefehle, Slash-Befehle oder Linkvorschau hinzu.

    5. Geben Sie unter Sichtbarkeit Ihre E-Mail-Adresse an, damit Sie die Chat-App vor der Veröffentlichung im Google Workspace Marketplace installieren und testen können. 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 Logging protokollieren an, um Google Cloud Logging zu verwenden. Weitere Informationen finden Sie unter Abfragefehlerlogs für Chat-Apps in der Chat API-Dokumentation.

  5. Klicken Sie auf Speichern.

Nachdem Sie die Konfiguration gespeichert haben, kann jeder, den 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 Features für Google Chat-Apps testen.

Überlegungen 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, müssen Sie für die Konfiguration der Chat-App die folgenden Anforderungen beachten:

  • Sowohl Personen als auch Google Workspace-Administratoren müssen das Add-on aus dem Marketplace installieren können. Diese Installationseinstellungen werden im Google Workspace Marketplace SDK konfiguriert.
  • Chat-Apps verwenden nicht den Namen und das Logo, die Sie im addons.common-Objekt des Manifests für andere Google Workspace-Anwendungen 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, ist die aktualisierte Chat-App für alle vorhandenen Nutzer verfügbar. 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:

  • Wenn Sie das Add-on mit einem HTTP-Dienst erstellt haben, lassen Sie im Manifest und in den Bereitstellungen, die Sie mit der Google Workspace Add-ons API erstellen, alle Konfigurationsdetails für die Chat-Anwendung weg. Die HTTP-Bereitstellungen, die Sie im Google Workspace Marketplace SDK angeben, werden nur für andere Google Workspace-Anwendungen verwendet.