Nutzerinteraktionen empfangen und darauf reagieren

Auf dieser Seite wird beschrieben, wie die Google Chat App auf Nutzerinteraktionen reagieren, auch bekannt als Google Chat App Interaktionsereignisse.

Auf dieser Seite wird Folgendes beschrieben:

• Chat-App für den Empfang von Interaktionen konfigurieren Ereignisse.
• Verarbeiten Sie das Interaktionsereignis in Ihrer Infrastruktur.
• Reagieren Sie gegebenenfalls auf Interaktionsereignisse.

Vorbereitung

Eine Google Chat App mit aktivierten interaktiven Funktionen. So erstellen Sie ein Chat-App verwenden, führen Sie eine der folgenden Kurzanleitungen aus für die App-Architektur, die Sie verwenden möchten:

• HTTP-Dienst mit Google Cloud Functions
• Google Apps Script
• Google Cloud Dialogflow CX
• Cloud Pub/Sub

Funktionsweise von Interaktionsereignissen

Ein Google Chat App-Interaktionsereignis steht für jede Aktion, die ein zum Aufrufen oder Interagieren mit einer Chat-App, z. B. indem Sie eine Chat-App @erwähnen oder sie einer Leerzeichen. Wenn Nutzer mit einer Chat-App interagieren, Google Chat sendet ein Interaktionsereignis an die Chat-App. Die Chat-App kann anhand des Ereignisses die Interaktion und formulieren eine Reaktion.

Chat-Apps verwenden z. B. Interaktionsereignisse, um Folgendes:

Für jede Art von Nutzerinteraktion sendet Google Chat eine andere Art von Interaktionsereignis, mit dem die Chat-App Ereignistyp entsprechend an. In Google Chat wird beispielsweise der Ereignistyp ADDED_TO_SPACE für jede Interaktion, bei der ein Nutzer den Chat-App mit einem Gruppenbereich, Die Chat-App kann Antworten wie das Posten einer Willkommensnachricht im Gruppenbereich. Alle unterstützten Interaktionsereignisse finden Sie in der Referenz zu EventType Dokumentation.

Chat-App-Interaktionsereignisse erhalten

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

Chat-App für den Empfang von Interaktionsereignissen konfigurieren

Nicht alle Chat-Apps sind interaktiv. Beispiel: eingehende Webhooks können nur ausgehende Nachrichten senden und Nutzern nicht antworten. Wenn Sie ein interaktives Chat-App verwenden, müssen Sie einen Endpunkt auswählen, an dem Ihr Chat-App: Empfang, Verarbeitung und Antwort auf Interaktionen Ereignisse. Weitere Informationen zum Entwerfen der Chat-App finden Sie unter Architekturen zur Implementierung von Chat-Apps

Für jede der interaktiven Funktionen, die Sie erstellen möchten, müssen Sie Konfiguration in der Chat API konfigurieren, damit Google Chat Interaktionsereignisse für Ihre Chat-App:

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

   Zur Konfigurationsseite der Chat API

2. Prüfen Sie unter Interaktive Funktionen die Einstellungen und nehmen Sie bei Bedarf Änderungen vor. Funktionen, die Sie erstellen möchten:

   Feld	Beschreibung
   Funktionen	Erforderlich. Eine Reihe von Feldern, die festlegen, wie die Chat-App mit Nutzern interagieren kann: 1:1-Nachrichten empfangen: Nutzer können die Google Chat App direkt in Google Chat finden und Nachrichten senden. Gruppenbereichen und Gruppenunterhaltungen beitreten: Nutzer können die Chat App Gruppenbereichen und Gruppenunterhaltungen hinzufügen.
   Verbindungseinstellungen	Erforderlich. Der Endpunkt für die Chat-App, der einer der folgenden ist: App-URL: Ein HTTPS-Endpunkt, auf dem die Implementierung der Chat-App gehostet wird. Apps Script-Projekt: Eine Bereitstellungs-ID für ein Apps Script-Projekt, in dem eine Chat-App implementiert ist. Name des Cloud Pub/Sub-Themas: Ein Pub/Sub-Thema, das die Chat-App als Endpunkt abonniert. Dialogflow: Registriert die Chat-App mit einer Dialogflow-Integration. Weitere Informationen finden Sie unter In Dialogflow Google Chat App erstellen, die natürliche Sprache versteht.
   Slash-Befehle	Optional. Befehle, die Nutzern in Google Chat angezeigt werden können. Damit können Nutzer die wichtigsten Aktionen für Ihre Chat App in Google Chat sehen und eine bestimmte Aktion auswählen, mit der sie interagieren möchten. Weitere Informationen finden Sie unter Als Chat-App auf Slash-Befehle reagieren.
   Linkvorschauen	Optional. URL-Muster, die die Chat App erkennt und zusätzliche Inhalte bereitstellt, wenn Nutzer Links senden. Weitere Informationen finden Sie unter Vorschaulinks.
   Sichtbarkeit	Optional. Bis zu fünf Personen oder eine oder mehrere Google-Gruppen, die Ihre Chat App sehen und installieren können. Verwenden Sie dieses Feld, um Ihre Chat App zu testen oder die Chat App für Ihr Team freizugeben. Weitere Informationen finden Sie unter Interaktive Funktionen testen.

