Nutzerinteraktionen empfangen und darauf reagieren

Auf dieser Seite wird beschrieben, wie Ihre Google Chat App Nutzerinteraktionen empfangen und darauf reagieren kann. Sie wird auch als Google Chat App-Interaktionsereignisse bezeichnet.

Ein Google Chat App-Interaktionsereignis stellt jede Aktion dar, die ein Nutzer ausführt, um eine Chat-App aufzurufen oder mit ihr zu interagieren, z. B. das @Erwähnen einer Chat-App oder das Hinzufügen zu einem Gruppenbereich. Wenn Nutzer mit einer Chat-App interagieren, sendet Google Chat ein Interaktionsereignis an die Chat-App. Die Chat-App kann das Ereignis verwenden, um die Interaktion zu verarbeiten und eine Antwort zu erstellen.

Chat-Apps verwenden Interaktionsereignisse beispielsweise für folgende Aktionen:

Beispiel für ein Interaktionsereignis Typische Antwort aus einer Chat-App
Ein Nutzer ruft eine Chat-App auf, indem er sie @erwähnt oder einen Slash-Befehl verwendet. Die Chat-App verarbeitet den Text der Nachricht, um eine Nachricht zu erstellen. Beispiel: Eine Chat-App antwortet auf den Befehl /about mit einer Nachricht, in der die Aufgaben erklärt werden, die die Chat-App erledigen kann.
Ein Nutzer fügt einem Gruppenbereich eine Chat-App hinzu. Die Chat-App sendet eine Onboarding-Nachricht, in der erklärt wird, was sie tut und wie Nutzer im Gruppenbereich damit interagieren können.
Ein Nutzer entfernt eine Chat-App aus einem Gruppenbereich. Die Chat-App entfernt alle eingehenden Benachrichtigungen, die für den Bereich konfiguriert sind, z. B. das Löschen eines Webhooks, und gibt den gesamten internen Speicher frei.
Ein Nutzer klickt auf einer Karte oder in einem Dialogfeld, das von der Chat-App gesendet wurde, auf eine Schaltfläche. Die Chat-App verarbeitet und speichert entweder alle vom Nutzer gesendeten Daten oder gibt eine andere Karte oder ein anderes Dialogfeld aus.

Für jede Art von Nutzerinteraktion sendet Google Chat eine andere Art von Interaktionsereignis, damit Ihre Chat-App jeden Ereignistyp entsprechend verarbeiten kann. Google Chat verwendet beispielsweise den Ereignistyp ADDED_TO_SPACE für jede Interaktion, bei der ein Nutzer die Chat-App einem Gruppenbereich hinzufügt, damit die Chat-App eine Antwort verarbeiten kann, z. B. eine Begrüßungsnachricht im Gruppenbereich. Informationen zu allen unterstützten Interaktionsereignissen finden Sie in der Referenzdokumentation zu EventType.

Auf dieser Seite wird Folgendes beschrieben:

  • Konfigurieren Sie die Chat-App für den Empfang von Ereignissen.
  • Verarbeiten Sie das Interaktionsereignis in Ihrer Infrastruktur.
  • Reagieren Sie gegebenenfalls auf Interaktionsereignisse.

Chat-App-Interaktionsereignisse erhalten

In diesem Abschnitt wird beschrieben, wie Sie Interaktionsereignisse für Ihre Chat-App empfangen und verarbeiten.

Chat-App für den Empfang von Interaktionsereignissen konfigurieren

Nicht alle Chat-Apps sind interaktiv. Beispielsweise können eingehende Webhooks nur ausgehende Nachrichten senden und Nutzern nicht antworten. Wenn Sie eine interaktive Chat-App erstellen, müssen Sie einen Endpunkt auswählen, über den Ihre Chat-App Interaktionsereignisse empfangen, verarbeiten und darauf antworten kann. Weitere Informationen zum Entwerfen der Chat-App finden Sie unter Architekturen für die Implementierung von Chat-Apps.

