Google Chat API konfigurieren

Für jede Google Chat-App, die Sie erstellen, ist ein eigenes Google Cloud-Projekt mit aktivierter und konfigurierter Chat API erforderlich.

Wenn Sie schreibgeschützte API-Aufrufe mit Nutzerauthentifizierung ausführen möchten, z. B. zum Abrufen von Bereichen und zum Auflisten von Nachrichten, müssen Sie nur die API aktivieren und einen OAuth-Client erstellen.

Wenn Sie API-Aufrufe zum Erstellen, Aktualisieren und Löschen ausführen oder eine interaktive Chat-App bereitstellen und testen möchten, die als Google Workspace-Add‑on erstellt wurde und Chat erweitert, müssen Sie auch die Chat API konfigurieren. In den Konfigurationseinstellungen der Chat API geben Sie alle Details zur Chat-App an, einschließlich Anzeigename, Avatar, Bereitstellungsendpunkte und interaktive Funktionen.

Vorbereitung

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

Wenn Sie die Chat API aktivieren, konfigurieren Sie die Details zu Ihrer Chat-App, die Nutzern in Chat angezeigt werden, einschließlich Anzeigename, Avatar und Beschreibung. Diese Details 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.

Bevor Sie eine Chat-App konfigurieren, benötigen Sie die folgenden Informationen:

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 ist 256 × 256 Pixel oder mehr.
Beschreibung Eine kurze Beschreibung des Zwecks der Chat App. Bis zu 40 alphanumerische Zeichen

Name, Avatar und Beschreibung der Chat-App werden Nutzern in der Chat-Benutzeroberfläche angezeigt. Bei einigen Schreibanfragen an die Chat API verwendet Google Chat diese Informationen, um die Aktionen zuzuordnen, die eine Chat-App in Google Chat ausführt.

Wenn Sie beispielsweise die Methode spaces.create() aufrufen, enthält Chat den Namen der Chat-App in der Beschreibung, wer den Gruppenbereich erstellt hat, wie im folgenden Bild dargestellt:

Eine Google Chat-App erstellt einen Bereich für einen Nutzer.
Abbildung 1. Die Attributionsnachricht, die in Chat angezeigt wird, wenn die Methode spaces.create() verwendet wird, um einen Gruppenbereich im Namen eines Nutzers zu erstellen.

Nutzer interagieren mit Chat-Apps und sehen oder verwenden diese Informationen auch auf folgende Weise:

  • Erwähnen Sie die Chat-App mit @, um sie einem Gruppenbereich hinzuzufügen oder ihr eine Nachricht zu senden.
  • 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 Eingabezeile können Nutzer Chat-Apps aufrufen und deren Namen, Avatar und Beschreibung sehen.

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 die Seite Konfiguration:

    Zur Seite „Chat API-Konfiguration“

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

  3. Konfigurieren Sie unter Interaktive Funktionen, ob Ihre Chat-App auf Nutzerinteraktionen reagiert:

    Wenn Sie eine interaktive Chat-App erstellen möchten, aktivieren Sie Interaktive Funktionen aktivieren und führen Sie die folgenden Schritte aus:

    1. Unter Funktionalität:
      • Optional: Wählen Sie Support App Home aus, um eine Startseitenkarte auf dem Tab Startseite von 1:1-Direktnachrichten mit der Chat-App anzuzeigen.
      • Wählen Sie 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 in Gruppenbereichen mit mehreren Personen hinzufügen und mit ihr interagieren.

    2. 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.
      • Wenn Sie einen Dialogflow-Agenten 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 bestimmte Endpunkte oder Funktionen weiterleiten möchten, gehen Sie zu den Verbindungseinstellungen > Auslöser und geben Sie die Callback-Endpunkte oder -Funktionen für die folgenden Chat-Auslöser an oder aktualisieren Sie sie:

      • App-Startseite (wenn App-Startseite unterstützen aktiviert ist): Ein Nutzer öffnet den Tab Startseite in einer 1:1-Direktnachricht mit der Chat-App.
      • 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. Das kann z. B. eine Direktnachricht an die Chat-App sein oder ein @mention 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 ruft einen Schnellbefehl, Slash-Befehl oder eine Nachrichtenaktion über die Chat-App auf.

    4. Optional: Fügen Sie weitere interaktive Funktionen hinzu, z. B. Einstiegsprompts, Befehle (Schnellbefehle, Slash-Befehle und nachrichtenbasierte Aktionen) oder Link-Vorschauen.

    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: Wählen Sie unter Logs das Kästchen Fehler in Logging protokollieren aus, um Google Cloud Logging zu verwenden. Weitere Informationen finden Sie unter Fehlerlogs für Chat-Apps abfragen.

  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 unter Interaktive Funktionen für Google Chat-Apps testen.

Hinweise zu bestehenden 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, sollten Sie die folgenden Anforderungen für die Konfiguration der Chat-App berücksichtigen:

  • 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.
  • 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 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 sofort zur Verfügung. Wenn Sie Ihr Marktplatzangebot 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 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.

Anderen Personen die Berechtigung zum Konfigurieren der Chat API erteilen

Sie können bestimmten Nutzern Zugriff auf die Konfigurationsseite der Chat-App gewähren, indem Sie ihnen die IAM-Rolle Chat apps Owner oder Chat apps Viewer zuweisen. Nutzer mit diesen Rollen können nicht über das Dashboard APIs & Services zur Konfigurationsseite für Chat-Apps navigieren. Sie können jedoch auf die Konfigurationsseite zugreifen, indem sie so zur Google Cloud Console für das Cloud-Projekt des Hosts der Chat-App navigieren:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

Dabei ist PROJECT_ID die Projekt-ID des Google Cloud-Projekts, in dem die Chat-App gehostet wird.

Chat-Apps, die keine Add‑ons sind: Google Chat API konfigurieren

Wenn Sie eine Chat-App verwalten, die kein Google Workspace-Add‑on ist, wird in Ihrer Konfiguration ein einzelner Endpunkt für alle Interaktionsereignisse verwendet, anstatt ereignisspezifische Trigger:

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

    Zur Seite „Chat API Configuration“

  2. Aktivieren Sie unter Interaktive Funktionen die Option Interaktive Funktionen aktivieren.

  3. Deaktivieren Sie Diese Chat-App als Google Workspace-Add‑on erstellen. Ein Dialogfeld wird geöffnet, in dem Sie den Vorgang bestätigen müssen. Klicken Sie im Dialogfeld auf Deaktivieren.

  4. Wählen Sie unter Funktionsweise nach Bedarf App-Startseite unterstützen oder Gruppenbereichen und Gruppenunterhaltungen beitreten aus.

  5. Geben Sie unter Verbindungseinstellungen einen einzelnen Endpunkt für Ihre Chat-App an (HTTP-Endpunkt-URL, Apps Script-Bereitstellungs-ID, Cloud Pub/Sub-Themenname oder Dialogflow).

  6. Konfigurieren Sie optional Befehle, Linkvorschauen, Sichtbarkeit und Logs und klicken Sie dann auf Speichern.

Wenn Sie eine Google Chat-App, die kein Add‑on ist, in ein Google Workspace-Add‑on umwandeln möchten, das Google Chat erweitert, lesen Sie den Abschnitt Google Chat-App in ein Google Workspace-Add‑on umwandeln.