3. Klicken Sie auf Speichern. Wenn Sie die Chat App speichern ist Ihre Chat-App für den Nutzer verfügbar, Nutzer in Ihrer Google Workspace-Organisation.

Ihre Chat-App ist jetzt für den Empfang von Interaktionen konfiguriert aus Google Chat.

HTTP-Aufrufwiederholungen an den Dienst verarbeiten

Wenn eine HTTPS-Anfrage an Ihren Dienst fehlschlägt, z. B. bei einer Zeitüberschreitung, Fehler oder HTTPS-Statuscode, der nicht 2xx ist, versucht Google Chat möglicherweise, die Zustellung innerhalb weniger Minuten ausführen (dies ist jedoch nicht garantiert). Aus diesem Grund Die Chat-App empfängt dieselbe Nachricht möglicherweise mehrmals in in bestimmten Situationen. Wenn die Anfrage erfolgreich abgeschlossen wurde, aber eine ungültige verwendet, wiederholt Google Chat die Anfrage nicht.

Interaktionsereignisse verarbeiten oder darauf reagieren

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

Nachdem Ihre Chat-App ein Interaktionsereignis von Google Chat können sie auf viele verschiedene Arten antworten. In vielen Fällen sind interaktive Chat-Apps antworten dem Nutzer mit einer Nachricht. Die Google Chat App kann auch einige Informationen aus einer Datenabfrage oder Interaktionsereignisinformationen aufzeichnen. Durch dieses Verarbeitungsverhalten wird im Wesentlichen Google Chat App.

Um synchron zu antworten, muss eine Chat-App antworten und die Antwort muss in dem Bereich gepostet werden, Interaktion aufgetreten ist. Andernfalls kann die Chat-App asynchron antworten.

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

Das folgende Diagramm zeigt, Die Google Chat App verarbeitet in der Regel verschiedene Arten von Interaktionsereignisse:

In Echtzeit antworten

Mit Interaktionsereignissen können Chat-Apps in Echtzeit antworten synchronisiert werden. Für synchrone Antworten ist keine authentication festlegen.

Auf den Beitritt zu einem Gruppenbereich antworten

In diesem Beispiel erstellt und sendet Ihre Chat-App eine Textnachricht wenn es einem Gruppenbereich hinzugefügt wird. Um mehr über Best Practices für finden Sie unter Stellen Sie Nutzern die Chat App vor.

So senden Sie eine SMS, wenn ein Nutzer Ihre Chat-App hinzufügt: in einem Gruppenbereich, Ihrer Chat-App antwortet auf ADDED_TO_SPACE interaction event (Interaktionsereignis). Um auf ADDED_TO_SPACE-Interaktionsereignisse. Verwenden Sie dazu den folgenden Code:

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} req The event object from Chat API.
 * @param {Object} res The response object from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
exports.onMessage = function onMessage(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    res.send(
      'Hello! This function is meant to be used in a Google Chat space.');
  }

  // Send an onboarding message when added to a Chat space
  if (req.body.type === 'ADDED_TO_SPACE') {
    res.json({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar
      from Google Chat. Take a look at your schedule today by typing
      `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To
      learn what else I can do, type `/help`.'
    });
  }
};

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
function onAddToSpace(event) {

  return {
    'text': 'Hi, Cymbal at your service. I help you manage your calendar
    from Google Chat. Take a look at your schedule today by typing
    `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn
    what else I can do, type `/help`.'
  }
}

Im Codebeispiel wird die folgende Textnachricht zurückgegeben:

Weitere Beispiele für das Reagieren auf Interaktionen

So erstellen Sie synchrone Antworten auf Interaktionsereignisse: Anleitungen:

• Slash-Befehle einrichten
• Interaktive Dialogfelder öffnen
• Vorschaulinks
• Von Nutzern eingereichte Informationen verarbeiten

Asynchron antworten

Manchmal müssen Chat-Apps auch nach 30 Tagen auf ein Interaktionsereignis reagieren Sekunden oder Aufgaben außerhalb des Bereichs ausführen, in dem das Interaktionsereignis stattgefunden hat generiert. Eine Chat-App muss z. B. der Nutzenden antworten, nachdem sie eine lang andauernde Aufgabe abgeschlossen haben. In diesem Fall Chat-Apps können durch Aufrufen der Google Chat API asynchron antworten.

Informationen zum Erstellen einer Nachricht mit der Chat API finden Sie unter Schreiben Sie eine Nachricht. Anleitungen zur Verwendung weitere Chat API-Methoden finden Sie in der Übersicht über die Chat API

Weitere Informationen

• Nachricht senden
• Interaktive Dialogfelder öffnen
• Vorschaulinks
• Von Nutzern eingegebene Formulardaten auf Karten lesen
• Auf Slash-Befehle reagieren
• Startseite für eine Chat-App erstellen
• Anfragen von Google Chat bestätigen
• Interaktive Funktionen für Google Chat-Apps testen