In diesem Dokument wird das Webhook-Format für die Kommunikation zwischen Actions on Google und einem Auftragsausführungsdienst beschrieben, der eine benutzerdefinierte dialogorientierte Benutzeroberfläche definiert.
Es ist wichtig zu verstehen, wie Actions on Google und die Auftragsausführung über die Webhook-Formate von Actions on Google kommunizieren:
- Für die Teilnahme an Unterhaltungen mit Actions on Google wird bei der Auftragsausführung ein Webhook implementiert, der auf HTTP-Anfragen von Actions on Google antworten kann.
- Wenn Nutzer die Aktion aufrufen, erhält die Auftragsausführung einen
HTTP POSTmit einer JSON-Nutzlast, die die Anfrage des Nutzers beschreibt. - Die Auftragsausführung wiederum ist dafür verantwortlich, die Parameter aus der Anfragenutzlast zu lesen, eine entsprechende JSON-formatierte Antwort zu generieren und mit dieser Antwort eine Antwort an Assistant zu senden.
Anfragetypen
In dieser Tabelle sind die Anfragetypen zusammengefasst, die der Webhook möglicherweise von Assistant erhält:
| Typ | Beschreibung | JSON-Beispiele |
|---|---|---|
| Aufrufanfragen | Nutzeräußerungen, die eine Unterhaltung mit Ihrer Auftragsausführung initiieren oder Deeplink-Aktionen auslösen (z. B. "Sprich mit Personal Chef, um Rezepte zum Abendessen zu finden").
|
|
| Unterhaltungsanfragen | Äußerungen von Nutzern in derselben Sitzung, nachdem die Unterhaltung mit der Auftragsausführung begonnen hat. Im Webhook-Format der Unterhaltung sind dies die unbearbeiteten Textantworten von Nutzern, die actions.intent.TEXT-Intents entsprechen, die Ihre Auftragsausführung in der vorherigen Runde angefordert hat. |
|
| Hilfsergebnisse | Anfragen, die von Assistant an Ihre Auftragsausführung gesendet werden, wenn der Webhook in der vorherigen Runde der Unterhaltung einen Helper-Intent angefordert hat, um Teile der Unterhaltung zu verarbeiten (z. B. actions.intent.OPTION und actions.intent.PERMISSION). |
Unterhaltungsanfragen und -antworten
In einem typischen Actions on Google-Interaktionsszenario führen Nutzer eine Wortgruppe zum Auslösen einer Aktion aus. Actions on Google sucht nach der Auftragsausführung, die der vom Nutzer aufgerufenen Aktion entspricht, und sendet die Anfrage dort, um eine Antwort zu senden.
Nachdem Actions on Google festgestellt hat, dass die Auftragsausführung dem Aufruf des Nutzers entspricht, wird eine Unterhaltung gestartet. Dazu wird eine HTTP-Anfrage mit einer JSON-Nutzlast mit den Anfrageinformationen des Nutzers an Ihren Auftragsausführungsendpunkt gesendet. Die Auftragsausführung parst die Anfrage und gibt eine Antwort mit einer JSON-Nutzlast zurück. Actions on Google wandelt die Nutzlast dann in gerenderte Sprach- und Multimedia-Ausgaben für Nutzer um.
Weitere Informationen zum Format der JSON-Nutzlast, wenn Actions on Google die Auftragsausführung über das Actions SDK aufruft, finden Sie unter Unterhaltungs-Webhook-Format.
Dialogflow-Anfragen und -Antworten
Wenn Sie Aktionen erstellen, können Sie optional Dialogflow verwenden, um die Erstellung von dialogorientierten Schnittstellen zu vereinfachen. In diesem Szenario fungiert Dialogflow als Proxy zwischen Actions on Google und Ihrer Auftragsausführung. Anstatt die HTTP/JSON-Anfrage direkt an den Auftragsausführungsendpunkt zu senden, wird sie von Actions on Google an Dialogflow gesendet.
Dialogflow fasst die in der ursprünglichen Anfrage enthaltene JSON-Nutzlast in das Dialogflow-Webhook-Format zusammen und leitet die resultierende Anfrage an die Dialogflow-Auftragsausführung weiter.
Umgekehrt muss die JSON-Nutzlast der Antwort dem Dialogflow-Webhook-Format entsprechen, wenn die Auftragsausführung eine Antwort an Dialogflow sendet. Die Auftragsausführung parst die Parameter aus der Dialogflow-JSON-Anfrage und generiert eine Antwort im Dialogflow-Webhook-Format. Dialogflow konvertiert die Antwort aus der Auftragsausführung in eine Antwortnachricht, die Assistant versteht.
Weitere Informationen zum Format der JSON-Nutzlast, wenn Actions on Google die Auftragsausführung über Dialogflow aufruft, finden Sie unter Dialogflow-Webhook-Format.