Google Chat-Oberflächen erstellen

Auf dieser Seite finden Sie eine Übersicht dazu, wie Sie Benutzeroberflächen für Google Workspace-Add‑ons erstellen, die Google Chat erweitern.

Für die Entwicklung von Schnittstellen für Chat-Apps stehen Ihnen die folgenden Add-on-Komponenten zur Verfügung:

  • Trigger: Die Möglichkeiten, mit denen Google Chat-Nutzer eine Chat-App aufrufen können, z. B. indem sie sie einem Gruppenbereich hinzufügen oder ihr eine Nachricht senden.
  • Ereignisobjekte: Die Daten, die Chat-Apps von Triggern oder UI-Interaktionen erhalten.
  • Aktionen: Die Möglichkeiten, wie Chat-Apps auf Interaktionen reagieren können, z. B. durch Senden von Nachrichten oder Zurückgeben einer kartenbasierten Benutzeroberfläche.
Die Chat-App empfängt ein Ereignisobjekt von einem „Dem Gruppenbereich hinzugefügt“-Trigger.
Abbildung 1: Wenn ein Nutzer einem Gruppenbereich eine Chat-App hinzufügt, wird der Trigger Zu Gruppenbereich hinzugefügt ausgelöst und ein Ereignisobjekt gesendet. Wenn Sie mit einer Nachricht antworten möchten, verarbeitet die Chat-App das Ereignisobjekt und gibt eine Aktion zurück, mit der die Nachricht erstellt wird.

Chat-Apps können Karten in den folgenden Oberflächen erstellen und anzeigen:

  • Nachrichten, die Text, statische oder interaktive Karten und Schaltflächen enthalten können.
  • Dialogfelder sind Karten, die in einem neuen Fenster geöffnet werden und Nutzer in der Regel auffordern, Informationen einzugeben.
  • Linkvorschauen: Das sind Karten, die Informationen zu einem externen Dienst in der Vorschau anzeigen.

Trigger

In diesem Abschnitt werden die Trigger beschrieben, die Google Workspace-Add-ons in Chat verwenden.

Auslöser sind die spezifischen Methoden, mit denen Nutzer eine Chat-App über die Chat-Benutzeroberfläche aufrufen, z. B. durch die Verwendung von @Erwähnungen oder App-Befehlen.

In der folgenden Tabelle sind Chat-Trigger, eine Beschreibung und die typische Reaktion von Chat-Apps aufgeführt:

Trigger Beschreibung Typische Antwort
Dem Gruppenbereich hinzugefügt

Ein Nutzer fügt die Chat-App einem Gruppenbereich hinzu oder ein Google Workspace-Administrator installiert die Chat-App in Direktnachrichtenbereichen für Nutzer in seiner Organisation. Weitere Informationen zu von Administratoren installierten Chat-Apps finden Sie in der Google Workspace-Admin-Hilfe unter Marketplace-Apps in Ihrer Domain installieren.

 Die Chat-App sendet eine Onboarding-Nachricht, in der erklärt wird, was sie tut und wie Nutzer im Gruppenbereich damit interagieren können.
Botschaft

Ein Nutzer interagiert auf eine der folgenden Arten mit der Chat App in einer Nachricht:

  • Sendet eine Nachricht in einem Direktnachrichtenbereich mit der Chat-App.
  • Die Chat-App wird in einem beliebigen Bereichstyp mit @ erwähnt.
  • Sendet eine Nachricht mit einem Link, der dem URL-Muster für Linkvorschauen entspricht.
  • Gibt Text in das Mehrfachauswahlmenü eines selectionInput-Widgets ein.
 Die Chat-App antwortet basierend auf dem Inhalt der Nachricht. Eine Chat-App antwortet beispielsweise auf den Slash-Befehl /about mit einer Nachricht, in der die Aufgaben erläutert werden, die die Chat-App ausführen kann.
Aus Gruppenbereich entfernt

Ein Nutzer entfernt die Chat-App aus einem Gruppenbereich oder ein Google Workspace-Administrator deinstalliert die Chat-App für einen Nutzer in seiner Organisation.