Wenn Sie eine interaktive Chat-App erstellt haben, müssen Sie die Google Chat API so konfigurieren, dass Google Chat Ihnen Interaktionsereignisse senden kann:

  1. Öffnen Sie in der Google Cloud Console die Seite „Google Chat API“:

    Zur Seite „Google Chat API“

  2. Klicken Sie auf den Tab Konfiguration.
  3. Stellen Sie im Bereich Interaktive Funktionen die Ein/Aus-Schaltfläche Interaktive Funktionen aktivieren auf "Ein".
  4. Klicken Sie unter Funktionen eines oder beide der folgenden Kästchen an:
    1. 1:1-Nachrichten empfangen: Nutzer können in Gruppenbereichen für Direktnachrichten (DN) mit Ihrer Chat App interagieren. Ihre Chat App empfängt Interaktionsereignisse jedes Mal, wenn ein Nutzer eine Nachricht im DM-Bereich sendet.
    2. Gruppenbereichen und Gruppenunterhaltungen beitreten: Nutzer können Ihre Chat App Gruppenbereichen mit mehr als einer Person hinzufügen und daraus entfernen. Ihre Chat-App empfängt Interaktionsereignisse, wenn sie dem Gruppenbereich hinzugefügt oder daraus entfernt wird und wenn Nutzer im Gruppenbereich @erwähnen oder einen Slash-Befehl verwenden.
  5. Geben Sie unter Verbindungseinstellungen an, wohin Google Chat-Interaktionsereignisse für die Chat-App sendet.
  6. Optional: Fügen Sie unter Slash-Befehle einen oder mehrere Slash-Befehle hinzu und konfigurieren Sie sie. Weitere Informationen finden Sie unter Slash-Befehle einrichten.
  7. Optional: Fügen Sie unter Linkvorschau ein oder mehrere URL-Muster hinzu, die in der Chat App als Vorschau angezeigt werden sollen, und konfigurieren Sie sie. Weitere Informationen finden Sie unter Vorschaulinks.
  8. Klicke auf Speichern.

Die Chat-App ist jetzt so konfiguriert, dass sie Interaktionsereignisse von Google Chat empfängt.

HTTP-Aufrufwiederholungen an den Dienst verarbeiten

Wenn eine HTTPS-Anfrage an Ihren Dienst fehlschlägt (z. B. eine Zeitüberschreitung, ein vorübergehender Netzwerkfehler oder ein Nicht-2xx-HTTPS-Statuscode), versucht Google Chat möglicherweise einige Male innerhalb weniger Minuten, die Zustellung zu wiederholen. Dies kann jedoch nicht garantiert werden. Daher kann es vorkommen, dass eine Chat-App in bestimmten Situationen dieselbe Nachricht mehrmals empfängt. Wenn die Anfrage erfolgreich abgeschlossen wird, aber eine ungültige Nachrichtennutzlast zurückgibt, wiederholt Google Chat die Anfrage nicht.

Interaktionsereignisse verarbeiten oder darauf reagieren

In diesem Abschnitt wird erläutert, wie Google Chat-Apps Interaktionsereignisse verarbeiten und darauf reagieren können.

Nachdem Ihre Chat-App ein Interaktionsereignis von Google Chat empfangen hat, kann sie auf verschiedene Arten reagieren. In vielen Fällen antworten interaktive Chat-Apps dem Nutzer mit einer Nachricht. Die Google Chat App kann auch einige Informationen aus einer Datenquelle abrufen, Informationen zu Interaktionsereignissen aufzeichnen oder vieles mehr. Dieses Verarbeitungsverhalten ist im Wesentlichen das, was die Google Chat App definiert.

Für jedes Interaktionsereignis erhalten Chat-Apps einen Anfragetext. Das ist die JSON-Nutzlast, die das Ereignis darstellt. Sie können die Informationen verwenden, um eine Antwort zu verarbeiten. Beispiele für Ereignisnutzlasten finden Sie unter Arten von Chat-App-Interaktionsereignissen.

Das folgende Diagramm zeigt, wie die Google Chat App in der Regel verschiedene Arten von Interaktionsereignissen verarbeitet oder darauf reagiert:

Architektur der Verarbeitung von Interaktionsereignissen in Google Chat-Apps

In Echtzeit antworten

Mithilfe von Interaktionsereignissen können Chat-Apps in Echtzeit oder synchron antworten. Für synchrone Antworten ist keine Authentifizierung erforderlich.

Informationen zum Erstellen synchroner Antworten auf Interaktionsereignisse finden Sie in den folgenden Anleitungen:

Um synchron zu antworten, muss eine Chat-App innerhalb von 30 Sekunden antworten und die Antwort muss in dem Bereich gepostet werden, in dem die Interaktion stattgefunden hat. Andernfalls kann die Chat-App asynchron antworten.

Asynchron antworten

Manchmal müssen Chat-Apps nach 30 Sekunden auf ein Interaktionsereignis reagieren oder Aufgaben außerhalb des Bereichs ausführen, in dem das Interaktionsereignis generiert wurde. So kann es beispielsweise sein, dass eine Chat-App dem Nutzer antworten muss, nachdem er eine lang andauernde Aufgabe ausgeführt hat. In diesem Fall können Chat-Apps asynchron antworten, indem sie die Google Chat API aufrufen.

Informationen zum Erstellen einer Nachricht mit der Chat API finden Sie unter Nachricht erstellen. Anleitungen zur Verwendung zusätzlicher Chat API-Methoden finden Sie in der Chat API-Übersicht.