- HTTP-Anfrage
- Anfragetext
- Antworttext
- Handler
- Intent
- IntentParameterValue
- Szene
- SlotFillingStatus
- Slot
- SlotMode
- SlotStatus
- Prompt
- Einfach
- Inhalt
- Karte
- Bild
- ImageFill
- Link
- OpenUrl
- UrlHint
- Tabelle
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- Medien
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- Erfassung
- CollectionItem
- Liste
- ListItem
- CollectionBrowse (Sammlung durchsuchen)
- Element
- Vorschlag
- Canvas
- ContinuousMatchConfig
- ExpectedPhrase
- OrderUpdate (Bestellupdate)
- Typ
- Auftrag
- UserInfo
- PhoneNumber
- Bild
- Händler
- Standort
- LatLng
- PostalAddress
- Inhalt
- LineItem
- PriceAttribute
- Typ
- Bundesland
- Geld
- Aktion
- Typ
- OpenUrlAction
- AndroidApp
- VersionFilter
- UrlTypeHint
- ActionMetadata
- Offenlegung
- DisclosureText
- TextLink
- DisclosurePresentationOptions
- PresentationRequirement
- PurchaseItemExtension
- PurchaseStatus
- PurchaseType
- MerchantUnitMeasure
- Einheit
- PurchaseReturnsInfo
- PurchaseFulfillmentInfo
- Typ
- Zeit
- PickupInfo
- PickupType
- CurbsideInfo
- CurbsideFulfillmentType
- Fahrzeug
- CheckInInfo
- CheckInType
- ItemOption
- ProductDetails
- ReservationItemExtension
- ReservationStatus
- ReservationType
- StaffFacilitator
- PaymentData (Zahlungsdaten)
- PaymentResult
- PaymentInfo
- PaymentMethodDisplayInfo
- PaymentType
- PaymentMethodProvenance
- Angebot
- PurchaseOrderExtension.
- PurchaseLocationType
- PurchaseError.
- ErrorType
- TicketOrderExtension:
- TicketEvent
- Typ
- EventCharacter
- Typ
- UserNotification
- NextScene
- Sitzung
- TypeOverride
- TypeOverrideMode
- SynonymType
- Eintrag
- EntryDisplay (Einstiegsdisplay)
- Nutzer
- AccountLinkingStatus
- UserVerificationStatus
- Interaktion
- IntentSubscription
- PackageEntitlements
- Berechtigung
- SkuType
- SignedData
- Berechtigung
- Startseite
- Gerät
- Funktion
- Standort
- TimeZone
- Kontext
- MediaContext
- CanvasContext
- Erwartet
RPC, der die Auftragsausführungs-API darstellt
HTTP-Anfrage
POST https://webhook_handler_service.googleapis.com/fulfill
Die URL verwendet die Syntax der gRPC-Transcodierung.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung | |
---|---|
{ "handler": { object ( |
Felder | |
---|---|
handler |
Erforderlich. Informationen zur Verarbeitung der Anfrage für die Auftragsausführung. Beispielsweise kann eine Anfrage mit dem Ziel, Informationen abzurufen, einen Handler mit dem Namen "getFact" haben. |
intent |
Erforderlich. Stellt den zuletzt zugeordneten Intent dar. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/intents. |
scene |
Optional. Informationen zur aktuellen und nächsten Szene beim Aufruf der Funktion. Wird ausgefüllt, wenn der Aufruf zur Auftragsausführung im Rahmen einer Szene erfolgt. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/scenes. |
session |
Erforderlich. Enthält Sitzungsdaten wie die Sitzungs-ID und Sitzungsparameter. |
user |
Erforderlich. Nutzer, der die Unterhaltung gestartet hat |
home |
Optional. Informationen zur HomeGraph-Struktur, zu der das Zielgerät gehört. Weitere Informationen finden Sie unter https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
Erforderlich. Informationen zu dem Gerät, das der Nutzer für die Interaktion mit der Aktion verwendet. |
context |
Optional. Informationen zum aktuellen Kontext der Anfrage. Umfasst unter anderem Informationen zu aktiven Mediensitzungen oder Canvas-Informationen. |
Antworttext
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Stellt eine Antwort dar, die von der Auftragsausführung eines Entwicklers an Actions on Google gesendet wird.
JSON-Darstellung | |
---|---|
{ "prompt": { object ( |
Felder | |
---|---|
prompt |
Optional. Stellt Aufforderungen dar, die an den Nutzer gesendet werden sollen. Diese Aufforderungen werden an zuvor hinzugefügte Nachrichten angehängt, sofern sie nicht explizit überschrieben werden. |
scene |
Optional. Stellt die aktuelle und nächste Szene dar. Wenn |
session |
Optional. Beschreibt Daten für die aktuelle Sitzung. Sitzungsparameter können von der Auftragsausführung erstellt, aktualisiert oder entfernt werden. |
user |
Optional. Wird verwendet, um Nutzerparameter anzugeben, die zurückgesendet werden sollen. |
home |
Optional. Wird verwendet, um Parameter für die HomeGraph-Struktur anzugeben, zu der das Zielgerät gehört. Weitere Informationen finden Sie unter https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
Optional. Damit kannst du zwischen Assistant-Geräten wechseln, auf die der Nutzer Zugriff hat. |
expected |
Optional. Beschreibt die Erwartungen an den nächsten Dialog. |
Handler
Stellt einen Auftragsausführungs-Handler dar, der Ereignisinformationen von Actions on Google der Auftragsausführung zuordnet. Ermitteln Sie anhand des Handler-Namens, welchen Code Sie in der Auftragsausführung ausführen sollten. Ein Handler kann beispielsweise verwendet werden, um Informationen über die Bestellinformationen eines Nutzers mit einem Handler-Namen wie "OrderLookup" abzurufen, während ein anderer Produktinformationen aus einer Datenbank mit einem Handler-Namen wie "GetProductInfo" abruft.
JSON-Darstellung | |
---|---|
{ "name": string } |
Felder | |
---|---|
name |
Optional. Der Name des Handlers. |
Absicht
Stellt einen Intent dar. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/intents.
JSON-Darstellung | |
---|---|
{
"name": string,
"params": {
string: {
object ( |
Felder | |
---|---|
name |
Erforderlich. Der Name des zuletzt zugeordneten Intents. |
params |
Erforderlich. Stellt Parameter dar, die im Rahmen des Intent-Abgleichs identifiziert werden. Dies ist eine Zuordnung des Namens des identifizierten Parameters zum Wert des Parameters, der aus der Nutzereingabe identifiziert wurde. Alle Parameter, die im übereinstimmenden Intent definiert und identifiziert werden, werden hier angezeigt. Ein Objekt, das eine Liste von |
query |
Optional. Eingabe- oder gesprochene Eingabe des Endnutzers, der mit diesem Intent übereinstimmt. Dieses Feld wird ausgefüllt, wenn ein Intent basierend auf der Nutzereingabe zugeordnet wird. |
IntentParameterValue
Stellt einen Wert für einen Intent-Parameter dar. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/types.
JSON-Darstellung | |
---|---|
{ "original": string, "resolved": value } |
Felder | |
---|---|
original |
Erforderlich. Ursprünglicher Textwert, der aus der Äußerung des Nutzers extrahiert wurde. |
resolved |
Erforderlich. Strukturierter Wert für Parameter, der aus der Nutzereingabe extrahiert wurde. Dieses Feld wird nur ausgefüllt, wenn der Parameter im zugeordneten Intent definiert ist und der Wert des Parameters beim Intent-Abgleich identifiziert werden konnte. |
Ambiente
Stellen Sie eine Szene dar. Szenen können die Auftragsausführung aufrufen, Aufforderungen hinzufügen und Slotwerte vom Nutzer erfassen. Szenen werden durch Ereignisse oder Intents ausgelöst und können Ereignisse auslösen und Intents mit dem Übergang zu anderen Szenen verknüpfen.
JSON-Darstellung | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
Felder | |
---|---|
name |
Erforderlich. Name der aktuellen Szene. |
slotFillingStatus |
Erforderlich. Der aktuelle Status der Slot-Füllung. Dieses Feld ist schreibgeschützt. |
slots |
Die Slots, die der aktuellen Szene zugewiesen sind. Handler-Antworten können keine Slots zurückgeben, die nicht in der Anfrage gesendet wurden. Ein Objekt, das eine Liste von |
next |
Optional. Informationen zur Szene, die als Nächstes hingenommen werden soll. |
SlotFillingStatus
Gibt den aktuellen Status der Slot-Füllung an.
Enums | |
---|---|
UNSPECIFIED |
Fallback-Wert, wenn das Feld für die Nutzung nicht ausgefüllt ist. |
INITIALIZED |
Die Slots wurden initialisiert, aber die Slot-Füllung wurde nicht gestartet. |
COLLECTING |
Die Slotwerte werden erfasst. |
FINAL |
Alle Slotwerte sind endgültig und können nicht geändert werden. |
Slot
Stellt einen Slot dar.
JSON-Darstellung | |
---|---|
{ "mode": enum ( |
Felder | |
---|---|
mode |
Der Modus der Anzeigenfläche (erforderlich oder optional). Kann vom Entwickler festgelegt werden. |
status |
Der Status der Anzeigenfläche. |
value |
Der Wert der Anzeigenfläche. Wenn Sie diesen Wert in der Antwort ändern, wird auch der Wert in der Slot-Füllung geändert. |
updated |
Gibt an, ob der Slotwert in der letzten Abzweigung erfasst wurde. Dieses Feld ist schreibgeschützt. |
prompt |
Optional. Diese Aufforderung wird an den Nutzer gesendet, wenn er eine erforderliche Anzeigenfläche füllen muss. Diese Eingabeaufforderung überschreibt die vorhandene Eingabeaufforderung, die in der Konsole definiert ist. Dieses Feld ist nicht in der Webhook-Anfrage enthalten. |
SlotMode
Stellt den Modus eines Slots dar, d. h., ob er erforderlich ist oder nicht.
Enums | |
---|---|
MODE_UNSPECIFIED |
Fallback-Wert, wenn das Feld für die Nutzung nicht ausgefüllt ist. |
OPTIONAL |
Gibt an, dass der Slot nicht erforderlich ist, um die Slot-Füllung abzuschließen. |
REQUIRED |
Gibt an, dass der Slot erforderlich ist, um die Slot-Füllung abzuschließen. |
SlotStatus
Stellt den Status eines Slots dar.
Enums | |
---|---|
SLOT_UNSPECIFIED |
Fallback-Wert, wenn das Feld für die Nutzung nicht ausgefüllt ist. |
EMPTY |
Gibt an, dass der Slot keine Werte hat. Dieser Status kann nicht über die Antwort geändert werden. |
INVALID |
Gibt an, dass der Slotwert ungültig ist. Dieser Status kann über die Antwort festgelegt werden. |
FILLED |
Gibt an, dass der Slot einen Wert hat. Dieser Status kann nicht über die Antwort geändert werden. |
Eingabeaufforderung
Eine Antwort an einen Nutzer darstellen. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts.
JSON-Darstellung | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
Felder | |
---|---|
override |
Optional. Modus für die Zusammenführung dieser Nachrichten mit zuvor definierten Nachrichten. „true“ löscht alle zuvor definierten Nachrichten (erste und letzte einfache, Inhalt, Link und Canvas mit Vorschlägen) und fügt Nachrichten hinzu, die in diesem Prompt definiert wurden. Bei „false“ werden die in diesem Prompt definierten Nachrichten den Nachrichten hinzugefügt, die in den vorherigen Antworten definiert wurden. Wenn Sie dieses Feld auf „false“ belassen, können Daten auch an einige Felder in den einfachen Prompts, der Vorschlagsaufforderung und dem Canvas-Prompt (Teil der Inhaltsaufforderung) angehängt werden. Die Inhalts- und Linkmeldungen werden immer überschrieben, wenn sie in der Eingabeaufforderung definiert sind. Der Standardwert ist „false“. |
firstSimple |
Optional. Die erste Sprach- und Textantwort. |
content |
Optional. Dem Nutzer angezeigte Inhalte wie Karten, Listen oder Medien. |
lastSimple |
Optional. Die letzte Antwort per Sprach- oder Texteingabe. |
suggestions[] |
Optional. Vorschläge, die dem Nutzer immer am Ende der Antwort angezeigt werden. Wenn das Feld „override“ in der zugehörigen Aufforderung „false“ ist, werden die in diesem Feld definierten Titel den Titeln hinzugefügt, die in den zuvor definierten Vorschlägen für Vorschläge definiert wurden. Doppelte Werte werden entfernt. |
link |
Optional. Ein zusätzlicher Vorschlags-Chip, der auf die verknüpfte App oder Website verweist. Der Chip wird mit dem Titel „Offen (Name)“ gerendert. Maximal 20 Zeichen |
canvas |
Optional. Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. |
orderUpdate |
Die optionale Aktion antwortet mit einer OrderUpdate, nachdem sie die Bestellung während des Transaktionsablaufs erhalten hat. Nach Erhalt dieser Informationen zeichnet Google diese Aktualisierung der Bestellung auf. Ist der Vorgang erfolgreich, wird eine Belegkarte zusammen mit der Sprachausgabe angezeigt, die auf Anzeigegeräten gesendet wird. |
Einfach
Stellt eine einfache Aufforderung dar, die an einen Nutzer gesendet werden soll. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-simple.
JSON-Darstellung | |
---|---|
{ "speech": string, "text": string } |
Felder | |
---|---|
speech |
Optional. Stellt die Sprache dar, die für den Nutzer gesprochen wird. Kann SSML oder Text-to-Speech sein. Wenn das Feld „override“ in der zugehörigen Aufforderung „true“ ist, ersetzt die in diesem Feld definierte Sprache die Sprache der vorherigen einfachen Aufforderung. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/ssml. |
text |
Optionaler Text, der im Chat-Infofeld angezeigt wird. Wenn nicht angegeben, wird das obige Sprachfeld angezeigt. Auf 640 Zeichen begrenzt. Wenn das Feld „Überschreiben“ in der zugehörigen Aufforderung „true“ ist, wird der in diesem Feld definierte Text durch den Text der vorherigen einfachen Aufforderung ersetzt. |
Inhalte
Containerobjekt für umfangreiche Prompts oder Auswahlaufforderungen.
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld Für |
||
card |
Eine einfache Karte. |
|
image |
Ein Bild. |
|
table |
Tabellenkarte. |
|
media |
Antwort, die eine Reihe von Medien angibt, die wiedergegeben werden sollen. |
|
collection |
Eine Karte mit einer Reihe von Optionen, aus denen Sie auswählen können. |
|
list |
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann. |
|
collectionBrowse |
Eine Karte mit mehreren Webseiten, die geöffnet werden sollen. |
Infokarte
Eine einfache Karte zur Anzeige einiger Informationen, z.B. ein Bild und/oder Text. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-rich#basic_card.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Felder | |
---|---|
title |
Gesamttitel der Karte. Optional. |
subtitle |
Optional. |
text |
Text der Karte Unterstützt eine begrenzte Anzahl von Markdown-Syntax für die Formatierung. Erforderlich, sofern kein Bild vorhanden ist. |
image |
Ein Hero-Image für die Karte. Die Höhe ist auf 192 dp festgelegt. Optional. |
imageFill |
Legt fest, wie der Bildhintergrund ausgefüllt wird. Optional. |
button |
Schaltfläche mit einem externen Link. Optional. |
Bild
Ein Bild, das auf der Karte angezeigt wird. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-rich#image-cards.
JSON-Darstellung | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Felder | |
---|---|
url |
Die Quell-URL des Bildes. Bilder können das Format JPG, PNG und GIF haben (animiert und nicht animiert). Beispiel: |
alt |
Eine Textbeschreibung des Bildes, die für Barrierefreiheit verwendet werden soll, z.B. Screenreader. Erforderlich. |
height |
Die Höhe des Bilds in Pixeln Optional. |
width |
Die Breite des Bilds in Pixeln Optional. |
ImageFill
Mögliche Bildanzeigeoptionen, die die Darstellung des Bildes beeinflussen können. Diese Option sollte verwendet werden, wenn das Seitenverhältnis des Bildes nicht mit dem des Bildcontainers übereinstimmt.
Enums | |
---|---|
UNSPECIFIED |
|
GRAY |
Füllen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit grauen Balken. |
WHITE |
Füllen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit weißen Balken. |
CROPPED |
Das Bild wird so skaliert, dass die Breite und Höhe des Bilds den Abmessungen des Containers entsprechen oder diese überschreiten. Dadurch wird möglicherweise der obere und untere Bereich des Bildes abgeschnitten, wenn die skalierte Bildhöhe größer als die Containerhöhe ist. Wenn die skalierte Bildbreite größer als die Containerbreite ist, wird die linke und rechte Bildbreite abgeschnitten. Dies ähnelt dem „Zoommodus“ auf einem Breitbildfernseher bei der Wiedergabe eines 4:3-Videos. |
Link
Ein zusätzlicher Vorschlags-Chip, der auf die verknüpfte App oder Website verweist. Der Chip wird mit dem Titel „Offen (Name)“ gerendert.
JSON-Darstellung | |
---|---|
{
"name": string,
"open": {
object ( |
Felder | |
---|---|
name |
Name der Verknüpfung. Maximal 20 Zeichen. |
open |
Was passiert, wenn ein Nutzer den Link öffnet? |
OpenUrl
JSON-Darstellung | |
---|---|
{
"url": string,
"hint": enum ( |
Felder | |
---|---|
url |
Das URL-Feld, das einen der folgenden Werte annehmen kann: – HTTP- oder HTTPS-URLs zum Öffnen einer mit der App verknüpften App oder einer Webseite |
hint |
Gibt einen Hinweis für den URL-Typ an. |
UrlHint
Verschiedene Arten von URL-Hinweisen.
Enums | |
---|---|
LINK_UNSPECIFIED |
Ohne Angabe |
AMP |
URL, die direkt auf AMP-Inhalte verweist, oder auf eine kanonische URL, die über auf AMP-Inhalte verweist. Weitere Informationen finden Sie unter https://amp.dev/. |
Tabelle
Eine Tabellenkarte zum Anzeigen einer Tabelle mit Text. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-rich#table_cards.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Felder | |
---|---|
title |
Gesamttitel der Tabelle. Optional, muss jedoch festgelegt werden, wenn Untertitel angegeben wurden. |
subtitle |
Untertitel für die Tabelle. Optional. |
image |
Mit der Tabelle verknüpftes Bild. Optional. |
columns[] |
Überschriften und Spaltenausrichtung. |
rows[] |
Zeilendaten der Tabelle Die ersten 3 Zeilen werden garantiert angezeigt, aber andere werden auf bestimmten Oberflächen möglicherweise ausgeschnitten. Testen Sie mit dem Simulator, welche Zeilen für eine bestimmte Oberfläche angezeigt werden. Auf Oberflächen, die die WEB_BROWSER-Funktion unterstützen, können Sie den Nutzer auf eine Webseite mit mehr Daten verweisen. |
button |
Schaltfläche. |
TableColumn
JSON-Darstellung | |
---|---|
{
"header": string,
"align": enum ( |
Felder | |
---|---|
header |
Überschrift der Spalte. |
align |
Horizontale Ausrichtung des Inhalts in der Spalte „Richtig“. Wenn kein Wert angegeben ist, wird der Inhalt an der obersten Kante ausgerichtet. |
HorizontalAlignment
Die Ausrichtung des Inhalts innerhalb der Zelle.
Enums | |
---|---|
UNSPECIFIED |
|
LEADING |
Führende Kante der Zelle Das ist die Standardeinstellung. |
CENTER |
Der Inhalt ist an der Spaltenmitte ausgerichtet. |
TRAILING |
Der Inhalt ist am unteren Rand der Spalte ausgerichtet. |
TableRow
Beschreibt eine Zeile in der Tabelle.
JSON-Darstellung | |
---|---|
{
"cells": [
{
object ( |
Felder | |
---|---|
cells[] |
Zellen in dieser Zeile. Die ersten 3 Zellen werden garantiert angezeigt, andere werden jedoch möglicherweise auf bestimmten Oberflächen ausgeschnitten. Testen Sie mit dem Simulator, welche Zellen für eine bestimmte Oberfläche angezeigt werden. |
divider |
Gibt an, ob nach jeder Zeile eine Trennlinie eingefügt werden soll. |
TableCell
Beschreibt eine Zelle in einer Zeile.
JSON-Darstellung | |
---|---|
{ "text": string } |
Felder | |
---|---|
text |
Textinhalt der Zelle |
Medien
Stellt ein Medienobjekt dar. Enthält Informationen zu den Medien, z. B. Name, Beschreibung und URL. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-media.
JSON-Darstellung | |
---|---|
{ "mediaType": enum ( |
Felder | |
---|---|
mediaType |
|
startOffset |
Startversatz des ersten Medienobjekts. Dauer in Sekunden mit bis zu neun Nachkommastellen und einem ' |
optionalMediaControls[] |
Optionale Arten der Mediensteuerung, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, erfolgt bei einem bestimmten Medienereignis die Anfrage an 15:00 Uhr. Wenn die Richtlinie nicht konfiguriert ist, muss Drittanbieter immer noch zwei Standardsteuerungstypen verarbeiten: FINISHED und FAILED. |
mediaObjects[] |
Liste der Medienobjekte |
repeatMode |
Wiederholungsmodus für die Liste der Medienobjekte. |
firstMediaObjectIndex |
Der 0-basierte Index des ersten Medienobjekts in „mediaObjects“, das wiedergegeben werden soll. Wenn nicht angegeben, null oder außerhalb der Grenzen, beginnt die Wiedergabe beim ersten Medienobjekt in „mediaObjects“. |
MediaType
Medientyp dieser Antwort.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
|
AUDIO |
Audiodatei. |
MEDIA_STATUS_ACK |
Antwort zur Bestätigung eines Medienstatusberichts. |
OptionalMediaControls
Optionale Arten der Mediensteuerung, die von der Medienantwort unterstützt werden
Enums | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Nicht angegebener Wert |
PAUSED |
Ereignis pausiert. Wird ausgelöst, wenn der Nutzer die Medien pausiert |
STOPPED |
Termin beendet. Wird ausgelöst, wenn der Nutzer die 3P-Sitzung während der Medienwiedergabe verlässt. |
MediaObject
Stellt ein einzelnes Medienobjekt dar
JSON-Darstellung | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Felder | |
---|---|
name |
Name dieses Medienobjekts. |
description |
Beschreibung dieses Medienobjekts. |
url |
Die URL, die auf den Medieninhalt verweist MP3-Dateien müssen auf einem Webserver gehostet und über eine HTTPS-URL öffentlich verfügbar sein. Livestreaming wird nur im MP3-Format unterstützt. |
image |
Bild, das mit der Medienkarte angezeigt wird. |
MediaImage
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld Für |
||
large |
Ein großes Bild wie das Cover des Albums usw. |
|
icon |
Ein kleines Bildsymbol, das rechts neben dem Titel angezeigt wird. Die Größe wird auf 36 × 36 dp angepasst. |
RepeatMode
Die Typen des Wiederholungsmodus für eine Liste von Medienobjekten.
Enums | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Entspricht AUS. |
OFF |
Mediensitzung am Ende des letzten Medienobjekts beenden. |
ALL |
Schleife zum Anfang des ersten Medienobjekts, wenn das Ende des letzten Medienobjekts erreicht ist. |
Sammlung
Eine Karte mit einer Reihe von Optionen, aus denen ausgewählt werden kann. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-selection#collection.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Felder | |
---|---|
title |
Titel der Sammlung Optional. |
subtitle |
Untertitel der Sammlung Optional. |
items[] |
Eine Liste von Elementen. Er darf mindestens 2 und maximal 10 haben. |
imageFill |
Legt fest, wie die Bildhintergründe von Sammlungselementen ausgefüllt werden. Optional. |
CollectionItem
Ein Element in der Sammlung
JSON-Darstellung | |
---|---|
{ "key": string } |
Felder | |
---|---|
key |
Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Zugangscodes im verknüpften Typ übereinstimmt. |
Liste
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-selection#list.
JSON-Darstellung | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Felder | |
---|---|
title |
Titel der Liste. Optional. |
subtitle |
Untertitel der Liste. Optional. |
items[] |
Eine Liste von Elementen. Sie kann einen Mindestwert von 2 und einen Höchstwert von 30 haben. |
ListItem
Ein Element in der Liste
JSON-Darstellung | |
---|---|
{ "key": string } |
Felder | |
---|---|
key |
Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Zugangscodes im verknüpften Typ übereinstimmt. |
CollectionBrowse
Stellt eine Reihe von Webdokumenten als eine Sammlung großer Kacheln dar. Sie können Elemente auswählen, um das zugehörige Webdokument in einem Web Viewer zu öffnen. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.
JSON-Darstellung | |
---|---|
{ "items": [ { object ( |
Felder | |
---|---|
items[] |
Eine Liste von Elementen. Er darf mindestens 2 und maximal 10 haben. |
imageFill |
Art der Bildanzeigeoption. |
Element
Element in der Sammlung.
JSON-Darstellung | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Felder | |
---|---|
title |
Erforderlich. Titel des Sammlungselements |
description |
Beschreibung des Sammlungselements |
footer |
Fußzeilentext für das Sammlungselement, angezeigt unter der Beschreibung. Einzelne Textzeile, durch Auslassungspunkte abgeschnitten. |
image |
Bild für das Sammlungselement. |
openUriAction |
Erforderlich. URI, der geöffnet werden soll, wenn das Element ausgewählt wurde. |
Vorschlag
Vorschläge bieten Nutzern auf Display-fähigen Geräten Chips für Vorschläge, wenn Assistant die Aufforderung anzeigt. Verwenden Sie Vorschlags-Chips, um Nutzerantworten zu kennzeichnen und die Unterhaltung fortzusetzen oder neu auszurichten. Wenn Sie darauf tippen, wird der angezeigte Text wortgetreu an die Unterhaltung zurückgegeben, so als ob der Nutzer ihn eingegeben hätte. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts#suggestions.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Erforderlich. Der Text im Vorschlags-Chip. Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel darf unter den Vorschlags-Chips nur einmal vorkommen. Maximal 25 Zeichen |
Canvas
Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. Dies kann zusammen mit dem Feld „firstSimple“ in der zugehörigen Aufforderung verwendet werden, um mit dem Nutzer zu sprechen und zusätzlich eine interaktive Canvas-Antwort anzuzeigen. Die maximale Größe der Antwort beträgt 50.000 Byte. Weitere Informationen finden Sie unter https://developers.google.com/assistant/interactivecanvas.
JSON-Darstellung | |
---|---|
{
"url": string,
"data": [
value
],
"suppressMic": boolean,
"continuousMatchConfig": {
object ( |
Felder | |
---|---|
url |
URL der interaktiven Canvas-Web-App, die geladen werden soll. Wenn die Richtlinie nicht konfiguriert ist, wird die URL des aktuellen aktiven Canvas wiederverwendet. |
data[] |
Optional. JSON-Daten, die als Ereignis an die Webseite mit dem immersiven Erlebnis übergeben werden. Wenn das Feld „Überschreiben“ im zugehörigen Prompt „false“ ist, werden die in diesem Canvas-Prompt definierten Datenwerte hinzugefügt, nachdem die Datenwerte aus den vorherigen Canvas-Prompts hinzugefügt wurden. |
suppressMic |
Optional. Standardwert: false. |
continuousMatchConfig |
Konfiguration zum Initiieren des kontinuierlichen Abgleichmodus. |
ContinuousMatchConfig
Konfiguration zum Initiieren des kontinuierlichen Abgleichmodus.
JSON-Darstellung | |
---|---|
{
"expectedPhrases": [
{
object ( |
Felder | |
---|---|
expectedPhrases[] |
Alle möglichen erwarteten Wortgruppen während dieser Sitzung im kontinuierlichen Abgleichmodus. |
durationSeconds |
Dauer, für die der kontinuierliche Abgleichmodus aktiviert bleibt. Falls angegeben, wird das Mikrofon bei Ablauf der Zeit deaktiviert. Der maximal zulässige Wert ist 180. |
ExpectedPhrase
JSON-Darstellung | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
Felder | |
---|---|
phrase |
Die passende Wortgruppe bei einer Sitzung im Modus „Kontinuierliche Übereinstimmung“ |
alternativePhrases[] |
Einige Wortgruppen werden vom Sprachmodell möglicherweise auch bei Sprachgewichtung falsch erkannt. So können Entwickler alternative Trigger für Homophone angeben. |
OrderUpdate
Aktualisieren Sie eine Bestellung.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Eingestellt: Verwende stattdessen „OrderUpdate.update_mask“. Wenn der Typ = SNAPSHOT lautet, sollte OrderUpdate.order die gesamte Bestellung sein. Wenn der Typ = ORDER_STATUS, entspricht dies der Statusänderung auf Auftragsebene. Nur „order.last_update_time“ und dieser Branchenstatus werden abgerufen. Hinweis: type.ORDER_STATUS unterstützt nur PurcahaseOrderExtension-Statusaktualisierungen. Es ist nicht geplant, diesen Support zu erweitern. Stattdessen empfehlen wir „updateMask“, da es allgemeiner und erweiterbar ist und für alle Branchen verwendet werden kann. |
order |
|
updateMask |
Hinweis: Für die folgenden Sonderfelder gibt es folgende Hinweise bzw. Empfehlungen: 1. order.last_update_time wird immer im Rahmen der Aktualisierungsanfrage aktualisiert. 2. order.create_time, order.google_order_id und order.merchant_order_id werden ignoriert, wenn sie als Teil von „updateMask“ bereitgestellt werden. Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: |
userNotification |
Wenn dieses Flag angegeben ist, wird dem Nutzer eine Benachrichtigung mit dem angegebenen Titel und Text angezeigt. Das Angeben einer Benachrichtigung ist ein Vorschlag für die Benachrichtigung und führt nicht zwangsläufig zu einer Benachrichtigung. |
reason |
Grund für die Änderung/Aktualisierung. |
Typ
Eingestellt: Verwende stattdessen „OrderUpdate.update_mask“. Aktualisierungen für einen Auftrag sind zulässig.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Typ nicht angegeben; sollte nicht explizit festgelegt werden. |
ORDER_STATUS |
Aktualisieren Sie nur den Status der Bestellung. |
SNAPSHOT |
Bestellübersicht aktualisieren. |
Bestellung
Auftragsentität. Hinweis: 1. Sofern nicht anders angegeben, müssen alle Strings auf allen Ebenen weniger als 1.000 Zeichen lang sein. 2. Sofern nicht anders angegeben, müssen alle wiederkehrenden Felder auf allen Ebenen kleiner als 50 sein. 3. Falls angegeben, müssen alle Zeitstempel auf allen Ebenen gültige Zeitstempel sein.
JSON-Darstellung | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
Felder | ||
---|---|---|
googleOrderId |
Von Google zugewiesene Bestell-ID. |
|
merchantOrderId |
Erforderlich: Dem Händler zugewiesene interne Bestell-ID. Diese ID muss eindeutig sein und ist für nachfolgende Aktualisierungen der Bestellung erforderlich. Diese ID kann auf die angegebene googleOrderId oder einen anderen eindeutigen Wert festgelegt werden. Beachten Sie, dass die ID, die Nutzern präsentiert wird, die uservisibleOrderId ist, bei der es sich möglicherweise um einen anderen, nutzerfreundlicheren Wert handelt. Die maximal zulässige Länge beträgt 128 Zeichen. |
|
userVisibleOrderId |
Die für den Nutzer sichtbare ID, die auf die aktuelle Bestellung verweist. Diese ID sollte mit der ID übereinstimmen, die in anderen Kontexten wie Websites, Apps und E-Mails für diese Bestellung angezeigt wird. |
|
userVisibleStateLabel |
Eingestellt: Verwenden Sie stattdessen den Status „OrderExtensions“. Für den Nutzer sichtbares Label für den Status dieser Bestellung. |
|
buyerInfo |
Informationen zum Käufer. |
|
image |
Mit der Bestellung verknüpftes Bild. |
|
createTime |
Erforderlich: Datum und Uhrzeit der Auftragserstellung. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
|
lastUpdateTime |
Datum und Uhrzeit der letzten Aktualisierung des Auftrags. Erforderlich für OrderUpdate. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
|
transactionMerchant |
Händler, der den Bezahlvorgang ermöglicht hat. Dieser kann sich von einem Anbieter auf Werbebuchungsebene unterscheiden. Beispiel: Expedia-Auftrag mit Werbebuchung von ANA |
|
contents |
Erforderlich: Auftragsinhalte, die eine Gruppe von Werbebuchungen sind. |
|
priceAttributes[] |
Preise, Rabatte, Steuern usw. |
|
followUpActions[] |
Folgeaktionen auf Auftragsebene. |
|
paymentData |
Zahlungsbezogene Daten für die Bestellung. |
|
termsOfServiceUrl |
Ein Link zu den Nutzungsbedingungen, die für die Bestellung/den vorgeschlagenen Auftrag gelten. |
|
note |
Notizen, die einer Bestellung zugeordnet sind. |
|
promotions[] |
Alle Werbeaktionen, die mit dieser Bestellung verknüpft sind. |
|
disclosures[] |
Offenlegungen im Zusammenhang mit dieser Bestellung. |
|
vertical |
Eingestellt: Verwenden Sie stattdessen Branchen. Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie nicht in einer Werbebuchung überschrieben werden. Diese Branche muss dem Branchentyp auf Werbebuchungsebene entsprechen. Mögliche Werte: Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |
|
Union-Feld verticals . Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie nicht in einer Werbebuchung überschrieben werden. Diese Branche muss dem Branchentyp auf Werbebuchungsebene entsprechen. Für verticals ist nur einer der folgenden Werte zulässig: |
||
purchase |
Auftrag |
|
ticket |
Ticketbestellung |
UserInfo
Informationen zum Nutzer. Dieses Feld wird verwendet, um Informationen des Nutzers darzustellen, der mit einer Bestellung verknüpft ist.
JSON-Darstellung | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
Felder | |
---|---|
email |
E-Mail-Adresse des Nutzers, z. B. janedoe@gmail.com. |
firstName |
Vorname des Nutzers |
lastName |
Nachname des Nutzers |
displayName |
Anzeigename des Nutzers, der sich vom Vor- oder Nachnamen unterscheiden kann |
phoneNumbers[] |
Telefonnummern des Nutzers |
PhoneNumber
Standarddarstellung der Telefonnummer.
JSON-Darstellung | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
Felder | |
---|---|
e164PhoneNumber |
Telefonnummer im E.164-Format, wie in der Empfehlung E.164 der International Telecommunication Union (ITU) definiert. Wiki-Link: https://en.wikipedia.org/wiki/E.164 |
extension |
Die Erweiterung ist in den ITU-Empfehlungen nicht standardisiert, mit der Ausnahme, dass sie als Zahlenfolge mit einer maximalen Länge von 40 Ziffern definiert ist. Er wird hier als String definiert, um die mögliche Verwendung einer führenden Null in der Erweiterung zu berücksichtigen. Organisationen haben dabei völlige Freiheit, da kein Standard definiert ist. Neben Ziffern können hier auch andere Wählzeichen wie „,“ gespeichert werden, die eine Wartezeit anzeigen. Beispiel: In xxx-xxx-xxxx Durchwahl 123 ist „123“ die Durchwahl. |
preferredDomesticCarrierCode |
Der Code zur Auswahl des Mobilfunkanbieters, der bei Anrufen dieser Telefonnummer im Inland bevorzugt wird Dazu gehören auch Codes, die in einigen Ländern gewählt werden müssen, wenn Sie von Festnetz- zu Mobiltelefonen anrufen oder umgekehrt. In Kolumbien muss zum Beispiel bei Anrufen von einem Mobiltelefon zu einem inländischen Festnetz und umgekehrt eine „3“ vor der Telefonnummer gewählt werden. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code Hierbei handelt es sich um den „bevorzugten“ Code, d. h., andere Codes können ebenfalls verwendet werden. |
Bild
Ein Bild, das auf der Karte angezeigt wird.
JSON-Darstellung | |
---|---|
{ "url": string, "accessibilityText": string, "height": integer, "width": integer } |
Felder | |
---|---|
url |
Die Quell-URL des Bildes. Bilder können das Format JPG, PNG und GIF haben (animiert und nicht animiert). Beispiel: |
accessibilityText |
Eine Textbeschreibung des Bildes, die für Barrierefreiheit verwendet werden soll, z.B. Screenreader. Erforderlich. |
height |
Die Höhe des Bilds in Pixeln Optional. |
width |
Die Breite des Bilds in Pixeln Optional. |
Händler
Händler für den Einkaufswagen/die Bestellung/die Werbebuchung.
JSON-Darstellung | |
---|---|
{ "id": string, "name": string, "image": { object ( |
Felder | |
---|---|
id |
Optionale ID, die dem Händler zugewiesen ist, falls vorhanden. |
name |
Der Name des Händlers, z. B. „Panera Bread“. |
image |
Das mit dem Händler verknüpfte Bild. |
phoneNumbers[] |
Telefonnummern des Händlers. |
address |
Adresse des Händlers. |
Standort
Container, der einen Standort darstellt.
JSON-Darstellung | |
---|---|
{ "coordinates": { object ( |
Felder | |
---|---|
coordinates |
Geokoordinaten: Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Angezeigte Adresse, z.B. „1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA“. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
Postleitzahl. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
Stadt. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress |
Postanschrift. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
name |
Name des Orts. |
phoneNumber |
Telefonnummer des Standorts, z. B. Kontaktnummer des Unternehmensstandorts oder Telefonnummer des Lieferorts |
notes |
Hinweise zum Ort. |
placeId |
„placeId“ wird mit der Places API verwendet, um Details zu einem Ort abzurufen. Weitere Informationen finden Sie unter https://developers.google.com/places/web-service/place-id. |
LatLng
Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Dies wird als Paar von Double-Werten zur Darstellung von Breiten- und Längengraden ausgedrückt. Sofern nicht anders angegeben, muss dieses Objekt dem WGS84-Standard entsprechen. Die Werte müssen innerhalb normalisierter Bereiche liegen.
JSON-Darstellung | |
---|---|
{ "latitude": number, "longitude": number } |
Felder | |
---|---|
latitude |
Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen. |
longitude |
Der Längengrad in Grad. Er muss im Bereich [-180,0, +180,0] liegen. |
PostalAddress
Stellt eine Postadresse dar, z. B. für Postzustellungs- oder Zahlungsadressen. Mit einer Postadresse kann ein Postdienst Artikel an eine Einrichtung, ein Postfach oder eine andere Adresse liefern. Sie stellt kein Modell eines geografischen Standorts (Straßen, Städte, Berge) dar.
Normalerweise wird eine Adresse je nach Prozesstyp durch eine Nutzereingabe oder den Import vorhandener Daten erstellt.
Hinweise zur Adresseingabe/-bearbeitung: Verwenden Sie ein i18n-fähiges Adress-Widget wie https://github.com/google/libaddressinput. Nutzer sollten in Ländern, in denen dieses Feld verwendet wird, keine UI-Elemente für die Eingabe oder Bearbeitung von Feldern sehen.
Weitere Informationen zur Verwendung dieses Schemas finden Sie unter https://support.google.com/business/answer/6397478.
JSON-Darstellung | |
---|---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Felder | |
---|---|
revision |
Die Schemaversion von Alle neuen Überarbeitungen müssen abwärtskompatibel zu alten Überarbeitungen sein. |
regionCode |
Erforderlich. CLDR-Regionscode des Landes bzw. der Region der Adresse. Er wird nie abgeleitet. Der Nutzer muss sicherstellen, dass der Wert richtig ist. Weitere Informationen finden Sie unter http://cldr.unicode.org/ und http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Beispiel: "CH" für die Schweiz |
languageCode |
Optional. BCP-47-Sprachencode des Inhalts dieser Adresse, falls bekannt. Dies ist oft die Sprache der UI des Eingabeformulars oder die Sprache, die mit einer der verwendeten Sprachen des Landes bzw. der Region mit der Adresse oder der entsprechenden Transliteration übereinstimmt. In bestimmten Ländern hat dies Auswirkungen auf die Formatierung. Es ist jedoch nicht entscheidend für die Richtigkeit der Daten und hat niemals Auswirkungen auf Validierungen oder andere nicht formatierungsbezogene Vorgänge. Wenn dieser Wert nicht bekannt ist, sollte er weggelassen werden. Das ist besser, als einen möglicherweise falschen Wert anzugeben. Beispiele: "zh-Hant", "ja", "ja-Latn", "en" |
postalCode |
Optional. Postleitzahl der Adresse. Postleitzahlen werden nicht in allen Ländern verwendet oder benötigt. Dort, wo sie verwendet werden, können sie weitere Validierungsvorgänge für andere Adressteile nach sich ziehen, z. B. die Validierung von Bundesstaat/Postleitzahl in den USA. |
sortingCode |
Optional. Zusätzlicher länderspezifischer Sortiercode. Dieser wird nur für wenige Regionen genutzt. Wenn er verwendet wird, ist der Wert entweder ein String wie "CEDEX", optional gefolgt von einer Ziffer (z. B. "CEDEX 7"), oder nur eine Ziffer für den Sektorcode (Jamaika), den Zustellbereichsindikator (Malawi) oder den Postamtindikator (z. B. Elfenbeinküste). |
administrativeArea |
Optional. Höchste administrative Untergliederung, die für Postadressen eines Landes oder einer Region verwendet wird. Dies kann beispielsweise ein Bundesland, eine Provinz, eine Oblast oder eine Präfektur sein. In Spanien ist dies beispielsweise die Provinz und nicht das autonome Gebiet, also z. B. "Barcelona" und nicht "Katalonien". In vielen Ländern werden in der Postadresse keine Verwaltungsgebiete verwendet. Für die Schweiz etwa sollte dieses Feld leer gelassen werden. |
locality |
Optional. Bezieht sich in der Regel auf die Stadt-/Ortsangabe der Adresse. Beispiele: Stadt in den USA, italienische Gemeinde, Post Town in Großbritannien. Lassen Sie in Regionen der Welt, in denen Lokalitäten nicht hinreichend definiert sind oder nicht dieser Struktur entsprechen, diese Angabe leer und verwenden Sie stattdessen "addressLines". |
sublocality |
Optional. Unterlokalität der Adresse. Dies können beispielsweise Stadtviertel, Stadtteile und Bezirke sein. |
addressLines[] |
Offene Adresszeilen, mit denen nachgeordnete Bereiche einer Adresse beschrieben werden können. Da die Werte in "addressLines" keine Typinformationen beinhalten und manchmal mehrere Werte in einem einzigen Feld enthalten sind, z. B. "Austin, TX", muss die Zeilenreihenfolge deutlich erkennbar sein. Die Reihenfolge der Adresszeilen sollte der Adresse auf einem Briefumschlag für das Land bzw. die Region entsprechen. An Orten, an denen es keine einheitliche Reihenfolge gibt, z. B. in Japan, wird "address_language" verwendet, um dies klar zu machen (z. B. "ja" für die Reihenfolge groß zu klein und "ja-Latn" oder "en" für die Reihenfolge klein zu groß). Auf diese Weise kann die spezifischste Zeile einer Adresse sprachabhängig ausgewählt werden. Die Mindestangabe für eine zulässige strukturierte Darstellung einer Adresse besteht aus einem "regionCode" und allen verbleibenden Informationen in "addressLines". Eine solche Adresse kann weitgehend angenähert ohne Geocodierung formatiert werden. Es wäre jedoch erst dann eine semantische Argumentation zu einer der Adresskomponenten möglich, wenn diese zumindest teilweise aufgelöst wird. Es empfiehlt sich, für vollständig unstrukturierte Adressen eine Adresse mit einem "regionCode" und "adressLines" zu erstellen und danach eine Geocodierung dafür durchzuführen. So muss nicht geraten werden, welche Teile der Adresse Orte oder administrative Gebiete darstellen. |
recipients[] |
Optional. Der Empfänger an der Adresse. Dieses Feld kann in bestimmten Fällen mehrere Zeilen lange Informationen enthalten. Beispielsweise kann es Informationen der Art "wohnhaft bei" enthalten. |
organization |
Optional. Der Name der Organisation an der Adresse. |
Inhalt
Wrapper für Werbebuchungen.
JSON-Darstellung | |
---|---|
{
"lineItems": [
{
object ( |
Felder | |
---|---|
lineItems[] |
Liste der Auftragswerbebuchungen. Mindestens 1 Werbebuchung ist erforderlich, höchstens 50. Alle Werbebuchungen müssen zur selben Branche gehören. |
LineItem
Eine Werbebuchung enthält eine Branche. Ein Auftrag oder Einkaufswagen kann mehrere Werbebuchungen derselben Branche enthalten. Unterwerbebuchungen, Add-ons usw. sollten je nach Anwendungsfall in vertikalen Proto-Dateien definiert werden. Hinweis: 1. Sofern nicht anders angegeben, müssen alle Strings auf allen Ebenen weniger als 1.000 Zeichen lang sein. 2. Sofern nicht anders angegeben, müssen alle wiederkehrenden Felder auf allen Ebenen kleiner als 50 sein. 3. Falls angegeben, müssen alle Zeitstempel auf allen Ebenen gültige Zeitstempel sein.
JSON-Darstellung | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
Felder | ||
---|---|---|
id |
Erforderlich: Dem Händler zugewiesene ID für die Werbebuchung. Wird verwendet, um eine vorhandene Werbebuchung bei der Anwendung von Teilaktualisierungen zu identifizieren. Die maximal zulässige Länge beträgt 64 Zeichen. |
|
name |
Name der Position wie auf dem Beleg angegeben Die maximal zulässige Länge beträgt 100 Zeichen. |
|
userVisibleStateLabel |
Veraltet. Verwenden Sie stattdessen den Status auf Branchenebene. Verwenden Sie für Käufe beispielsweise PurchaseOrderExtension.status. Für den Nutzer sichtbares Label für den Status dieser Werbebuchung. |
|
provider |
Der Anbieter der jeweiligen Werbebuchung, falls abweichend vom Gesamtauftrag Beispiel: Expedia-Auftrag bei Werbebuchungstyp „ANA“ |
|
priceAttributes[] |
Preis und Anpassungen auf Werbebuchungsebene |
|
followUpActions[] |
Follow-up-Aktionen für Werbebuchung. |
|
recipients[] |
Für Kunden auf Werbebuchungsebene kann dieser Wert vom Käufer auf Auftragsebene abweichen. Beispiel: Nutzer X hat eine Restaurantreservierung unter dem Namen von Nutzer Y vorgenommen. |
|
image |
Kleines, mit diesem Element verknüpftes Bild, falls vorhanden |
|
description |
Beschreibung der Werbebuchung. |
|
notes[] |
Zusätzliche Hinweise, die für diese bestimmte Position gelten, z. B. Stornierungsrichtlinien |
|
disclosures[] |
Offenlegungen im Zusammenhang mit dieser Position. |
|
vertical |
Eingestellt: Verwenden Sie stattdessen Branchen. Erforderlich: Semantischer Content der Werbebuchung basierend auf Typ/Branche Jede Branche sollte eigene Details zur Auftragsausführung enthalten. Muss einer der folgenden Werte sein: Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |
|
Union-Feld verticals . Erforderlich: Semantischer Content der Werbebuchung basierend auf Typ/Branche Jede Branche sollte eigene Details zur Auftragsausführung enthalten. Für verticals ist nur einer der folgenden Werte zulässig: |
||
purchase |
Bestellungen wie Waren, Essen usw. |
|
reservation |
Reservierungsbestellungen wie Restaurant, Friseur usw. |
PriceAttribute
Preisattribut einer Bestellung oder Werbebuchung.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | ||
---|---|---|
type |
Erforderlich: Attribut für die Art des Geldes. |
|
name |
Erforderlich: Der vom Nutzer angezeigte String des Preisattributs. Diese wird vom Händler gesendet und lokalisiert. |
|
id |
Optional: ID der Position, der dieser Preis entspricht. |
|
state |
Erforderlich: Status des Preises: Schätzung vs. tatsächlicher Preis |
|
taxIncluded |
Gibt an, ob der Preis inklusive Steuern ist. |
|
Union-Feld spec . Stellt entweder einen Geldbetrag oder einen Milli-Prozentsatz dar. Für spec ist nur einer der folgenden Werte zulässig: |
||
amount |
Geldbetrag. |
|
amountMillipercentage |
Die Prozentspezifikation zu 1/1000 Prozent. Beispiel: 8,750% wird als 8.750 dargestellt, negative Prozentsätze für Rabatte in Prozent. Dieses Feld wird verworfen. Wenn ein solider Anwendungsfall erforderlich ist, können Sie das Video wieder hinzufügen. |
Typ
Der Geldtyp.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Der Typ ist nicht angegeben. Clients sollten ihn nicht explizit festlegen. |
REGULAR |
Regulärer Preis, bevor Rabatte angewendet werden. |
DISCOUNT |
Wird von der Zwischensumme abgezogen. |
TAX |
Wird der Zwischensumme hinzugefügt. |
DELIVERY |
Wird der Zwischensumme hinzugefügt. |
SUBTOTAL |
Zwischensumme, bevor Gebühren anfallen können. |
FEE |
Etwaige zusätzliche Gebühren. |
GRATUITY |
Wird der Zwischensumme hinzugefügt. |
TOTAL |
Angezeigter Preis des Auftrags oder der Werbebuchung |
Status
Stellt den Preisstatus dar.
Enums | |
---|---|
STATE_UNSPECIFIED |
Nicht angegeben. |
ESTIMATE |
Der Preis ist nur eine Schätzung, aber der endgültige Betrag würde ungefähr diesem Betrag entsprechen. Beispiel: Wenn die Steuer zum Zeitpunkt der Transaktion nicht genau bekannt ist, ergibt sich ein ESTIMATE-Betrag. |
ACTUAL |
Tatsächlicher Preis, der dem Nutzer berechnet wird. |
Geldbetrag
Stellt einen Geldbetrag mit Währungstyp dar.
JSON-Darstellung | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
Felder | |
---|---|
currencyCode |
Der aus drei Buchstaben bestehende Währungscode gemäß ISO 4217. |
amountInMicros |
Betrag in Mikroeinheiten. Dieses Feld sollte beispielsweise als 1990000 für 1, 99 $festgelegt werden. |
Aktion
Eine Folgeaktion in Bezug auf den Auftrag oder die Werbebuchung.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich: Art der Aktion. |
title |
Titel oder Label der Aktion, der dem Nutzer angezeigt wird. Die maximal zulässige Länge beträgt 100 Zeichen. |
openUrlAction |
Erforderliche Maßnahmen. |
actionMetadata |
Mit einer Aktion verknüpfte Metadaten. |
Typ
Mögliche Folgemaßnahmen.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Nicht angegebene Aktion. |
VIEW_DETAILS |
Aktion „Bestelldetails ansehen“. |
MODIFY |
Aktion zum Ändern der Bestellung. |
CANCEL |
Bestellaktion abbrechen. |
RETURN |
Aktion für Rückgabebestellung. |
EXCHANGE |
Aktion für Anzeigenplattform-Bestellung. |
EMAIL |
E-Mail-Aktion. Die Typen EMAIL und CALL werden nicht mehr unterstützt. openUrlAction.url kann als Telefonnummer oder E-Mail-Adresse verwendet werden. |
CALL |
Anrufaktion. |
REORDER |
Aktion „Neu anordnen“. |
REVIEW |
Bestellaktion überprüfen. |
CUSTOMER_SERVICE |
Kundenservice kontaktieren. |
FIX_ISSUE |
Verweisen Sie auf die Website oder App des Händlers, um das Problem zu beheben. |
DIRECTION |
Link zur Wegbeschreibung. |
OpenUrlAction
Öffnet die angegebene URL.
JSON-Darstellung | |
---|---|
{ "url": string, "androidApp": { object ( |
Felder | |
---|---|
url |
Das URL-Feld, das einen der folgenden Werte annehmen kann: – HTTP- oder HTTPS-URLs zum Öffnen einer mit der App verknüpften App oder einer Webseite |
androidApp |
Informationen zur Android-App, wenn die URL voraussichtlich von einer Android-App bereitgestellt wird. |
urlTypeHint |
Gibt einen Hinweis für den URL-Typ an. |
AndroidApp
Spezifikation der Android-App für Einschränkungen bei der Auftragsausführung
JSON-Darstellung | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
Felder | |
---|---|
packageName |
Paketname Der Paketname muss bei der Android-Auftragsausführung angegeben werden. |
versions[] |
Wenn mehrere Filter angegeben sind, wird die Anwendung durch jede Filterübereinstimmung ausgelöst. |
VersionFilter
VersionFilter sollte einbezogen werden, wenn bestimmte Versionen der Anwendung erforderlich sind.
JSON-Darstellung | |
---|---|
{ "minVersion": integer, "maxVersion": integer } |
Felder | |
---|---|
minVersion |
Mindestversionscode oder 0 (einschließlich). |
maxVersion |
Code für die maximale Version (einschließlich). Der berücksichtigte Bereich ist [minVersion:maxVersion]. Ein Nullbereich gilt für jede Version. Beispiele: Um eine einzelne Version anzugeben, verwenden Sie: [target_version:target_version]. Wenn Sie eine beliebige Version angeben möchten, lassen Sie „minVersion“ und „maxVersion“ nicht angegeben. Wenn Sie alle Versionen bis „maxVersion“ angeben möchten, geben Sie „minVersion“ nicht an. Wenn Sie alle Versionen aus „minVersion“ angeben möchten, geben Sie für „maxVersion“ keine Angabe. |
UrlTypeHint
Verschiedene Arten von URL-Hinweisen.
Enums | |
---|---|
URL_TYPE_HINT_UNSPECIFIED |
Ohne Angabe |
AMP_CONTENT |
URL, die direkt auf AMP-Inhalte verweist, oder auf eine kanonische URL, die über <link rel="amphtml"> auf AMP-Inhalte verweist |
ActionMetadata
Zugehörige Metadaten pro Aktion.
JSON-Darstellung | |
---|---|
{ "expireTime": string } |
Felder | |
---|---|
expireTime |
Zeitpunkt, zu dem diese Aktion abläuft. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
Offenlegung
Informationen zu Produkten, Dienstleistungen oder Richtlinien, die dem Nutzer angezeigt werden können.
JSON-Darstellung | |
---|---|
{ "title": string, "disclosureText": { object ( |
Felder | |
---|---|
title |
Titel der Offenlegung. Beispiel: „Sicherheitsinformationen“. |
disclosureText |
Inhalt der Offenlegung. Weblinks sind erlaubt. |
presentationOptions |
Darstellungsoptionen für die Offenlegung. |
DisclosureText
Stellt einen einfachen Text mit Weblinks dar.
JSON-Darstellung | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
Felder | |
---|---|
template |
Anzuzeigender Text mit Platzhaltern wie "{0}" und "{1}" für jeden einzufügenden Textlink. Beispiel: „WARNUNG: Dieses Produkt kann Chemikalien ausgesetzt werden, die laut dem US-Bundesstaat Kalifornien Krebs verursachen können. Weitere Informationen finden Sie unter {0}." Dieser Offenlegungstext darf keine Werbeinhalte oder anzeigenähnlichen Inhalte enthalten. |
textLinks[] |
Textlinks, die in der Vorlage ersetzt werden sollten. Die erste wird in der Vorlagenzeichenfolge durch "{0}" ersetzt, die zweite durch "{1}" usw. |
TextLink
Ein Textlink, der in der Vorlage ersetzt werden sollte.
JSON-Darstellung | |
---|---|
{ "displayText": string, "url": string } |
Felder | |
---|---|
displayText |
Text, der den Nutzern angezeigt werden soll. |
url |
URL, zu der Nutzer weitergeleitet werden sollen, wenn der Link aktiviert wird. |
DisclosurePresentationOptions
Optionen für die Darstellung einer Offenlegung.
JSON-Darstellung | |
---|---|
{
"presentationRequirement": enum ( |
Felder | |
---|---|
presentationRequirement |
Die Offenlegung muss vorgelegt werden. |
initiallyExpanded |
Gibt an, ob der Inhalt der Offenlegung anfangs erweitert werden soll. Standardmäßig ist sie zunächst minimiert. |
PresentationRequirement
Voraussetzung für die Präsentation der Offenlegung.
Enums | |
---|---|
REQUIREMENT_UNSPECIFIED |
Nicht angegebene Anforderung. Sollte nicht explizit festgelegt werden. |
REQUIREMENT_OPTIONAL |
Die Offenlegung ist optional. Sie kann übersprungen werden, wenn das Gerät die Anzeige von Offenlegungen nicht unterstützt. |
REQUIREMENT_REQUIRED |
Die Offenlegung ist erforderlich. Wenn das Gerät die Darstellung von Offenlegungen nicht unterstützt, wird für das Gespräch eine Punt-to-Phone-Antwort ausgeführt. |
PurchaseItemExtension
Artikelinhalte der Kaufbranche.
JSON-Darstellung | |
---|---|
{ "status": enum ( |
Felder | |
---|---|
status |
Erforderlich: Status auf Werbebuchungsebene. |
userVisibleStatusLabel |
Erforderlich: Für den Nutzer sichtbares Label/String für den Status. Die maximal zulässige Länge beträgt 50 Zeichen. |
type |
Erforderlich: Art des Kaufs. |
productId |
Produkt- oder Angebots-ID, die dieser Werbebuchung zugeordnet ist. |
quantity |
Menge des Artikels |
unitMeasure |
Maßeinheit. Gibt die Größe des Artikels in ausgewählten Einheiten an. Die Größe ergibt zusammen mit dem aktiven Preis den Preis pro Einheit. |
returnsInfo |
Gibt Informationen zu dieser Werbebuchung zurück. Wenn kein Wert festgelegt ist, übernimmt diese Werbebuchung Rückgabeinformationen auf Auftragsebene. |
fulfillmentInfo |
Informationen zur Auftragsausführung für diese Werbebuchung. Wenn kein Wert festgelegt ist, übernimmt diese Werbebuchung Informationen zur Auftragsausführung auf Auftragsebene. |
itemOptions[] |
Zusätzliche Add-ons oder Unterobjekte. |
productDetails |
Details zum Produkt. |
extension |
Alle zusätzlichen Felder, die zwischen Händler und Google ausgetauscht werden Hinweis: Von der Verwendung dieser Erweiterung wird dringend abgeraten. Überlegen Sie sich je nach Anwendungsfall/den jeweiligen Umständen eine der folgenden Optionen: 1. Definieren Sie Felder in PurchaseItemExtension, wenn sie für andere Anwendungsfälle verwendet werden könnten (z. B. allgemeine Funktionen/Funktionalität). 2. Verwenden Sie „Vertical_extension“, wenn es sich speziell auf einen benutzerdefinierten, nicht generischen Anwendungsfall oder eine allgemeine Funktion bezieht. Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |
PurchaseStatus
Kaufstatus, der mit einem Auftrag oder einer bestimmten Position verknüpft ist.
Enums | |
---|---|
PURCHASE_STATUS_UNSPECIFIED |
Status nicht angegeben. |
READY_FOR_PICKUP |
Abholbereit. |
SHIPPED |
Versandt. |
DELIVERED |
Zugestellt. |
OUT_OF_STOCK |
Nicht auf Lager. |
IN_PREPARATION |
"IN_PREPARATION" kann in einem anderen Kontext unterschiedliche Bedeutungen haben. Bei der FOOD-Bestellung könnte es sein, dass das Essen vorbereitet wird. Im Einzelhandel könnte es sein, dass ein Artikel verpackt wird. |
CREATED |
Der Auftrag wird erstellt. |
CONFIRMED |
Der Händler hat die Bestellung bestätigt. |
REJECTED |
Der Händler hat den Auftrag oder die Werbebuchung abgelehnt. |
RETURNED |
Der Artikel wurde vom Nutzer zurückgegeben. |
CANCELLED |
Der Auftrag oder die Werbebuchung wurde vom Nutzer storniert. |
CHANGE_REQUESTED |
Der Nutzer hat eine Änderung an der Bestellung angefordert und der Integrator verarbeitet diese Änderung. Die Bestellung sollte nach der Verarbeitung der Anfrage in einen anderen Status verschoben werden. |
PurchaseType
Die Kaufkategorie.
Enums | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
Unbekannter Wert. |
RETAIL |
Dazu gehören Käufe wie physische Waren. |
FOOD |
Dazu gehören auch Essensbestellungen. |
GROCERY |
Einkauf von Lebensmitteln. |
MOBILE_RECHARGE |
Kauf eines Prepaidguthabens. |
MerchantUnitMeasure
Mengeneinheit des Preises pro Einheit des Händlers.
JSON-Darstellung | |
---|---|
{
"measure": number,
"unit": enum ( |
Felder | |
---|---|
measure |
Wert: Beispiel 1.2. |
unit |
Einheit: Beispiel POUND, GRAM. |
Einheit
Enums | |
---|---|
UNIT_UNSPECIFIED |
Einheit nicht angegeben. |
MILLIGRAM |
ein Milligramm. |
GRAM |
Gramm. |
KILOGRAM |
Kilogramm. |
OUNCE |
Unze. |
POUND |
Pfund. |
PurchaseReturnsInfo
Gibt Informationen zurück, die mit einem Auftrag oder einer bestimmten Werbebuchung verknüpft sind.
JSON-Darstellung | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
Felder | |
---|---|
isReturnable |
Bei „true“ ist die Rückgabe zulässig. |
daysToReturn |
Die Rückgabe ist innerhalb dieser Tage möglich. |
policyUrl |
Link zu den Rückgabebedingungen. |
PurchaseFulfillmentInfo
Informationen zur Auftragsausführung, die mit einem Auftrag oder einer bestimmten Position verknüpft sind.
JSON-Darstellung | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
Felder | |
---|---|
id |
Eindeutige Kennung für diese Serviceoption. |
fulfillmentType |
Erforderlich: Der Auftragsausführungstyp. |
expectedFulfillmentTime |
Ein Fenster, wenn ein Zeitraum angegeben ist, oder eine ETA, wenn eine einzelne Zeit angegeben ist. Voraussichtliche Liefer- oder Abholzeit. |
expectedPreparationTime |
Ein Fenster, wenn ein Zeitraum angegeben ist, oder eine ETA, wenn eine einzelne Zeit angegeben ist. Voraussichtliche Zeit für die Zubereitung des Essens. Einmalig bevorzugt. |
location |
Abhol- oder Lieferort. |
expireTime |
Zeit, zu der diese Auftragsausführungsoption abläuft. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
price |
Kosten dieser Option. |
fulfillmentContact |
Nutzerkontakt für diese Auftragsausführung. |
shippingMethodName |
Name der Versandmethode, die der Nutzer ausgewählt hat. |
storeCode |
StoreCode des Standorts. Beispiel: Walmart ist der Händler und storeCode ist der Walmart-Shop, in dem die Auftragsausführung stattfindet. https://support.google.com/business/answer/3370250?ref_topic=4596653 |
pickupInfo |
Zusätzliche Informationen zur Auswahl der Bestellung. Dieses Feld ist nur anwendbar, wenn der Auftragsausführungstyp PICKUP ist. |
Typ
Ausführungstyp.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Der Typ ist nicht angegeben. |
DELIVERY |
Diese Bestellung wird geliefert. |
PICKUP |
Diese Bestellung muss abgeholt werden. |
Zeit
Zeitkonstrukt zur Darstellung der Zeit eines Ereignisses, das beim Anzeigen einer Bestellung für den Nutzer verwendet werden soll.
JSON-Darstellung | |
---|---|
{ "timeIso8601": string } |
Felder | |
---|---|
timeIso8601 |
Stellt eine Bestellereigniszeit wie die Reservierungszeit, die Lieferzeit usw. dar. Dabei kann es sich um eine Dauer (Start- und Endzeit), nur das Datum, die Uhrzeit usw. handeln. Alle unterstützten Formate finden Sie unter https://en.wikipedia.org/wiki/ISO_8601. |
PickupInfo
Details zur Abholung einer Bestellung Sie enthält Details wie den Abholtyp und gegebenenfalls zusätzliche Metadaten für jeden Typ.
JSON-Darstellung | |
---|---|
{ "pickupType": enum ( |
Felder | |
---|---|
pickupType |
Abholoption, z. B. INSTORE, CURBSIDE usw. |
curbsideInfo |
Spezifische Details zu den Informationen zum Straßenrand. Wenn pickupType nicht „CURBSIDE“ ist, wird dieses Feld ignoriert. |
checkInInfo[] |
Liste der verschiedenen Methoden, die vom Partner für den Check-in unterstützt werden. |
PickupType
Liste der unterstützten Abholtypen.
Enums | |
---|---|
UNSPECIFIED |
Abholtyp nicht angegeben. |
INSTORE |
Essen im Restaurant abholen. |
CURBSIDE |
Parken Sie das Fahrzeug an einer ausgewiesenen Stelle vor dem Restaurant, damit dort Essen geliefert wird. |
CurbsideInfo
Details dazu, wie die Bestellung vor dem Laden abgewickelt wird
JSON-Darstellung | |
---|---|
{ "curbsideFulfillmentType": enum ( |
Felder | |
---|---|
curbsideFulfillmentType |
Partner benötigen zusätzliche Informationen, um Bestellungen zur Abholung vor dem Laden zu ermöglichen. Abhängig vom ausgewählten Auftragsausführungstyp werden entsprechende Daten vom Nutzer erhoben. |
userVehicle |
Fahrzeugdetails des Nutzers, der die Bestellung aufgibt. |
CurbsideFulfillmentType
Mögliche Werte der Auftragsausführungstypen vor dem Laden.
Enums | |
---|---|
UNSPECIFIED |
Art der Auftragsausführung vor dem Laden nicht angegeben. |
VEHICLE_DETAIL |
Für die Abholung vor dem Laden sind Fahrzeugdetails erforderlich. |
Fahrzeug
Details zu einem Fahrzeug
JSON-Darstellung | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
Felder | |
---|---|
make |
Fahrzeugmarke (z.B. „Honda“). Dieser wird dem Nutzer angezeigt und muss lokalisiert werden. Erforderlich. |
model |
Fahrzeugmodell (z.B. „Grom“). Dieser wird dem Nutzer angezeigt und muss lokalisiert werden. Erforderlich. |
licensePlate |
Kfz-Kennzeichen (z. B. 1ABC234) Erforderlich. |
colorName |
Farbname des Fahrzeugs, z. B. Schwarz (optional). |
image |
URL zu einem Foto des Fahrzeugs. Das Foto wird mit einer Größe von etwa 256 x 256 Pixel angezeigt. Muss im JPG- oder PNG-Format vorliegen. Optional. |
CheckInInfo
Metadaten, die vom Partner benötigt werden, um eine Check-in-Methode zu unterstützen.
JSON-Darstellung | |
---|---|
{
"checkInType": enum ( |
Felder | |
---|---|
checkInType |
Methode zum Senden von Check-in-Anweisungen. |
CheckInType
Verschiedene Methoden zum Senden von Check-in-Anweisungen.
Enums | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED |
Unbekannter Wert. |
EMAIL |
Check-In-Informationen werden per E-Mail gesendet. |
SMS |
Check-In-Informationen werden per SMS gesendet. |
ItemOption
Add-ons oder Unterobjekte.
JSON-Darstellung | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
Felder | |
---|---|
id |
Für Optionen, die Artikel sind, die eindeutige Artikel-ID |
name |
Optionsname. |
prices[] |
Gesamtpreis der Option. |
note |
Hinweis zu der Option. |
quantity |
Für Optionen, nämlich Artikel, Menge |
productId |
Produkt- oder Angebots-ID, die mit dieser Option verknüpft ist. |
subOptions[] |
Zum Definieren anderer verschachtelter Unteroptionen. |
ProductDetails
Details zum Produkt.
JSON-Darstellung | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
Felder | |
---|---|
productId |
Produkt- oder Angebots-ID, die dieser Werbebuchung zugeordnet ist. |
gtin |
Global Trade Item Number des Produkts. Dies ist hilfreich, wenn im Merchant Center keine Angebots-ID vorhanden ist. Optional. |
plu |
Preissuchcodes, allgemein als PLU-Codes, PLU-Nummern, PLUs, Produkcodes oder Etiketten bezeichnet, sind ein Zahlensystem, das in Lebensmittelgeschäften und Supermärkten verkaufte Großpackungen eindeutig identifiziert. |
productType |
Vom Händler definierte Produktkategorie. Beispiel: „Startseite > Lebensmittel > Milchprodukte & Eier > Milch > Vollmilch“ |
productAttributes |
Vom Händler bereitgestellte Details zum Produkt, z.B. { "allergen": "erdnuss" }. Nützlich, wenn im Merchant Center keine Angebots-ID vorhanden ist. Optional. Ein Objekt, das eine Liste von |
ReservationItemExtension
Werbebuchungsinhalte für Reservierungsaufträge wie Restaurant, Friseur usw.
JSON-Darstellung | |
---|---|
{ "status": enum ( |
Felder | |
---|---|
status |
Erforderlich: Reservierungsstatus. |
userVisibleStatusLabel |
Erforderlich: Für den Nutzer sichtbares Label/String für den Status. Die maximal zulässige Länge beträgt 50 Zeichen. |
type |
Art der Reservierung. Kann nicht festgelegt sein, wenn keine der Typoptionen anwendbar ist. |
reservationTime |
Uhrzeit, zu der die Dienstleistung bzw. das Ereignis geplant ist. Dabei kann es sich um einen Zeitraum, ein Datum oder ein genaues Datum und eine Uhrzeit handeln. |
userAcceptableTimeRange |
Zeitraum, der für den Nutzer akzeptabel ist. |
confirmationCode |
Bestätigungscode für diese Reservierung. |
partySize |
Die Anzahl der Personen. |
staffFacilitators[] |
Moderatoren, die für die Reservierung zuständig sind. Beispiel: Der Friseur. |
location |
Ort der Dienstleistung/Veranstaltung |
ReservationStatus
Status der Reservierung.
Enums | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
Nicht angegebener Status. |
PENDING |
Die Reservierung steht aus. |
CONFIRMED |
Die Reservierung ist bestätigt. |
CANCELLED |
Die Reservierung wird vom Nutzer storniert. |
FULFILLED |
Die Reservierung wurde erfüllt. |
CHANGE_REQUESTED |
Änderung der Reservierung wurde angefordert |
REJECTED |
Die Reservierung ist entweder abgelaufen oder wurde vom Integrator abgelehnt. |
ReservationType
Art der Reservierung.
Enums | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
Nicht definierter Typ. |
RESTAURANT |
Restaurantreservierung. |
HAIRDRESSER |
Reservierung beim Friseur. |
StaffFacilitator
Informationen zur Soldaten.
JSON-Darstellung | |
---|---|
{
"name": string,
"image": {
object ( |
Felder | |
---|---|
name |
Der Name der moderierenden Person. Beispiel: „Max Mustermann“ |
image |
Bilder des Künstlers |
PaymentData
Zahlungsdaten einer Bestellung.
JSON-Darstellung | |
---|---|
{ "paymentResult": { object ( |
Felder | |
---|---|
paymentResult |
Zahlungsergebnis, das vom Integrator für den Abschluss einer Transaktion verwendet wird. Dieses Feld wird von Actions on Google ausgefüllt, wenn der Bezahlvorgang von Actions-on-Google verwaltet wird. |
paymentInfo |
Zahlungsinformationen zur Bestellung, die für die Interaktion mit dem Nutzer hilfreich sind. |
PaymentResult
Zahlungsergebnis, das vom Integrator für den Abschluss einer Transaktion verwendet wird.
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld result . Es sind entweder Google-Zahlungsdaten oder die Zahlungsmethode des Händlers angegeben. Für result ist nur einer der folgenden Werte zulässig: |
||
googlePaymentData |
Google hat Daten zur Zahlungsmethode bereitgestellt. Wenn Ihr Zahlungsabwickler hier als von Google unterstützter Zahlungsabwickler aufgeführt ist: https://developers.google.com/pay/api/ Rufen Sie den Zahlungsabwickler über den Link auf, um weitere Informationen zu erhalten. Weitere Informationen zur Nutzlast findest du in der folgenden Dokumentation: https://developers.google.com/pay/api/payment-data-cryptography |
|
merchantPaymentMethodId |
Vom Händler/Aktion bereitgestellte Zahlungsmethode vom Nutzer ausgewählt. |
PaymentInfo
Zahlungsinformationen zur aufgegebenen Bestellung Dieses Proto erfasst Informationen, die für die Interaktion mit Nutzenden nützlich sind.
JSON-Darstellung | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
Felder | |
---|---|
paymentMethodDisplayInfo |
Die angezeigten Informationen zur Zahlungsmethode, die für die Transaktion verwendet wurde. |
paymentMethodProvenance |
Herkunft der Zahlungsmethode, die für die Transaktion verwendet wurde. Der Nutzer hat möglicherweise dieselbe Zahlungsmethode bei Google und beim Händler registriert. |
PaymentMethodDisplayInfo
Zahlungsergebnis, das vom Integrator für den Abschluss einer Transaktion verwendet wird.
JSON-Darstellung | |
---|---|
{
"paymentType": enum ( |
Felder | |
---|---|
paymentType |
Die Art der Zahlung. |
paymentMethodDisplayName |
Für den Nutzer sichtbarer Name der Zahlungsmethode. Beispiel: VISA **** 1234 Girokonto **** 5678 |
paymentMethodVoiceName |
Name der Zahlungsmethode, der dem Nutzer auf Geräten mit Sprachassistenten vorgelesen wird. Beispiele: „Visum mit den Endziffern eins zwei drei vier“ oder „Girokonto mit den Endziffern fünf sechs sieben acht“. Hinweis: Dies ist der sprachoptimierte String, der anstelle des paymentMethodDisplayName für Geräte mit Sprachassistenten verwendet wird. Wenn dieser String nicht festgelegt ist, wird „paymentMethodDisplayName“ dem Nutzer ausgesprochen. |
PaymentType
PaymentType gibt das Zahlungsmittel an, das für die vom Händler bereitgestellte Zahlungsmethode verwendet wird. Die Aktion muss auch einen Anzeigenamen für die Zahlungsmethode enthalten.
Enums | |
---|---|
PAYMENT_TYPE_UNSPECIFIED |
Zahlungsart nicht angegeben. |
PAYMENT_CARD |
Eine Kredit-/Debit- oder Prepaidkarte |
BANK |
Die Zahlungsmethode ist ein Bankkonto. |
LOYALTY_PROGRAM |
Die Zahlungsmethode ist ein Treuepunkteprogramm. |
CASH |
Als Zahlungsmethode gilt Bargeld. |
GIFT_CARD |
Die Zahlungsmethode ist eine Geschenkkarte. |
WALLET |
Drittanbieter-Wallet, z.B. PayPal |
PaymentMethodProvenance
Gibt die Herkunft der Zahlungsmethode an, die für die Transaktion verwendet wurde.
Enums | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
Die Herkunft ist nicht angegeben. |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
Die Herkunft ist Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
Herkunft ist Händler. |
Werbung
Aktionen/Angebote, die dem Einkaufswagen hinzugefügt wurden.
JSON-Darstellung | |
---|---|
{ "coupon": string } |
Felder | |
---|---|
coupon |
Erforderlich: Gutscheincode, der auf dieses Angebot angewendet wird. |
PurchaseOrderExtension
Bestellerweiterung für die Kaufbranche. Diese Eigenschaften gelten für alle Werbebuchungen im Auftrag, sofern sie in einer Werbebuchung nicht überschrieben werden.
JSON-Darstellung | |
---|---|
{ "status": enum ( |
Felder | |
---|---|
status |
Erforderlich: Gesamtstatus der Bestellung. |
userVisibleStatusLabel |
Für den Nutzer sichtbares Label/String für den Status. Die maximal zulässige Länge beträgt 50 Zeichen. |
type |
Erforderlich: Art des Kaufs. |
returnsInfo |
Rückgabeinformationen für die Bestellung. |
fulfillmentInfo |
Informationen zur Auftragsausführung für die Bestellung. |
purchaseLocationType |
Ort des Kaufs (im Geschäft / online) |
errors[] |
Optional: Fehler, aufgrund derer diese Bestellung abgelehnt wurde. |
extension |
Alle zusätzlichen Felder, die zwischen Händler und Google ausgetauscht werden Hinweis: Von der Verwendung dieser Erweiterung wird dringend abgeraten. Überlegen Sie sich je nach Anwendungsfall/den jeweiligen Umständen eine der folgenden Optionen: 1. Definieren Sie Felder in „PurchaseOrderExtension“, wenn sie für andere Anwendungsfälle verwendet werden könnten (z. B. allgemeine Funktionen/Funktionalität). 2. Verwenden Sie „Vertical_extension“, wenn es sich speziell auf einen benutzerdefinierten, nicht generischen Anwendungsfall oder eine allgemeine Funktion bezieht. Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |
PurchaseLocationType
Standorttyp des Kaufs.
Enums | |
---|---|
UNSPECIFIED_LOCATION |
Unbekannter Wert. |
ONLINE_PURCHASE |
Alle Käufe wurden online gekauft. |
INSTORE_PURCHASE |
Alle Käufe im Geschäft. |
PurchaseError
Fehler, bei denen ein Auftrag abgelehnt werden kann.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich: Gibt den genauen Grund an, warum eine Bestellung vom Händler abgelehnt wird. |
description |
Zusätzliche Fehlerbeschreibung. |
entityId |
Entitäts-ID, die dem Fehler entspricht. Beispiel: „LineItemId“ oder „ItemOptionId“. |
updatedPrice |
Relevant bei dem Fehlertyp PRICE_CHANGED / INCORRECT_PRICE. |
availableQuantity |
Jetzt verfügbar. Anwendbar bei AVAILABILITY_CHANGED |
ErrorType
Mögliche Fehlertypen.
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Unbekannter Fehler |
NOT_FOUND |
Entität nicht gefunden, könnte Artikel, FulfillmentOption oder Promotion sein. Entitäts-ID erforderlich. |
INVALID |
Entitätsdaten ungültig. könnten Artikel, FulfillmentOption oder Promotion sein. Entitäts-ID erforderlich. |
AVAILABILITY_CHANGED |
Artikel nicht verfügbar oder nicht genügend Artikel, um die Anfrage zu erfüllen. Entitäts-ID erforderlich. |
PRICE_CHANGED |
Der Artikelpreis unterscheidet sich vom Preis in der Elemententität. Die Entitäts-ID und der aktualisierte Preis sind erforderlich. |
INCORRECT_PRICE |
Preisfehler in den Gebühren, insgesamt. Die Entitäts-ID und der aktualisierte Preis sind erforderlich. |
REQUIREMENTS_NOT_MET |
Bedingungen für die Annahme der Bestellung nicht erfüllt – Mindestbestellmenge usw. |
TOO_LATE |
Auftragsausführungsoption abgelaufen. |
NO_CAPACITY |
Keine Dienstkapazität verfügbar. Verwenden Sie diesen Fehlercode, wenn keiner der detaillierteren Fehlertypen zutrifft. |
NO_COURIER_AVAILABLE |
Es wurde kein Kurierdienst gefunden. Ein detaillierter Fehlertyp, der als NO_CAPACITY kategorisiert werden kann. |
INELIGIBLE |
Nutzer kann keine Bestellung aufgeben (auf schwarzer Liste). |
OUT_OF_SERVICE_AREA |
Lieferung an die gewünschte Adresse aufgrund von Grenzregelungen usw. nicht möglich. |
CLOSED |
Das Restaurant ist während der Bestellung geschlossen. |
PROMO_NOT_APPLICABLE |
Generischer Fehlercode, um alle Fälle zu erfassen, in denen der Gutscheincode nicht eingelöst wird, falls keiner der folgenden Punkte zutrifft. Fügen Sie den Gutscheincode als Entitäts-ID hinzu. |
PROMO_NOT_RECOGNIZED |
Der Gutscheincode wurde vom Partner nicht erkannt. Fügen Sie den Gutscheincode als Entitäts-ID hinzu. |
PROMO_EXPIRED |
Das Angebot konnte nicht angewendet werden, weil es abgelaufen ist. Fügen Sie den Gutscheincode als Entitäts-ID hinzu. |
PROMO_USER_INELIGIBLE |
Der aktuelle Nutzer kann diesen Gutschein nicht einlösen. Fügen Sie den Gutscheincode als Entitäts-ID hinzu. |
PROMO_ORDER_INELIGIBLE |
Dieser Gutschein kann nicht für die aktuelle Bestellung eingelöst werden. Fügen Sie den Gutscheincode als Entitäts-ID hinzu. |
UNAVAILABLE_SLOT |
Der Slot für die Vorbestellungen ist nicht verfügbar. |
FAILED_PRECONDITION |
Bedingungen für die Annahme der Bestellung nicht erfüllt - Mindestbestellmenge für Warenkorb usw. |
PAYMENT_DECLINED |
Ungültige Zahlung. |
MERCHANT_UNREACHABLE |
Der Händler ist nicht erreichbar. Das ist hilfreich, wenn ein Partner ein Aggregator ist und den Händler nicht erreichen konnte. |
ACCOUNT_LINKING_FAILED |
Der Händler hat versucht, das Google-Konto des Nutzers mit einem Konto in seinem System zu verknüpfen. Dabei ist jedoch ein Fehler aufgetreten. |
TicketOrderExtension
Bestelle Inhalte für Ticketbestellungen wie Kino, Sport usw.
JSON-Darstellung | |
---|---|
{
"ticketEvent": {
object ( |
Felder | |
---|---|
ticketEvent |
Das Ereignis, das auf alle Werbebuchungstickets angewendet wurde. |
TicketEvent
Stellt ein einzelnes Ereignis dar.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich: Art des Ticketereignisses, z. B. Film, Konzert |
name |
Erforderlich: Name des Ereignisses Wenn das Ereignis beispielsweise ein Film ist, sollte dies der Filmname sein. |
description |
Beschreibung der Veranstaltung. |
url |
URL zu den Ereignisinformationen. |
location |
Der Ort, an dem das Ereignis stattfindet, oder eine Organisation. |
eventCharacters[] |
Die Zeichen im Zusammenhang mit diesem Ereignis. Das können Regisseure oder Schauspieler eines Filmereignisses oder Darsteller eines Konzerts sein. |
startDate |
Start. |
endDate |
Ende. |
doorTime |
Eintrittszeitpunkt, der sich von der Startzeit der Veranstaltung unterscheiden kann, z. B. um 9:00 Uhr, aber um 8:30 Uhr. |
Typ
Der Typ des Ereignisses.
Enums | |
---|---|
EVENT_TYPE_UNKNOWN |
Unbekannter Ereignistyp. |
MOVIE |
Film. |
CONCERT |
Konzert. |
SPORTS |
Sport |
EventCharacter
Ein Termincharakter, z.B. Organisator, Künstler usw.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Typ des Ereignischarakters, z. B. Schauspieler oder Regisseur |
name |
Name der Figur. |
image |
Bilder der Charaktere |
Typ
Zeichentyp.
Enums | |
---|---|
TYPE_UNKNOWN |
Unbekannter Typ. |
ACTOR |
Schauspieler. |
PERFORMER |
Künstler |
DIRECTOR |
Einen Regisseur |
ORGANIZER |
Organisator. |
UserNotification
Optionale Nutzerbenachrichtigung, die im Rahmen der Bestellaktualisierung angezeigt wird.
JSON-Darstellung | |
---|---|
{ "title": string, "text": string } |
Felder | |
---|---|
title |
Der Titel für die Nutzerbenachrichtigung. Die maximal zulässige Länge beträgt 30 Zeichen. |
text |
Der Inhalt der Benachrichtigung. Die maximal zulässige Länge beträgt 100 Zeichen. |
NextScene
Stellt die Szene dar, die als Nächstes ausgeführt werden soll.
JSON-Darstellung | |
---|---|
{ "name": string } |
Felder | |
---|---|
name |
Name der Szene, die als Nächstes ausgeführt werden soll. |
Sitzung
Enthält Informationen zur aktuellen Unterhaltungssitzung
JSON-Darstellung | |
---|---|
{
"id": string,
"params": {
string: value,
...
},
"typeOverrides": [
{
object ( |
Felder | |
---|---|
id |
Erforderlich. Global eindeutige ID der aktuellen Unterhaltungssitzung. Dieses Feld ist schreibgeschützt. |
params |
Erforderlich. Liste aller Parameter, die während der Sitzung aus Formularen und Intents erfasst wurden. Schlüssel ist der Parametername. Die hier definierten Parameter werden mit den Parametern zusammengeführt, die bereits in der Sitzung definiert wurden. Parameter mit einem Nullwert werden aus der Sitzung entfernt. Weitere Informationen finden Sie in der Dokumentation zum Sitzungsspeicher: https://developers.google.com/assistant/conversational/storage-session. Ein Objekt, das eine Liste von |
typeOverrides[] |
Optional. Auf die Sitzung beschränkte Typen. Die Definition des Sitzungstyps kann vorhandene Typen ergänzen oder ersetzen. Typnamen müssen eindeutig sein. |
languageCode |
Sprache der aktuellen Unterhaltungssitzung. Entspricht dem IETF-BCP-47-Sprachcode http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Dies kann vom Gebietsschema des Nutzers abweichen, wenn bei der Aktion mehrsprachige Funktionen verwendet werden. Wenn beispielsweise „Handler_response.expected.language_code“ festgelegt ist, wird die Sprache der Unterhaltung für alle folgenden Abzweigungen geändert, was in diesem Feld angezeigt wird. |
TypeOverride
Stellt eine Überschreibung für einen Typ dar.
JSON-Darstellung | |
---|---|
{ "name": string, "mode": enum ( |
Felder | |
---|---|
name |
Erforderlich. Name des Typs, der ergänzt oder überschrieben werden soll. |
mode |
Erforderlich. Gibt an, wie dieser Typ mit anderen Typwerten zusammengeführt werden soll. |
synonym |
|
TypeOverrideMode
Die Änderungsarten für einen Sitzungsentitätstyp.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Nicht angegeben. Dieser Wert sollte nicht verwendet werden. |
TYPE_REPLACE |
Die Typdefinitionen in dieser Antwort ersetzen die zuvor definierten Typdefinitionen. |
TYPE_MERGE |
Die Typdefinitionen in dieser Antwort werden mit Typdefinitionen zusammengeführt, die zuvor definiert wurden. Neue Typdefinitionen überschreiben vorhandene Typdefinitionen. |
SynonymType
Stellt einen Typ mit Synonymen dar.
JSON-Darstellung | |
---|---|
{
"entries": [
{
object ( |
Felder | |
---|---|
entries[] |
Erforderlich. Liste der Einträge für den Synonymtyp. |
Eintrag
Stellt einen Eintrag für einen Synonymtyp dar.
JSON-Darstellung | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
Felder | |
---|---|
name |
Erforderlich. Name des Eintrags (z. B. „Fahrrad“) Der Eintrag in diesem Feld muss im Feld für wiederholte Synonyme enthalten sein, damit er als gültiger Typwert neu interpretiert werden kann. |
synonyms[] |
Erforderlich. Liste mit Synonymen für den Eintrag (z.B. „Fahrrad“, „Fahrrad“). |
display |
Optional. Die Informationen zum Artikel werden angezeigt. |
EntryDisplay
JSON-Darstellung | |
---|---|
{ "title": string, "description": string, "image": { object ( |
Felder | |
---|---|
title |
Erforderlich. Titel des Artikels Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel darf innerhalb der Gruppe von Sammlungselementen nur einmal vorkommen. |
description |
Optional. Text der Karte |
image |
Optional. Das Bild, das angezeigt werden soll. |
footer |
Optional. Fußzeilentext für das durchsuchende Sammlungselement, angezeigt unter der Beschreibung. Einzelne Textzeile, durch Auslassungspunkte abgeschnitten. |
openUrl |
URL des Dokuments, das mit dem Karussellelement zum Durchsuchen verknüpft ist. Erforderlich zum Durchsuchen des Karussells. |
Nutzer
Stellt den Nutzer dar, der eine Anfrage an die Aktion sendet.
JSON-Darstellung | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
Felder | |
---|---|
locale |
Primäre Spracheinstellung des Nutzers, der die Anfrage stellt. Entspricht dem IETF-BCP-47-Sprachcode http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Das Skript-Subtag ist jedoch nicht enthalten. |
params |
Optional. Liste aller Parameter, die dem aktuellen Nutzer zugeordnet sind. Weitere Informationen finden Sie in der Dokumentation zum Nutzerspeicher: https://developers.google.com/assistant/conversational/storage-user. Ein Objekt, das eine Liste von |
accountLinkingStatus |
Gibt an, ob das Nutzerkonto mit der App verknüpft ist. |
verificationStatus |
Gibt den Bestätigungsstatus des Nutzers an. |
lastSeenTime |
Zeitstempel der letzten Interaktion mit diesem Nutzer Dieses Feld wird weggelassen, wenn der Nutzer noch nicht mit dem Agent interagiert hat. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
engagement |
Die Interaktion des aktuellen Nutzers, einschließlich Abos für Intents. |
packageEntitlements[] |
Die Berechtigungen des Nutzers für das Android-Paket, das der aktuellen Aktion zugeordnet ist. |
permissions[] |
Enthält Berechtigungen, die der Nutzer für diese Aktion gewährt hat. |
AccountLinkingStatus
Gibt an, ob der Endnutzer sein Konto mit dieser App verknüpft hat. Weitere Informationen finden Sie in der Dokumentation zur Kontoverknüpfung: https://developers.google.com/assistant/identity.
Enums | |
---|---|
ACCOUNT_LINKING_STATUS_UNSPECIFIED |
Unbekannt. |
NOT_LINKED |
Der Nutzer hat sein Konto nicht mit dieser App verknüpft. |
LINKED |
Der Nutzer hat sein Konto mit dieser App verknüpft. |
UserVerificationStatus
Gibt an, ob der Nutzer von Google überprüft wurde. Der Status VERIFIED (BESTÄTIGT) bedeutet, dass Sie Daten in mehreren Konversationen mithilfe des Felds "Parameter" oder über die Kontoverknüpfung speichern können.
Enums | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED |
Unbekannt. |
GUEST |
Gastnutzer. |
VERIFIED |
Bestätigter Nutzer. |
Engagement
Bietet zusätzliche schreibgeschützte Informationen darüber, für welche Mechanismen der aktuelle Nutzer sich registriert hat. Es kann beispielsweise nützlich sein, zu wissen, welche Intents der Nutzer bereits abonniert hat. So wird vermieden, dass der Nutzer denselben Intent noch einmal abonnieren muss. Das heißt, diese Informationen können nur dann verwendet werden, wenn der Nutzer den Intent unter bestimmten Bedingungen an eine Szene weiterleitet, um DailyUpdates oder PushNotifications einzurichten. Weitere Informationen finden Sie in der Dokumentation zum Nutzer-Engagement: https://developers.google.com/assistant/engagement.
JSON-Darstellung | |
---|---|
{ "pushNotificationIntents": [ { object ( |
Felder | |
---|---|
pushNotificationIntents[] |
Enthält eine Liste von Intents, für die der Nutzer Push-Benachrichtigungen aktiviert hat. |
dailyUpdateIntents[] |
Enthält eine Liste von Intents, für die der Nutzer ein tägliches Update aktiviert hat. |
IntentSubscription
Beschreibt ein vorhandenes IntentSubscription.
JSON-Darstellung | |
---|---|
{ "intent": string, "contentTitle": string } |
Felder | |
---|---|
intent |
Name des Intents, der abonniert wurde. |
contentTitle |
Eine kurze Beschreibung des Abos. Sie wird als Label für die Benachrichtigung verwendet und wenn Assistant eine Berechtigung vom Nutzer anfordert. |
PackageEntitlements
Eine Liste der Nutzerberechtigungen für einen Paketnamen. Weitere Informationen finden Sie in der Dokumentation zu digitalen Warentransaktionen: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.
JSON-Darstellung | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
Felder | |
---|---|
packageName |
Der im Aktionspaket angegebene Android-Paketname. |
entitlements[] |
Die Berechtigungen des Nutzers für das angegebene Paket. |
Berechtigung
Definiert die digitale Berechtigung eines Nutzers.
JSON-Darstellung | |
---|---|
{ "sku": string, "skuType": enum ( |
Felder | |
---|---|
sku |
Produkt-SKU Paketname für kostenpflichtige App, Suffix „Finsky docid“ für In-App-Käufe und In-App-Abos. Stimmt mit „getSku()“ in der Play InApp Billing API überein. Weitere Informationen finden Sie in der Dokumentation zur In-App-Abrechnung in Google Play: https://developer.android.com/google/play/billing. |
skuType |
Der SKU-Typ. |
inAppDetails |
Nur für In-App-Käufe und In-App-Abos vorhanden. |
SkuType
Enums | |
---|---|
SKU_TYPE_UNSPECIFIED |
|
IN_APP |
In-App-Kauf |
SUBSCRIPTION |
Abos |
APP |
Kostenpflichtige Apps |
SignedData
JSON-Darstellung | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
Felder | |
---|---|
inAppPurchaseData |
Enthält alle Daten zu In-App-Käufen im JSON-Format. Weitere Informationen findest du in Tabelle 6 unter https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
Stimmt mit IN_APP_DATA_SIGNATURE aus der getPurchases()-Methode in der Play InApp Billing API überein. |
Berechtigung
Mögliche Werte für Berechtigung.
Enums | |
---|---|
PERMISSION_UNSPECIFIED |
Unbekannte Berechtigung. |
DEVICE_PRECISE_LOCATION |
Fragen Sie den Nutzer nach dem genauen Standort, dem Breiten- und Längengrad und der formatierten Adresse. |
DEVICE_COARSE_LOCATION |
Fragen Sie nach dem ungefähren Standort, der Postleitzahl, der Stadt und dem Ländercode des Nutzers. |
UPDATE |
Fragen Sie nach Berechtigungen zum Senden von Updates. Weitere Informationen finden Sie unter https://developers.google.com/assistant/engagement/daily. |
Startseite
Stellt die HomeGraph-Struktur dar, zu der das Zielgerät des Nutzers gehört.
JSON-Darstellung | |
---|---|
{ "params": { string: value, ... } } |
Felder | |
---|---|
params |
Optional. Liste der Parameter, die mit der HomeGraph-Struktur verknüpft sind, zu der das Zielgerät gehört. Weitere Informationen finden Sie in der Dokumentation zum Speicherplatz für zu Hause: https://developers.google.com/assistant/conversational/storage-home. Ein Objekt, das eine Liste von |
Gerät
Stellt das Gerät dar, das der Nutzer für eine Anfrage an die Aktion verwendet.
JSON-Darstellung | |
---|---|
{ "capabilities": [ enum ( |
Felder | |
---|---|
capabilities[] |
Erforderlich: die Funktionen des Geräts, das eine Anfrage an die Aktion sendet. |
currentLocation |
Optional. Der Gerätestandort des Nutzers. Hinweis: Dieses Feld wird nur ausgefüllt, wenn der Endnutzer die Berechtigung zur Standortermittlung erteilt hat. In der Standortnachricht finden Sie weitere Informationen dazu, welche Felder je nach grober bzw. detaillierter Berechtigung festgelegt werden. Weitere Informationen finden Sie in der Dokumentation zu Berechtigungen: https://developers.google.com/assistant/conversational/permissions. |
timeZone |
Optional. Zeitzone, die dem Clientgerät zugeordnet ist. Damit können Datum/Uhrzeit-Werte aufgelöst werden. |
Funktion
Funktionen, die die Geräteoberfläche zum Zeitpunkt der Anfrage unterstützt.
Enums | |
---|---|
UNSPECIFIED |
Nicht angegebene Gerätefunktion. |
SPEECH |
Das Gerät kann über Sprachausgabe oder SSML mit dem Nutzer sprechen. |
RICH_RESPONSE |
Auf dem Gerät können aussagekräftige Antworten wie Karten, Listen und Tabellen angezeigt werden. |
LONG_FORM_AUDIO |
Auf dem Gerät können auch lange Audiomedien wie Musik und Podcasts abgespielt werden. |
INTERACTIVE_CANVAS |
Das Gerät kann eine interaktive Canvas-Antwort anzeigen. |
WEB_LINK |
Auf dem Gerät können Weblinks in Rich-Antworten verwendet werden, um einen Webbrowser zu öffnen. |
HOME_STORAGE |
Das Gerät unterstützt das Speichern und Abrufen von Speicherplatz für dein Zuhause. |
Standort
Container, der einen Standort darstellt.
JSON-Darstellung | |
---|---|
{ "coordinates": { object ( |
Felder | |
---|---|
coordinates |
Geokoordinaten: Die Berechtigung [DEVICE_PRECISE_LOCATION] ist erforderlich. |
postalAddress |
Postanschrift. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION]. Wenn die Berechtigung zur groben Standortbestimmung gewährt wurde, werden nur die Felder „postalCode“ und „Ort“ ausgefüllt. Durch die Berechtigung für den genauen Standort werden zusätzliche Felder wie „administrativeArea“ und „addressLines“ ausgefüllt. |
TimeZone
Stellt eine Zeitzone aus der IANA-Zeitzonendatenbank dar.
JSON-Darstellung | |
---|---|
{ "id": string, "version": string } |
Felder | |
---|---|
id |
Zeitzone aus der IANA-Zeitzonendatenbank, z. B. "Amerika/New_York". |
version |
Optional. Versionsnummer der IANA-Zeitzonendatenbank, z. B. "2019a". |
Kontext
Enthält Kontextinformationen, wenn der Nutzer eine Anfrage stellt. Dieser Kontext umfasst unter anderem Informationen zur aktiven Mediensitzung, zum Status der Canvas-Web-App usw.
JSON-Darstellung | |
---|---|
{ "media": { object ( |
Felder | |
---|---|
media |
Enthält Kontextinformationen zur aktuellen aktiven Mediensitzung. |
canvas |
Enthält Kontextinformationen zum aktuellen Canvas. |
MediaContext
Enthält Kontextinformationen zur aktuellen aktiven Mediensitzung.
JSON-Darstellung | |
---|---|
{ "progress": string, "index": integer } |
Felder | |
---|---|
progress |
Medienfortschritt der aktuell aktiven Mediendatei. Dauer in Sekunden mit bis zu neun Nachkommastellen und einem ' |
index |
0-basierter Index der aktuell aktiven Mediendatei in der Liste der Mediendateien in der Medienantwort. |
CanvasContext
Enthält Kontextinformationen zum aktuellen Canvas.
JSON-Darstellung | |
---|---|
{ "state": value } |
Felder | |
---|---|
state |
Optional. Der Status wird von der Drittanbieter-App „Interactive Canvas“ festgelegt. Dieser Status wird nur für Anfragen festgelegt, nicht für Antworten. Wenn dies beispielsweise eine Rezeptanwendung ist, kann der Zustand ein Wert von struct sein : { "current_page" : 5, "last_page" : 3, } Die Größenbeschränkung beträgt 50 KB. |
Erwartet
Beschreibt die Erwartungen an den nächsten Dialog.
JSON-Darstellung | |
---|---|
{ "speech": [ string ] } |
Felder | |
---|---|
speech[] |
Liste der Wortgruppen, die die Aktion von der Äußerung des Nutzers für die Sprachgewichtung erwartet. Es sind bis zu 1.000 Wortgruppen erlaubt. Hinweis: Dieses Feld hat die gleiche Bedeutung wie „ErwarteteInput.speech_biasing_hints“ in der API v2. |