Nutzer können keine Chat-Apps entfernen, die von ihrem Administrator installiert wurden. Wenn ein Nutzer die Chat App zuvor installiert hatte, bleibt sie installiert, unabhängig davon, ob ein Google Workspace-Administrator versucht, sie zu deinstallieren.

 In der Chat App werden alle für den Gruppenbereich konfigurierten eingehenden Benachrichtigungen entfernt (z. B. durch Löschen eines Webhooks) und der interne Speicher wird geleert. Chat-Apps können nicht mit Nachrichten auf diesen Trigger reagieren, da sie nicht mehr Mitglied des Gruppenbereichs sind.
App-Befehl

Ein Nutzer verwendet einen Chat-App-Befehl.

 Die Chat App reagiert auf den Befehl. Zum Beispiel Antworten mit einer Nachricht oder das Öffnen eines Dialogfelds.

Im Gegensatz zu anderen Google Workspace-Add‑ons müssen Sie alle Callback-Funktionen für diese Trigger über die Google Chat API konfigurieren. Eine Anleitung finden Sie unter Google Chat-App konfigurieren.

Informationen zum Reagieren auf einen Trigger finden Sie in den folgenden Anleitungen:

Ereignisobjekte

Chat-Apps empfangen Ereignisobjekte, wenn ein Chat-Trigger ausgelöst wird oder wenn Chat-Nutzer mit einer Benutzeroberfläche der Chat-App interagieren (z. B. auf eine Schaltfläche klicken). Das Ereignisobjekt enthält Daten zur Interaktion, die die Chat-App verwenden kann, um zu reagieren oder eine Benutzeroberfläche zu aktualisieren.

Informationen zum Verarbeiten von Ereignisobjekten finden Sie in den folgenden Anleitungen:

Weitere Informationen zu Add-on-Ereignisobjekten in Chat und anderen Google Workspace-Anwendungen finden Sie unter Ereignisobjekte.

Chat-Aktionen

In diesem Abschnitt wird beschrieben, wie Chat-Apps Add‑on-Aktionen verwenden können, um auf Nutzerinteraktionen zu reagieren.

Wenn Sie mit einer Add-on-Aktion antworten möchten, muss eine Chat-App innerhalb von 30 Sekunden antworten. Die Antwort muss in dem Gruppenbereich gepostet werden, in dem die Interaktion stattgefunden hat. Andernfalls muss die Chat-App die Authentifizierung einrichten und die Google Chat API aufrufen, um zu antworten.

Chat-Apps können auf viele Arten auf Interaktionen reagieren. In vielen Fällen antworten Chat-Apps mit einer Nachricht. Chat-Apps können auch Informationen aus einer Datenquelle abrufen, die Informationen zum Ereignisobjekt aufzeichnen oder so gut wie alles andere tun. Dieses Verhalten bei der Verarbeitung definiert im Wesentlichen die Google Chat App.

Um auf Nutzerinteraktionen zu reagieren, müssen Chat-Apps das entsprechende Ereignisobjekt verarbeiten und eines der folgenden JSON-Objekte zurückgeben:

Antwort der Chat-App Erforderliche Maßnahmen für die Rückgabe
Nachricht senden oder aktualisieren: DataActions
Dialogfeld öffnen, aktualisieren oder schließen. RenderActions
Um Informationen aus einer Karte oder einem Dialogfeld zu erfassen, schlagen Sie Auswahlmöglichkeiten vor, die auf dem basieren, was Nutzer in ein Menü mit Mehrfachauswahl eingeben. RenderActions
Vorschau von Links in Nachrichten, die Chat-Nutzer in einem Gruppenbereich senden. DataActions

Mit der Google Chat API antworten

Anstatt eine Add‑on-Aktion zurückzugeben, müssen Chat-Apps möglicherweise die Google Chat API verwenden, um auf eine Interaktion zu reagieren. Chat-Apps müssen beispielsweise die Google Chat API aufrufen, um Folgendes zu tun:

  • Reagieren Sie nach 30 Sekunden auf eine Interaktion.
  • Aufgaben außerhalb des Bereichs ausführen, in dem die Interaktion stattgefunden hat.
  • Aufgaben in Chat ausführen, die nicht als Add-on-Aktionen verfügbar sind. Sie können beispielsweise Gruppenbereiche auflisten, in denen ein Nutzer oder eine Chat-App Mitglied ist, oder Nutzer zu einem Gruppenbereich hinzufügen.
  • Aufgaben im Namen des Chat-Nutzers ausführen (dazu ist eine Nutzerauthentifizierung erforderlich).

Weitere Informationen zur Authentifizierung und zum Aufrufen der Chat API finden Sie in der Übersicht über die Chat API.