Auf dieser Seite wird beschrieben, wie Ihre Chat-App Dialogfelder öffnen kann, um auf Nutzer zu reagieren.
Dialogfelder sind kartenbasierte Benutzeroberflächen, die über einen Chatbereich oder eine Nachricht geöffnet werden. Das Dialogfeld und sein Inhalt sind nur für den Nutzer sichtbar, der es geöffnet hat.
Chat-Apps können Dialogfelder verwenden, um Informationen von Google Chat-Nutzern anzufordern und zu erheben, einschließlich mehrstufiger Formulare. Weitere Informationen zum Erstellen von Formularinputs finden Sie unter Informationen von Nutzern erheben und verarbeiten.
Vorbereitung
Node.js
Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Führen Sie diese Kurzanleitung aus, um eine interaktive Chat-App mit einem HTTP-Dienst zu erstellen.
Python
Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Führen Sie diese Kurzanleitung aus, um eine interaktive Chat-App mit einem HTTP-Dienst zu erstellen.
Java
Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App mit einem HTTP-Dienst erstellen möchten, folgen Sie dieser Kurzanleitung.
Apps Script
Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Folgen Sie dieser Kurzanleitung, um eine interaktive Chat-App in Apps Script zu erstellen.
Dialogfeld öffnen
In diesem Abschnitt wird erläutert, wie Sie auf die Anfragen reagieren und einen Dialog einrichten:
- Dialoganfrage über eine Nutzerinteraktion auslösen
- Verarbeiten Sie die Anfrage, indem Sie ein Dialogfeld zurückgeben und öffnen.
- Nachdem Nutzer Informationen gesendet haben, verarbeiten Sie die Einreichung, indem Sie entweder das Dialogfeld schließen oder ein anderes Dialogfeld zurückgeben.
Dialoganfrage auslösen
Eine Chat-App kann nur Dialogfelder öffnen, um auf eine Nutzerinteraktion zu reagieren, z. B. auf einen Slash-Befehl oder einen Schaltflächenklick aus einer Nachricht in einer Karte.
Um Nutzern mit einem Dialogfeld zu antworten, muss eine Chat-App eine Interaktion erstellen, die die Dialoganfrage auslöst, z. B.:
- Auf einen Slash-Befehl antworten. Wenn du die Anfrage über einen Befehl mit einem Schrägstrich auslösen möchtest, musst du beim Konfigurieren des Befehls das Kästchen Öffnet ein Dialogfeld aktivieren.
- Sie können auf einen Schaltflächenklick in einer Nachricht reagieren, entweder als Teil einer Karte oder unten in der Nachricht. Wenn Sie die Anfrage über eine Schaltfläche in einer Nachricht auslösen möchten, konfigurieren Sie die
onClick
-Aktion der Schaltfläche, indem Sie ihreinteraction
aufOPEN_DIALOG
festlegen. - Auf einen Klick auf eine Schaltfläche auf der Startseite der Google Chat App reagieren Informationen zum Öffnen von Dialogfeldern über Startseiten finden Sie unter Startseite für die Google Chat App erstellen.
Das folgende Codebeispiel zeigt, wie eine Dialoganfrage über eine Schaltfläche in einer Kartennachricht ausgelöst wird. Um das Dialogfeld zu öffnen, muss das Feld button.interaction
auf OPEN_DIALOG
gesetzt sein:
Node.js
Python
Java
Apps Script
In diesem Beispiel wird eine Kartennachricht gesendet, indem Karten-JSON zurückgegeben wird. Sie können auch den Kartendienst von Apps Script verwenden.
Erstes Dialogfeld öffnen
Wenn ein Nutzer eine Dialoganfrage auslöst, empfängt Ihre Chat-App ein Interaktionsereignis, das in der Chat API als event
-Typ dargestellt wird. Wenn die Interaktion eine Dialoganfrage auslöst, wird das Feld dialogEventType
des Ereignisses auf REQUEST_DIALOG
gesetzt.
Um ein Dialogfeld zu öffnen, kann Ihre Chat-App auf die Anfrage antworten, indem sie ein actionResponse
-Objekt zurückgibt, bei dem type
auf DIALOG
und Message
festgelegt ist. Fügen Sie die folgenden Objekte hinzu, um den Inhalt des Dialogfelds anzugeben:
- Ein
actionResponse
-Objekt, dessentype
aufDIALOG
festgelegt ist - Ein
dialogAction
-Objekt. Das Feldbody
enthält die UI-Elemente, die auf der Karte angezeigt werden sollen, einschließlich eines oder mehrerersections
-Widgets. Wenn Sie Informationen von Nutzern erfassen möchten, können Sie Formulareingabe-Widgets und ein Schaltflächen-Widget angeben. Weitere Informationen zum Entwerfen von Formulareingaben finden Sie unter Informationen von Nutzern erfassen und verarbeiten.
Das folgende Codebeispiel zeigt, wie eine Chat-App eine Antwort zurückgibt, die ein Dialogfeld öffnet:
Node.js
Python
Java
Apps Script
In diesem Beispiel wird eine Kartennachricht gesendet, indem Karten-JSON zurückgegeben wird. Sie können auch den Apps Script-Kartendienst verwenden.
Übermitteln des Dialogfelds verarbeiten
Wenn Nutzer auf eine Schaltfläche zum Senden eines Dialogfelds klicken, empfängt Ihre Chat-App ein CARD_CLICKED
-Interaktionsereignis, wobei dialogEventType
den Wert SUBMIT_DIALOG
hat.
Ihre Chat-App muss das Interaktionsereignis auf eine der folgenden Arten verarbeiten:
- Rufen Sie ein weiteres Dialogfeld auf, um eine weitere Karte oder ein weiteres Formular auszufüllen.
- Schließen Sie das Dialogfeld, nachdem Sie die vom Nutzer gesendeten Daten überprüft haben, und senden Sie optional eine Bestätigungsnachricht.
Optional: Weiteres Dialogfeld zurückgeben
Nachdem Nutzer den ersten Dialog gesendet haben, können Chat-Apps einen oder mehrere zusätzliche Dialoge zurückgeben, damit Nutzer Informationen vor dem Senden prüfen, mehrstufige Formulare ausfüllen oder Formularinhalte dynamisch ausfüllen können.
Die Chat-App verwendet das Objekt event.common.formInputs
, um die von Nutzern eingegebenen Daten zu verarbeiten. Weitere Informationen zum Abrufen von Werten aus Eingabe-Widgets finden Sie unter Informationen von Nutzern erfassen und verarbeiten.
Wenn Sie alle Daten im Blick behalten möchten, die Nutzer im ersten Dialogfeld eingeben, müssen Sie der Schaltfläche, über die das nächste Dialogfeld geöffnet wird, Parameter hinzufügen. Weitere Informationen finden Sie unter Daten auf eine andere Karte übertragen.
In diesem Beispiel öffnet eine Chat-App ein erstes Dialogfeld, das zu einem zweiten Dialogfeld zur Bestätigung führt, bevor die Eingabe gesendet wird:
Node.js
Python
Java
Apps Script
In diesem Beispiel wird eine Kartennachricht gesendet, indem Karten-JSON zurückgegeben wird. Sie können auch den Apps Script-Kartendienst verwenden.
Dialogfeld schließen
Wenn Nutzer auf eine Schaltfläche in einem Dialogfeld klicken, führt Ihre Chat-App die zugehörige Aktion aus und stellt dem Ereignisobjekt die folgenden Informationen zur Verfügung:
eventType
istCARD_CLICKED
.dialogEventType
istSUBMIT_DIALOG
.
Die Chat-App sollte ein ActionResponse
-Objekt zurückgeben, dessen type
auf DIALOG
und dialogAction
festgelegt ist.
Optional: Benachrichtigung anzeigen
Wenn Sie das Dialogfeld schließen, können Sie auch eine Textbenachrichtigung anzeigen.
Die Chat-App kann mit einer Erfolgs- oder Fehlerbenachrichtigung antworten. Dazu wird ein ActionResponse
zurückgegeben, für das actionStatus
festgelegt ist.
Im folgenden Beispiel wird geprüft, ob die Parameter gültig sind, und das Dialogfeld wird je nach Ergebnis mit einer Textbenachrichtigung geschlossen:
Node.js
Python
Java
Apps Script
In diesem Beispiel wird eine Kartennachricht gesendet, indem Karten-JSON zurückgegeben wird. Sie können auch den Kartendienst von Apps Script verwenden.
Weitere Informationen zum Übergeben von Parametern zwischen Dialogfeldern finden Sie unter Daten auf eine andere Karte übertragen.
Optional: Bestätigungsnachricht senden
Wenn Sie das Dialogfeld schließen, können Sie auch eine neue Nachricht senden oder eine vorhandene aktualisieren.
Wenn Sie eine neue Nachricht senden möchten, geben Sie ein ActionResponse
-Objekt zurück, in dem type
auf NEW_MESSAGE
gesetzt ist. Im folgenden Beispiel wird der Dialog mit einer Textbenachrichtigung und einer Bestätigungs-SMS geschlossen:
Node.js
Python
Java
Apps Script
In diesem Beispiel wird eine Kartennachricht gesendet, indem Karten-JSON zurückgegeben wird. Sie können auch den Kartendienst von Apps Script verwenden.
Um eine Nachricht zu aktualisieren, geben Sie ein actionResponse
-Objekt zurück, das die aktualisierte Nachricht enthält und für type
einen der folgenden Werte festlegt:
UPDATE_MESSAGE
: Aktualisiert die Nachricht, die die Dialoganfrage ausgelöst hat.UPDATE_USER_MESSAGE_CARDS
: Aktualisiert die Karte über eine Linkvorschau.
Fehlerbehebung
Wenn eine Google Chat-App oder -Karte einen Fehler zurückgibt, wird in der Chat-Oberfläche die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage konnte nicht verarbeitet werden“ Manchmal wird in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte führt zu einem unerwarteten Ergebnis. Beispielsweise wird möglicherweise keine Kartennachricht angezeigt.
Auch wenn in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, die Ihnen bei der Fehlerbehebung helfen, wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Informationen zum Ansehen, Debuggen und Beheben von Fehlern finden Sie unter Google Chat-Fehler beheben.
Weitere Informationen
- Beispiel für den Kontaktmanager ansehen – eine Chat-App, in der Kontaktdaten mithilfe von Dialogfeldern erfasst werden.
- Dialogfelder über die Startseite der Google Chat App öffnen
- Slash-Befehle einrichten und darauf reagieren
- Von Nutzern eingegebene Informationen verarbeiten