- HTTP-Anfrage
- Anfragetext
- Antworttext
- Handler
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Absicht
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- IntentParameterValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Szene
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SlotFillingStatus
- Steckplatz
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SlotMode
- SlotStatus
- Prompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Einfach
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Inhalt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Kartenspiele
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Image
- ImageFill
- Link
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OpenUrl
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- UrlHint
- Table
- TableColumn
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- HorizontalAlignment
- TableRow
- TableCell
- Medien
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MediaType
- OptionalMediaControls
- MediaObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MediaImage
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- RepeatMode
- Sammlung
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CollectionItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Auflistung
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ListItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CollectionBrowse
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Element
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Vorschlag
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Leinwand
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ContinuousMatchConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ExpectedPhrase
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OrderUpdate
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- Bestellen
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Nutzerinformationen
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PhoneNumber
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Image
- Händler
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Ort
- LatLng
- PostalAddress
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Inhalt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- LineItem
- PriceAttribute
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- Bundesland
- Geld
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Aktion
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- OpenUrlAction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- AndroidApp
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- VersionFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- UrlTypeHint
- ActionMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Offenlegung
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DisclosureText
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TextLink
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DisclosurePresentationOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PresentationRequirement
- PurchaseItemExtension
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PurchaseStatus
- PurchaseType
- MerchantUnitMeasure
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Einheit
- PurchaseReturnsInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PurchaseFulfillmentInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- Zeit
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PickupInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PickupType
- CurbsideInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CurbsideFulfillmentType
- Fahrzeug
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CheckInInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CheckInType
- ItemOption
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ProductDetails
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ReservationItemExtension
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ReservationStatus
- ReservationType
- StaffFacilitator
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PaymentData
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PaymentResult
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PaymentInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PaymentMethodDisplayInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PaymentType
- PaymentMethodProvenance
- Angebot
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PurchaseOrderExtension
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PurchaseLocationType
- PurchaseError
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ErrorType
- TicketOrderExtension
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TicketEvent
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- EventCharacter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- UserNotification
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NextScene
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Sitzung
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TypeOverride
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TypeOverrideMode
- SynonymType
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Einstieg
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- EntryDisplay
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Nutzer
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- AccountLinkingStatus
- UserVerificationStatus
- Interaktion
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- IntentSubscription
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PackageEntitlements
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Berechtigung
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SkuType
- SignedData
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Berechtigung
- Startseite
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Gerät
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Funktion
- Location
- TimeZone
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Kontext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MediaContext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CanvasContext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Voraussichtliches
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
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 Auftragsausführung zur Verarbeitung der Anfrage. Beispielsweise kann eine Anfrage zum Abrufen eines Fakten über einen Handler mit dem Namen „getFact“ verfügen. |
intent |
Erforderlich. Stellt den letzten zugeordneten Intent dar. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/intents. |
scene |
Optional. Informationen zur aktuellen und nächsten Szene, wenn die Funktion aufgerufen wurde. Wird ausgefüllt, wenn der Auftragsausführungsaufruf im Bereich 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 begonnen 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 verwendet, um mit der Aktion zu interagieren. |
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 die Prompts dar, die an den Nutzer gesendet werden sollen. Diese Prompts werden an zuvor hinzugefügte Nachrichten angehängt, sofern sie nicht ausdrücklich überschrieben werden. |
scene |
Optional. Stellt die aktuelle und die nächste Szene dar. Wenn |
session |
Optional. Beschreibt Daten für die aktuelle Sitzung. Sitzungsparameter können durch die Auftragsausführung erstellt, aktualisiert oder entfernt werden. |
user |
Optional. Hiermit können Sie Nutzerparameter angeben, 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. Wird verwendet, um zwischen Assistant-Geräten zu 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 aus Actions on Google der Auftragsausführung zuordnet. Bestimmen Sie anhand des Handler-Namens, welcher Code in der Auftragsausführung ausgeführt werden soll. Beispielsweise kann ein Handler verwendet werden, um Informationen zu den Bestellinformationen eines Nutzers mit einem Handler-Namen wie „OrderLookup“ abzurufen. während eine andere Produktinformationen aus einer Datenbank mit einem Handler-Namen wie „GetProductInfo“ abrufen kann.
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 wurden. 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. Eingegebene oder gesprochene Eingabe des Endnutzers, der diesem Intent zugeordnet wurde. 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 Nutzereingabe extrahiert wurde. Dieses Feld wird nur ausgefüllt, wenn der Parameter im zugeordneten Intent definiert ist und der Wert des Parameters während des Intent-Abgleichs identifiziert werden konnte. |
Szene
Eine Szene darstellen. Szenen können die Auftragsausführung aufrufen, Prompts hinzufügen und Slot-Werte vom Nutzer erfassen. Szenen werden durch Ereignisse oder Intents ausgelöst und können Ereignisse auslösen und Intents zuordnen, um zu anderen Szenen zu wechseln.
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 mit der aktuellen Szene verknüpften Zeitblöcke. 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 ausgeführt werden soll. |
SlotFillingStatus
Der aktuelle Status der Slot-Füllung.
Enums | |
---|---|
UNSPECIFIED |
Fallbackwert, wenn das Feld „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 Anzeigenflächenwerte sind endgültig und können nicht geändert werden. |
Anzeigenfläche
Stellt eine Anzeigenfläche dar.
JSON-Darstellung | |
---|---|
{ "mode": enum ( |
Felder | |
---|---|
mode |
Der Modus des Slots (erforderlich oder optional). Kann vom Entwickler festgelegt werden. |
status |
Der Status des Slots. |
value |
Der Wert des Slots. Wenn Sie diesen Wert in der Antwort ändern, wird der Wert in der Slot-Füllung geändert. |
updated |
Gibt an, ob der Slotwert in der letzten Runde erfasst wurde. Dieses Feld ist schreibgeschützt. |
prompt |
Optional. Diese Aufforderung wird an den Nutzer gesendet, wenn er einen erforderlichen Slot füllen muss. Dieser Prompt überschreibt den vorhandenen Prompt, der in der Konsole definiert ist. Dieses Feld ist nicht in der Webhook-Anfrage enthalten. |
SlotMode
Der Modus einer Anzeigenfläche, d. h., ob er erforderlich ist oder nicht.
Enums | |
---|---|
MODE_UNSPECIFIED |
Fallbackwert, wenn das Feld „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
Der Status eines Slots.
Enums | |
---|---|
SLOT_UNSPECIFIED |
Fallbackwert, wenn das Feld „Nutzung“ nicht ausgefüllt ist. |
EMPTY |
Gibt an, dass die Anzeigenfläche 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. |
Prompt
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 zum Zusammenführen dieser Nachrichten mit zuvor definierten Nachrichten. „wahr“ löscht alle zuvor definierten Nachrichten (erste und letzte einfache Nachricht, Inhalt, Link für Vorschläge und Canvas) und fügt in diesem Prompt definierte Nachrichten hinzu. „false“ fügt die in diesem Prompt definierten Nachrichten zu den in früheren Antworten definierten Nachrichten hinzu. Belassen dieses Felds auf „false“ ermöglicht auch das Anfügen an einige Felder in einfachen Prompts, der Aufforderung „Vorschläge“ und der Canvas-Aufforderung (Teil der Inhaltsaufforderung). Die Inhalts- und Linkmeldungen werden immer überschrieben, wenn sie in der Aufforderung definiert sind. Der Standardwert ist „false“. |
firstSimple |
Optional. Die erste reine Sprach- und Textantwort. |
content |
Optional. Ein Inhalt wie eine Karte, eine Liste oder ein Medium, das bzw. der dem Nutzer angezeigt werden soll. |
lastSimple |
Optional. Die letzte reine Sprach- und Textantwort. |
suggestions[] |
Optional. Vorschläge, die dem Nutzer angezeigt werden und immer am Ende der Antwort angezeigt werden. Wenn die „Überschreibung“ im zugehörigen Prompt auf „false“ gesetzt ist, werden die in diesem Feld definierten Titel den Titeln hinzugefügt, die in zuvor definierten Prompts 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 verweisen kann. 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 reagiert mit einem OrderUpdate, nachdem sie die Bestellung während des Transaktionsflusses erhalten hat. Nach Erhalt der Bestellung zeichnet Google die Aktualisierung auf. Ist die Bestellung erfolgreich, wird eine Belegkarte zusammen mit der auf Anzeigegeräten gesendeten Sprachausgabe angezeigt. |
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 dem Nutzer vorgelesen werden soll. Kann SSML oder Sprachausgabe sein. Wenn die „Überschreibung“ im enthaltenen Prompt auf „true“ gesetzt ist, ersetzt die in diesem Feld definierte Sprache die vorherige einfache Prompt-Sprache. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/ssml. |
text |
Optionaler Text, der im Infofeld angezeigt wird. Wenn nicht angegeben, wird eine Anzeigedarstellung des obigen Sprachfelds verwendet. Auf 640 Zeichen begrenzt. Wenn die „Überschreibung“ im enthaltenen Prompt auf „true“ gesetzt ist, wird der in diesem Feld definierte Text durch den vorherigen einfachen Prompt-Text ersetzt. |
Inhalt
Containerobjekt für umfassende Prompts oder Auswahl-Prompts.
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld Für |
||
card |
Eine einfache Karte. |
|
image |
Ein Bild. |
|
table |
Tabellenkarte. |
|
media |
Antwort, die eine Gruppe von Medien angibt, die abgespielt werden sollen. |
|
collection |
Eine Karte mit einer Auswahl von Optionen. |
|
list |
Eine Karte mit einer Liste von Optionen zur Auswahl. |
|
collectionBrowse |
Eine Karte mit einer Sammlung von Webseiten, die geöffnet werden können. |
Infokarte
Eine einfache Karte zur Anzeige einiger Informationen, z.B. einem 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 |
Der Text der Karte. Unterstützt einen begrenzten Satz 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, das für Barrierefreiheit verwendet werden soll, z.B. Screenreadern. Erforderlich. |
height |
Die Höhe des Bilds in Pixeln Optional. |
width |
Die Breite des Bilds in Pixeln Optional. |
ImageFill
Mögliche Anzeigeoptionen für Bilder, um die Darstellung des Bildes zu beeinflussen Dieser Parameter sollte verwendet werden, wenn das Seitenverhältnis des Bilds nicht mit dem des Bildcontainers übereinstimmt.
Enums | |
---|---|
UNSPECIFIED |
|
GRAY |
Schließen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit grauen Balken. |
WHITE |
Schließen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit weißen Balken. |
CROPPED |
Das Bild wird so skaliert, dass die Bildbreite und -höhe den Containerabmessungen entsprechen oder diese überschreiten. Dadurch kann der obere und untere Bereich des Bilds zugeschnitten werden, wenn die skalierte Bildhöhe größer als die Containerhöhe ist, oder der linke und rechte Teil des Bilds, wenn die skalierte Bildbreite größer als die Containerbreite ist. Dies ähnelt dem „Zoom-Modus“ auf einem Breitbildfernseher. |
Link
Ein zusätzlicher Vorschlags-Chip, der auf die verknüpfte App oder Website verweisen kann. Der Chip wird mit dem Titel „Offen (Name)“ gerendert.
JSON-Darstellung | |
---|---|
{
"name": string,
"open": {
object ( |
Felder | |
---|---|
name |
Name des Links. Maximal 20 Zeichen |
open |
Was passiert, wenn ein Nutzer den Link öffnet? |
OpenUrl
JSON-Darstellung | |
---|---|
{
"url": string,
"hint": enum ( |
Felder | |
---|---|
url |
Das URL-Feld, entweder http- oder https-URLs zum Öffnen einer mit Apps 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 |
Eine URL, die direkt auf AMP-Inhalte oder eine kanonische URL verweist, 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 aber festgelegt werden, wenn eine Untertitel festgelegt wurde. |
subtitle |
Untertitel für die Tabelle. Optional. |
image |
Mit der Tabelle verknüpftes Bild. Optional. |
columns[] |
Überschriften und Ausrichtung von Spalten. |
rows[] |
Zeilendaten der Tabelle. Die ersten 3 Zeilen werden garantiert angezeigt, aber die anderen werden möglicherweise an bestimmten Oberflächen abgeschnitten. Führen Sie einen Test mit dem Simulator durch, um zu sehen, welche Zeilen für eine bestimmte Oberfläche angezeigt werden. Auf Oberflächen, die die WEB_BROWSER-Funktion unterstützen, kannst du den Nutzer auf eine Webseite mit weiteren Daten verweisen. |
button |
Schaltfläche. |
TableColumn
JSON-Darstellung | |
---|---|
{
"header": string,
"align": enum ( |
Felder | |
---|---|
header |
Überschrift für die Spalte. |
align |
Horizontale Ausrichtung des Inhalts mit der Spalte. Wenn kein Wert angegeben ist, wird der Inhalt an der Spitze ausgerichtet. |
HorizontalAlignment
Die Ausrichtung des Inhalts innerhalb der Zelle.
Enums | |
---|---|
UNSPECIFIED |
|
LEADING |
Oberste Kante der Zelle. Das ist die Standardeinstellung. |
CENTER |
Der Inhalt ist in der Mitte der Spalte ausgerichtet. |
TRAILING |
Der Inhalt ist am Ende 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, aber andere werden möglicherweise an bestimmten Oberflächen ausgeschnitten. Führen Sie einen Test mit dem Simulator durch, um zu sehen, welche Zellen für eine bestimmte Oberfläche angezeigt werden. |
divider |
Gibt an, ob nach jeder Zeile eine Trennlinie vorhanden sein 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 zum Medium, 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 Mediensteuerungstypen, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, wird die Anfrage an 3p gesendet, wenn ein bestimmtes Medienereignis eintritt. Wenn die Richtlinie nicht konfiguriert ist, muss 3p dennoch die beiden Standardsteuerungstypen FINISHED und FAILED verarbeiten. |
mediaObjects[] |
Liste der Medienobjekte |
repeatMode |
Wiederholungsmodus für die Liste der Medienobjekte. |
firstMediaObjectIndex |
0-basierter Index des ersten Medienobjekts in mediaObjects, das wiedergegeben werden soll. Falls nicht angegeben, null oder außerhalb des gültigen Bereichs, beginnt die Wiedergabe beim ersten Medienobjekt in "mediaObjects". |
MediaType
Medientyp dieser Antwort.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
|
AUDIO |
Audiodatei. |
MEDIA_STATUS_ACK |
Antwort, um einen Medienstatusbericht zu bestätigen. |
OptionalMediaControls
Optionale Mediensteuerungstypen, die die Medienantwort unterstützen kann
Enums | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Nicht angegebener Wert |
PAUSED |
Ereignis pausiert. Wird ausgelöst, wenn der Nutzer die Medien pausiert. |
STOPPED |
Ereignis wurde beendet. Wird ausgelöst, wenn der Nutzer die Drittanbietersitzung während der Medienwiedergabe beendet. |
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 werden soll. |
MediaImage
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld Für |
||
large |
Ein großes Bild, z. B. das Cover des Albums |
|
icon |
Ein kleines Bildsymbol rechts neben dem Titel. Die Größe wird auf 36 x 36 dp reduziert. |
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 |
Wechselt zum Anfang des ersten Medienobjekts, wenn das Ende des letzten Medienobjekts erreicht ist. |
Sammlung
Eine Karte, auf der eine Sammlung von Optionen präsentiert wird. 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 mit Elementen. Er kann einen Mindestwert von 2 und einen Höchstwert von 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 Eingabeschlüssels im verknüpften Typ übereinstimmt. |
Liste
Eine Karte, auf der eine Liste mit Optionen präsentiert wird. 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 mit Elementen. Er 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 Eingabeschlüssels im verknüpften Typ übereinstimmt. |
CollectionBrowse
Stellt eine Reihe von Webdokumenten als eine Sammlung groß gekachelter Elemente 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 mit Elementen. Er kann einen Mindestwert von 2 und einen Höchstwert von 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, der unter der Beschreibung angezeigt wird. Einzelne, mit Auslassungspunkten abgeschnittene Textzeile. |
image |
Bild für das Sammlungselement. |
openUriAction |
Erforderlich. URI, der geöffnet werden soll, wenn das Element ausgewählt ist. |
Vorschlag
Mithilfe von Vorschlägen werden Nutzern auf displayfähigen Geräten Chips für Vorschläge angezeigt, wenn Assistant die Aufforderung anzeigt. Mit Vorschlags-Chips können Sie Nutzer darauf hinweisen, dass sie die Unterhaltung fortsetzen oder neu ausrichten möchten. Wenn Sie auf einen Vorschlags-Chip tippen, wird der angezeigte Text wörtlich an die Unterhaltung zurückgegeben, so als hätte der Nutzer ihn eingegeben. Siehe https://developers.google.com/assistant/conversational/prompts#suggestions.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Erforderlich. Der Text, der im Vorschlags-Chip angezeigt wird. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss unter den Vorschlags-Chips eindeutig sein. Maximal 25 Zeichen |
Canvas
Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. Dies kann in Verbindung mit dem Tag "firstSimple" in der enthaltenden Aufforderung, 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-Webanwendung, die geladen werden soll. Wenn die Richtlinie nicht konfiguriert ist, wird die URL des aktuell aktiven Canvas wiederverwendet. |
data[] |
Optional. JSON-Daten, die als Ereignis an die Webseite des immersiven Erlebnisses übergeben werden. Wenn die „Überschreibung“ in der enthaltenen Aufforderung auf „false“ gesetzt ist Datenwerte, die in diesem Canvas-Prompt definiert wurden, werden nach den in vorherigen Canvas-Prompts definierten Datenwerten hinzugefügt. |
suppressMic |
Optional. Standardwert: false. |
continuousMatchConfig |
Konfiguration zum Initiieren des Modus für kontinuierliche Übereinstimmungen. |
ContinuousMatchConfig
Konfiguration zum Initiieren des Modus für kontinuierliche Übereinstimmungen.
JSON-Darstellung | |
---|---|
{
"expectedPhrases": [
{
object ( |
Felder | |
---|---|
expectedPhrases[] |
Alle möglichen während dieser Sitzung im Abgleichmodus möglichen erwarteten Wortgruppen. |
durationSeconds |
Dauer, für die der Modus „Kontinuierlicher Abgleich“ aktiviert bleibt. Falls angegeben, wird das Mikrofon deaktiviert, sobald die Zeit abgelaufen ist. Der maximal zulässige Wert ist 180. |
ExpectedPhrase
JSON-Darstellung | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
Felder | |
---|---|
phrase |
Die Wortgruppe, die während einer Sitzung im kontinuierlichen Abgleichsmodus abgeglichen werden soll. |
alternativePhrases[] |
Einige Wortgruppen werden vom Sprachmodell selbst bei der Sprachgewichtung möglicherweise falsch erkannt. So können Entwickler alternative Trigger für Homofone angeben. |
OrderUpdate
Aktualisieren Sie einen Auftrag.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Verworfen: Verwenden Sie stattdessen OrderUpdate.update_mask. Wenn Typ = SNAPSHOT, sollte „OrderUpdate.order“ die gesamte Bestellung enthalten. Wenn Typ = ORDER_STATUS, ist dies die Statusänderung auf Auftragsebene. Es werden nur „order.last_update_time“ und dieser Branchenstatus abgerufen. Hinweis: type.ORDER_STATUS unterstützt nur Statusaktualisierungen für PurcahaseOrderExtension und es ist nicht geplant, diesen Support zu verlängern. Stattdessen empfehlen wir die Verwendung von „updateMask“, da sie allgemeiner und erweiterbar ist und für alle Branchen verwendet werden kann. |
order |
|
updateMask |
Hinweis: Beachten Sie die folgenden Hinweise bzw. Empfehlungen für die folgenden speziellen Felder: 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“ angegeben sind. Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: |
userNotification |
Wenn angegeben, wird dem Nutzer eine Benachrichtigung mit dem angegebenen Titel und Text angezeigt. Die Angabe einer Benachrichtigung ist nur ein Vorschlag für eine Benachrichtigung und führt nicht zwangsläufig zu einer Benachrichtigung. |
reason |
Grund für die Änderung/Aktualisierung. |
Typ
Verworfen: Verwenden Sie stattdessen OrderUpdate.update_mask. Aktualisierungen für einen Auftrag 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. |
Auftrag
Bestellentität. Hinweis: 1. Alle Strings auf allen Ebenen müssen kürzer als 1.000 Zeichen sein, sofern nicht anders angegeben. 2. Alle wiederkehrenden Felder auf allen Ebenen müssen kleiner als 50 sein, sofern nicht anders angegeben. 3. Alle Zeitstempel auf allen Ebenen, sofern angegeben, müssen 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 Auftragsaktualisierungen erforderlich. Diese ID kann auf die angegebene googleOrderId oder einen anderen eindeutigen Wert festgelegt werden. Hinweis: Die ID, die Nutzern angezeigt wird, ist die userVisibleOrderId, die ein anderer, nutzerfreundlicherer Wert sein kann. Die maximal zulässige Länge beträgt 128 Zeichen. |
|
userVisibleOrderId |
Die an den Nutzer gerichtete ID, die auf die aktuelle Bestellung verweist. Diese ID muss mit der ID übereinstimmen, die in anderen Kontexten für diese Bestellung angezeigt wird, z. B. für Websites, Apps und E-Mails. |
|
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 einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
|
lastUpdateTime |
Datum und Uhrzeit der letzten Aktualisierung der Bestellung. Erforderlich für OrderUpdate. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
|
transactionMerchant |
Händler, der den Bezahlvorgang vereinfacht hat. Dies kann sich von einem Anbieter auf Werbebuchungsebene unterscheiden. Beispiel: Expedia-Auftrag mit Werbebuchung von ANA |
|
contents |
Erforderlich: Auftragsinhalt, der eine Gruppe von Werbebuchungen ist. |
|
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 bzw. vorgeschlagene Bestellung gelten. |
|
note |
Mit einer Bestellung verknüpfte Notizen. |
|
promotions[] |
Alle Angebote, die mit dieser Bestellung verknüpft sind. |
|
disclosures[] |
Mit dieser Anordnung verbundene Offenlegungen. |
|
vertical |
Eingestellt: Verwenden Sie stattdessen Branchen. Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie in einer Werbebuchung nicht überschrieben werden. Diese Branche muss dem Branchentyp auf Werbebuchungsebene entsprechen. Mögliche Werte: Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld |
|
Union-Feld verticals . Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie in einer Werbebuchung nicht ü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. Hiermit werden Informationen über den Nutzer dargestellt, 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 |
Der Anzeigename des Nutzers kann vom Vor- oder Nachnamen abweichen. |
phoneNumbers[] |
Telefonnummern des Nutzers |
PhoneNumber
Standardmäßige Darstellung der Telefonnummer
JSON-Darstellung | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
Felder | |
---|---|
e164PhoneNumber |
Telefonnummer im E.164-Format gemäß der Empfehlung E.164 der International Telecommunication Union (ITU). Wiki-Link: https://en.wikipedia.org/wiki/E.164 |
extension |
Erweiterungen sind in den ITU-Empfehlungen nicht standardisiert, mit der Ausnahme, dass sie als Zahlenreihe mit maximal 40 Ziffern definiert sind. Sie wird hier als String definiert, um die mögliche Verwendung einer führenden Null in der Erweiterung zu berücksichtigen (Unternehmen haben hierzu volle Freiheit, da es keinen Standard gibt). Neben Ziffern, einige andere Wahlzeichen wie "," (Wartezeit) können hier gespeichert werden. Beispiel: xxx-xxx-xxxx ext. 123, „123“ ist die Erweiterung. |
preferredDomesticCarrierCode |
Der Code zur Auswahl des Mobilfunkanbieters, der beim Anrufen dieser Telefonnummer im Inland bevorzugt wird. Das gilt auch für Codes, die in einigen Ländern gewählt werden müssen, wenn Sie vom Festnetz zum Mobiltelefon aus anrufen oder umgekehrt. In Kolumbien etwa wird durch eine „3“ muss vor der eigentlichen Telefonnummer gewählt werden, wenn Sie von einem Mobiltelefon zu einem Festnetztelefon im Inland anrufen, und umgekehrt. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code Dies ist die "bevorzugte" d. h. andere Codes können auch funktionieren. |
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, das für Barrierefreiheit verwendet werden soll, z.B. Screenreadern. Erforderlich. |
height |
Die Höhe des Bilds in Pixeln Optional. |
width |
Die Breite des Bilds in Pixeln Optional. |
Händler
Händler des Einkaufswagens/der Bestellung/der Werbebuchung.
JSON-Darstellung | |
---|---|
{ "id": string, "name": string, "image": { object ( |
Felder | |
---|---|
id |
Optionale ID, die dem Händler zugewiesen wird (sofern vorhanden). |
name |
Der Name des Händlers, z. B. "Panera-Brot". |
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 |
Geografische Koordinaten. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Anzeigeadresse, z.B. „1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA“. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
Postleitzahl. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
Stadt. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress |
Postanschrift. Erfordert [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 Geschäftsstandorts oder Telefonnummer des Lieferorts |
notes |
Notizen 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. Es wird als Paar aus Werten vom Typ „Double“ (Breiten- und Längengrad) 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 außerhalb der Länder, in denen dieses Feld verwendet wird, keine UI-Elemente zur 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 Auftragspositionen Mindestens eine Werbebuchung ist erforderlich, höchstens 50 sind zulässig. Alle Werbebuchungen müssen zur selben Branche gehören. |
LineItem
Eine Werbebuchung enthält eine Branche. Ein Auftrag oder ein Einkaufswagen kann mehrere Werbebuchungen derselben Branche enthalten. Unterwerbebuchungen/Add-ons usw. sollten je nach Anwendungsfall in vertikalen Protokollen definiert werden. Hinweis: 1. Alle Strings auf allen Ebenen müssen kürzer als 1.000 Zeichen sein, sofern nicht anders angegeben. 2. Alle wiederkehrenden Felder auf allen Ebenen müssen kleiner als 50 sein, sofern nicht anders angegeben. 3. Alle Zeitstempel auf allen Ebenen, sofern angegeben, müssen gültige Zeitstempel sein.
JSON-Darstellung | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
Felder | ||
---|---|---|
id |
Erforderlich: Dem Händler zugewiesene Kennung für die Werbebuchung. Wird verwendet, um vorhandene Positionen beim Anwenden 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 |
Verworfen. Verwenden Sie stattdessen den Status auf Branchenebene. Verwenden Sie beispielsweise für Käufe „PurchaseOrderExtension.status“. Für den Nutzer sichtbares Label für den Status dieser Werbebuchung. |
|
provider |
Der Anbieter der jeweiligen Werbebuchung, falls dieser vom Gesamtauftrag abweicht Beispiel: Expedia-Auftrag mit Werbebuchungsanbieter ANA |
|
priceAttributes[] |
Preis und Anpassungen auf Werbebuchungsebene. |
|
followUpActions[] |
Folgeaktionen in der Werbebuchung |
|
recipients[] |
Kunden auf Werbebuchungsebene. Diese kann sich vom Käufer auf Auftragsebene unterscheiden. Beispiel: Nutzer X hat eine Restaurantreservierung unter dem Namen von Nutzer Y vorgenommen. |
|
image |
Kleines Bild, das mit diesem Element verknüpft ist, falls vorhanden. |
|
description |
Werbebuchungsbeschreibung. |
|
notes[] |
Zusätzliche Hinweise, die für diese bestimmte Position gelten, z. B. Stornierungsrichtlinien |
|
disclosures[] |
Mit dieser Werbebuchung verknüpfte Offenlegungen. |
|
vertical |
Eingestellt: Verwenden Sie stattdessen Branchen. Erforderlich: Semantische Inhalte der Werbebuchung basierend auf ihrem Typ/der Branche. Für jede Branche sollten eigene Details zur Auftragsausführung angegeben werden. Muss einer der folgenden Werte sein: Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld |
|
Union-Feld verticals . Erforderlich: Semantische Inhalte der Werbebuchung basierend auf ihrem Typ/der Branche. Für jede Branche sollten eigene Details zur Auftragsausführung angegeben werden. Für verticals ist nur einer der folgenden Werte zulässig: |
||
purchase |
Bestellungen wie Waren, Lebensmittel usw. |
|
reservation |
Reservierungsbestellungen wie Restaurant, Haarschnitt usw. |
PriceAttribute
Preisattribut eines Auftrags oder einer Werbebuchung.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | ||
---|---|---|
type |
Erforderlich: Art des Geldattributs. |
|
name |
Erforderlich: Der vom Nutzer angezeigte String des Preisattributs. Wird vom Händler gesendet und lokalisiert. |
|
id |
Optional: ID der Position, zu der dieser Preis gehört. |
|
state |
Erforderlich: Preisangabe: Schätzung vs. tatsächlicher Wert. |
|
taxIncluded |
Gibt an, ob der Preis Steuern beinhaltet. |
|
Union-Feld spec . Stellt entweder einen Geldbetrag oder einen Milliprozentsatz dar. Für spec ist nur einer der folgenden Werte zulässig: |
||
amount |
Geldbetrag. |
|
amountMillipercentage |
Die Prozentsatzspezifikation, auf ein Tausendstel eines Prozentsatzes. Beispiel: 8, 750% wird als 8.750 dargestellt. Negative Prozentsätze stehen für prozentuale Rabatte. Dieses Feld wird eingestellt. Wenn ein solider Anwendungsfall erforderlich ist, können Sie weitere Inhalte hinzufügen. |
Typ
Der Geldtyp.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Der Typ ist nicht angegeben. Clients sollten dies nicht explizit festlegen müssen. |
REGULAR |
Regulärer Anzeigepreis vor Anwendung von Rabatten usw. |
DISCOUNT |
Wird von der Zwischensumme subtrahiert. |
TAX |
Wird zur Zwischensumme addiert. |
DELIVERY |
Wird zur Zwischensumme addiert. |
SUBTOTAL |
Zwischensumme, bevor einige Gebühren hinzugefügt werden können. |
FEE |
Etwaige zusätzliche Gebühr. |
GRATUITY |
Wird zur Zwischensumme addiert. |
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 diesen Betrag betragen. Beispiel: In Fällen, in denen die Steuern zum Zeitpunkt der Transaktion nicht genau bekannt sind, handelt es sich um einen GESCHÄTZTEN Betrag. |
ACTUAL |
Der tatsächliche Preis, der dem Nutzer in Rechnung gestellt wird. |
Geld
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 auf 1990000 für 1, 99 $festgelegt werden. |
Aktion
Eine mit dem Auftrag oder der Werbebuchung verknüpfte Folgeaktion.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich: Aktionstyp. |
title |
Titel oder Label der Aktion, der bzw. 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 spezifizierte Aktion. |
VIEW_DETAILS |
Aktion „Bestelldetails ansehen“. |
MODIFY |
Bestelländerung ändern. |
CANCEL |
Bestellaktion abbrechen. |
RETURN |
Aktion für Rückgabeanfrage. |
EXCHANGE |
Aktion für Austauschbestellung. |
EMAIL |
E-Mail-Aktion Die Typen EMAIL und CALL wurden eingestellt. openUrlAction.url kann als Telefonnummer oder E-Mail verwendet werden. |
CALL |
Anrufaktion. |
REORDER |
Aktion zum Neuanordnen. |
REVIEW |
Bestellaktion überprüfen. |
CUSTOMER_SERVICE |
Wenden Sie sich an den Kundenservice. |
FIX_ISSUE |
Leiten Sie zur Behebung des Problems zur Website oder App des Händlers weiter. |
DIRECTION |
Link zur Wegbeschreibung. |
OpenUrlAction
Öffnet die angegebene URL.
JSON-Darstellung | |
---|---|
{ "url": string, "androidApp": { object ( |
Felder | |
---|---|
url |
Das URL-Feld, entweder http- oder https-URLs zum Öffnen einer mit Apps 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 für die 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 bei jeder Filterübereinstimmung die Anwendung ausgelöst. |
VersionFilter
VersionFilter sollte eingeschlossen werden, wenn bestimmte Versionen der App erforderlich sind.
JSON-Darstellung | |
---|---|
{ "minVersion": integer, "maxVersion": integer } |
Felder | |
---|---|
minVersion |
Code der Mindestversion oder 0 (einschließlich). |
maxVersion |
Max. Versionscode, einschließlich. Der berücksichtigte Bereich ist [minVersion:maxVersion]. Ein Nullbereich impliziert jede Version. Beispiele: Wenn Sie eine einzelne Version angeben möchten, verwenden Sie: [target_version:target_version]. Wenn Sie eine Version angeben möchten, lassen Sie minVersion und maxVersion nicht angegeben. Wenn Sie alle Versionen bis zur maxVersion angeben möchten, lassen Sie minVersion nicht angegeben. Wenn Sie alle Versionen aus minVersion angeben möchten, lassen Sie maxVersion nicht angegeben. |
UrlTypeHint
Verschiedene Arten von URL-Hinweisen
Enums | |
---|---|
URL_TYPE_HINT_UNSPECIFIED |
Ohne Angabe |
AMP_CONTENT |
Eine URL, die direkt auf AMP-Inhalte oder eine kanonische URL verweist, 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 einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
Offenlegung
Offenlegung von 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 zulässig. |
presentationOptions |
Darstellungsoptionen für die Offenlegung. |
DisclosureText
Stellt einen Nur-Text mit Weblinks dar.
JSON-Darstellung | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
Felder | |
---|---|
template |
Anzuzeigender Text mit Platzhaltern wie "{0}" und "{1}" für jeden Textlink, der eingefügt werden soll. Beispiel: „WARNUNG: Bei diesem Produkt können Sie mit Chemikalien in Kontakt kommen, die dem US-Bundesstaat Kalifornien nachweislich Krebs verursachen. Weitere Informationen finden Sie unter {0}." Dieser Offenlegungstext darf keine werbeähnlichen oder anzeigenähnlichen Inhalte enthalten. |
textLinks[] |
Textlinks, die in der Vorlage ersetzt werden sollen. Die erste wird für "{0}" ersetzt. in der Vorlagenzeichenfolge und der zweite für "{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, an die Nutzer weitergeleitet werden sollen, wenn der Link aktiviert wird. |
DisclosurePresentationOptions
Optionen für die Darstellung einer Offenlegung.
JSON-Darstellung | |
---|---|
{
"presentationRequirement": enum ( |
Felder | |
---|---|
presentationRequirement |
Die Offenlegungspflicht. |
initiallyExpanded |
Ob der Inhalt der Offenlegung anfangs erweitert werden soll Sie ist standardmäßig minimiert. |
PresentationRequirement
Anforderung zur Darstellung der Offenlegung.
Enums | |
---|---|
REQUIREMENT_UNSPECIFIED |
Nicht spezifizierte Anforderung. Sollte nicht explizit festgelegt werden. |
REQUIREMENT_OPTIONAL |
Die Offenlegung ist optional. Sie können übersprungen werden, wenn das Gerät die Anzeige von Offenlegungen nicht unterstützt. |
REQUIREMENT_REQUIRED |
Die Offenlegung ist erforderlich. Wenn das Gerät die Anzeige von Offenlegungen nicht unterstützt, wird die Unterhaltung an das Smartphone gesendet. |
PurchaseItemExtension
Positionsinhalte der Branche „Kauf“.
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 |
Die mit dieser Position verknüpfte Produkt- oder Angebots-ID. |
quantity |
Menge des Artikels. |
unitMeasure |
Mengeneinheit. Gibt die Größe des Artikels in ausgewählten Einheiten an. Anhand der Größe wird zusammen mit dem aktiven Preis der Preis pro Einheit bestimmt. |
returnsInfo |
Gibt Informationen für diese Position zurück. Wenn die Richtlinie nicht konfiguriert ist, werden Informationen auf Auftragsebene für diese Werbebuchung übernommen. |
fulfillmentInfo |
Informationen zur Ausführung für diese Werbebuchung. Wenn die Richtlinie nicht konfiguriert ist, werden Informationen zur Auftragsausführung auf Auftragsebene für diese Werbebuchung übernommen. |
itemOptions[] |
Zusätzliche Add-ons oder Unterelemente. |
productDetails |
Details zum Produkt |
extension |
Zusätzliche Felder, die zwischen dem Händler und Google ausgetauscht werden Hinweis: Von dieser Erweiterung wird dringend abgeraten. Ziehen Sie je nach Anwendungsfall bzw. den jeweiligen Bedingungen eine der folgenden Möglichkeiten in Betracht: 1. Definieren Sie Felder in PurchaseItemExtension, wenn diese für andere Anwendungsfälle (z. B. allgemeine Funktionen/Funktionen) verwendet werden könnten. 2. Verwenden Sie „Vertical_extension“, wenn dies für einen benutzerdefinierten, nicht generischen Anwendungsfall oder eine benutzerdefinierte Funktion spezifisch ist. Ein Objekt, das Felder eines beliebigen Typs enthält. 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 unterschiedliche Bedeutungen haben. Bei der FOOD-Bestellung könnte es sein, dass das Essen zubereitet wird. Im Einzelhandel könnte das beispielsweise der Fall 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 die Bestellung oder Werbebuchung abgelehnt. |
RETURNED |
Der Artikel wurde vom Nutzer zurückgegeben. |
CANCELLED |
Der Auftrag oder die Werbebuchung wurde vom Nutzer storniert. |
CHANGE_REQUESTED |
Der Benutzer hat eine Änderung an der Bestellung angefordert und der Integrator verarbeitet diese Änderung. Die Bestellung sollte in einen anderen Status verschoben werden, nachdem die Anfrage verarbeitet wurde. |
PurchaseType
Die Kaufkategorie.
Enums | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
Unbekannter Wert. |
RETAIL |
Dazu gehören Käufe wie physische Waren. |
FOOD |
Dazu gehört auch der Kauf von Essensbestellungen. |
GROCERY |
Lebensmittelkauf. |
MOBILE_RECHARGE |
Kauf eines Prepaid-Guthabens für die Aufladung von Mobilfunkguthaben. |
MerchantUnitMeasure
„Mengeneinheit für Grundpreis“ 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 |
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 Anzahl von Tagen möglich. |
policyUrl |
Link zu den Rückgabebedingungen. |
PurchaseFulfillmentInfo
Informationen zur Ausführung, die mit einem Auftrag oder einer bestimmten Werbebuchung verknüpft sind.
JSON-Darstellung | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
Felder | |
---|---|
id |
Eindeutige Kennung für diese Dienstleistungsoption. |
fulfillmentType |
Erforderlich: Der Typ der Auftragsausführung. |
expectedFulfillmentTime |
Ein Fenster, wenn ein Zeitraum angegeben ist, oder ETA, wenn eine einzelne Zeit angegeben ist. Voraussichtliche Liefer- oder Abholzeit. |
expectedPreparationTime |
Ein Fenster, wenn ein Zeitraum angegeben ist, oder ETA, wenn eine einzelne Zeit angegeben ist. Die geschätzte Zeit für die Zubereitung des Essens. Einmalig. |
location |
Abhol- oder Lieferort. |
expireTime |
Zeitpunkt, zu dem diese Auftragsausführungsoption abläuft. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
price |
Kosten dieser Option. |
fulfillmentContact |
Nutzerkontakt für diese Auftragsausführung. |
shippingMethodName |
Name der Versandart, die vom Nutzer ausgewählt wurde. |
storeCode |
Geschäftscode des Standorts. Beispiel: Walmart ist der Händler und storeCode ist der Walmart-Shop, in dem die Auftragsausführung stattgefunden hat. https://support.google.com/business/answer/3370250?ref_topic=4596653. |
pickupInfo |
Zusätzliche Informationen zur Auswahl der Bestellung. Dieses Feld ist nur verfügbar, wenn der Ausführungstyp PICKUP lautet. |
Typ
Ausführungstyp.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Der Typ ist nicht angegeben. |
DELIVERY |
Diese Bestellung wird geliefert. |
PICKUP |
Diese Bestellung muss abgeholt werden. |
Zeit
Zeitkonstruktion zur Darstellung der Zeit eines Ereignisses, die verwendet werden soll, wenn dem Nutzer eine Bestellung angezeigt wird.
JSON-Darstellung | |
---|---|
{ "timeIso8601": string } |
Felder | |
---|---|
timeIso8601 |
Stellt die Zeit eines Bestellereignisses wie Reservierungszeit, Lieferzeit usw. dar. Es könnte sich dabei um eine Dauer (Start- und Endzeit), nur das Datum oder die Uhrzeit 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 zu jedem Typ.
JSON-Darstellung | |
---|---|
{ "pickupType": enum ( |
Felder | |
---|---|
pickupType |
Abholoption, z. B. IM GESCHÄFT, VORHERIGE usw. |
curbsideInfo |
Spezifische Angaben zur Abholung vor dem Laden. Wenn für pickupType nicht „CURBSIDE“ angegeben ist, wird dieses Feld ignoriert. |
checkInInfo[] |
Liste der verschiedenen Methoden, die vom Partner zur Unterstützung des Check-ins unterstützt werden. |
PickupType
Liste der unterstützten Abholtypen.
Enums | |
---|---|
UNSPECIFIED |
Abholtyp nicht angegeben. |
INSTORE |
Essen im Restaurant abholen. |
CURBSIDE |
Parken Sie Ihr Fahrzeug an einem ausgewiesenen Parkplatz vor dem Restaurant, dann lieferte jemand das Essen. |
CurbsideInfo
Details dazu, wie die Bestellung vor dem Laden möglich wäre
JSON-Darstellung | |
---|---|
{ "curbsideFulfillmentType": enum ( |
Felder | |
---|---|
curbsideFulfillmentType |
Partner benötigen zusätzliche Informationen, um Bestellungen zur Abholung vor dem Laden zu ermöglichen. Abhängig davon, welche Art der Auftragsausführung ausgewählt wurde, werden entsprechende Details vom Nutzer erhoben. |
userVehicle |
Fahrzeugdetails des Nutzers, der die Bestellung aufgibt. |
CurbsideFulfillmentType
Mögliche Werte der Typen für die Abholung vor dem Laden.
Enums | |
---|---|
UNSPECIFIED |
Typ der Auftragsausführung vor dem Laden nicht angegeben. |
VEHICLE_DETAIL |
Fahrzeugdetails für die leichtere Abholung vor dem Laden erforderlich. |
Fahrzeug
Details zu einem Fahrzeug
JSON-Darstellung | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
Felder | |
---|---|
make |
Fahrzeugmarke (z.B. „Honda“). Dies wird dem Nutzer angezeigt und muss lokalisiert werden. Erforderlich. |
model |
Fahrzeugmodell (z.B. „Grom“). Dies wird dem Nutzer angezeigt und muss lokalisiert werden. Erforderlich. |
licensePlate |
Kfz-Kennzeichen (z.B. „1ABC234“). Erforderlich. |
colorName |
Name der Fahrzeugfarbe, z. B. Schwarz (optional) |
image |
URL zu einem Foto des Fahrzeugs. Das Foto wird mit einer Größe von ungefähr 256 x 256 Pixel angezeigt. Muss eine JPG- oder PNG-Datei sein. Optional. |
CheckInInfo
Vom Partner erforderliche Metadaten, um eine Check-in-Methode zu unterstützen.
JSON-Darstellung | |
---|---|
{
"checkInType": enum ( |
Felder | |
---|---|
checkInType |
Methode zum Senden von Anweisungen zum Einchecken. |
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 Unterelemente
JSON-Darstellung | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
Felder | |
---|---|
id |
Eindeutige Artikel-ID bei Optionen, bei denen es sich um Artikel handelt. |
name |
Optionsname. |
prices[] |
Gesamtpreis der Option. |
note |
Hinweis zur Option. |
quantity |
Bei Optionen, bei denen es sich um Artikel handelt, Menge. |
productId |
Die 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 |
Die mit dieser Position verknüpfte Produkt- oder Angebots-ID. |
gtin |
Global Trade Item Number des Produkts. Dies ist hilfreich, wenn das Attribut „offerId“ nicht im Merchant Center vorhanden ist. Optional. |
plu |
Preissuchcodes, auch als PLU-Codes, PLU-Nummern, PLUs, Produktcodes oder Etiketten für Lebensmittel bezeichnet, sind ein Zahlensystem, das unverpackte Waren, die in Lebensmittelgeschäften und Supermärkten verkauft werden, eindeutig identifizieren. |
productType |
Vom Händler definierte Produktkategorie. Beispiel: "Startseite > Lebensmittel > Milchprodukte und Eier > Milch > Vollmilch |
productAttributes |
Vom Händler bereitgestellte Details zum Produkt, z.B. { "allergen": "peanut" }. Dies ist hilfreich, wenn das Attribut „offerId“ nicht im Merchant Center vorhanden ist. Optional. Ein Objekt, das eine Liste von |
ReservationItemExtension
Werbebuchungsinhalte für Reservierungsbestellungen 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 werden, wenn keine der Typoptionen anwendbar ist. |
reservationTime |
Zeitpunkt, zu dem der Dienst/das Ereignis planmäßig stattfinden soll. Dabei kann es sich um einen Zeitraum, ein Datum oder ein genaues Datum und eine genaue Uhrzeit handeln. |
userAcceptableTimeRange |
Zeitraum, der für den Nutzer akzeptabel ist. |
confirmationCode |
Bestätigungscode für diese Reservierung. |
partySize |
Die Anzahl der Personen. |
staffFacilitators[] |
Personalunterstützer, die die Reservierung durchführen. Beispiel: Der Friseur. |
location |
Ort der Dienstleistung/Veranstaltung. |
ReservationStatus
Status der Reservierung.
Enums | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
Unbekannter Status. |
PENDING |
Die Reservierung steht aus. |
CONFIRMED |
Die Reservierung ist bestätigt. |
CANCELLED |
Die Reservierung wurde vom Nutzer storniert. |
FULFILLED |
Die Reservierung wurde ausgeführt. |
CHANGE_REQUESTED |
Reservierungsänderung angefordert |
REJECTED |
Die Reservierung wurde vom Integrator entweder abgelaufen oder abgelehnt. |
ReservationType
Art der Reservierung.
Enums | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
Nicht definierter Typ. |
RESTAURANT |
Reservierung für Restaurant. |
HAIRDRESSER |
Reservierung eines Friseurs. |
StaffFacilitator
Informationen zum Servicemitarbeiter.
JSON-Darstellung | |
---|---|
{
"name": string,
"image": {
object ( |
Felder | |
---|---|
name |
Name der moderierenden Person Beispiel: „Max Mustermann“ |
image |
Bilder des Künstlers |
PaymentData
Zahlungsdaten zu 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 Nutzerinteraktion nützlich sind |
PaymentResult
Das Zahlungsergebnis, das vom Integrator für den Abschluss einer Transaktion verwendet wird.
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld result . Es werden entweder Google Payment-Daten oder die Händlerzahlungsmethode angegeben. Für result ist nur einer der folgenden Werte zulässig: |
||
googlePaymentData |
Von Google bereitgestellte Daten zur Zahlungsmethode. Wenn Ihr Zahlungsabwickler hier als von Google unterstützter Zahlungsabwickler aufgeführt ist: https://developers.google.com/pay/api/ Rufen Sie den Link zu Ihrem Zahlungsabwickler auf, um weitere Informationen zu erhalten. Einzelheiten zur Nutzlast finden Sie in der folgenden Dokumentation. https://developers.google.com/pay/api/payment-data-cryptography |
|
merchantPaymentMethodId |
Vom Händler/Aktion angegebene Zahlungsmethode vom Nutzer ausgewählt. |
PaymentInfo
Zahlungsinformationen zu der aufgegebenen Bestellung Dieses Proto erfasst Informationen, die für die nutzerseitige Interaktion nützlich sind.
JSON-Darstellung | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
Felder | |
---|---|
paymentMethodDisplayInfo |
Die angezeigten Informationen der Zahlungsmethode, die für die Transaktion verwendet wurde. |
paymentMethodProvenance |
Herkunft der für die Transaktion verwendeten Zahlungsmethode Der Nutzer hat möglicherweise dieselbe Zahlungsmethode bei Google und beim Händler registriert. |
PaymentMethodDisplayInfo
Das 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 für sprachgesteuerte Assistant-Geräte vorgelesen wird. Beispiele: „Visum mit den Endziffern eins zwei drei vier“ oder „Girokonto mit den Endziffern fünf sechs siebenacht“. Hinweis: Dies ist der sprachoptimierte String, der anstelle von "paymentMethodDisplayName" für Geräte mit Sprachassistenten verwendet wird. Wenn dieser String nicht festgelegt ist, wird „paymentMethodDisplayName“ an den Nutzer vorgelesen. |
PaymentType
PaymentType gibt die Zahlungsart an, die 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 |
Zahlungsmethode 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 wird Bargeld verwendet. |
GIFT_CARD |
Die Zahlungsmethode ist eine Geschenkkarte. |
WALLET |
Drittanbieter-Wallet, z.B. PayPal |
PaymentMethodProvenance
Die Herkunft der Zahlungsmethode, die für die Transaktion verwendet wurde
Enums | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
Herkunft ist nicht angegeben. |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
Herkunft ist Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
Herkunft ist Händler. |
Angebot
Aktionen/Angebote, die dem Einkaufswagen hinzugefügt wurden.
JSON-Darstellung | |
---|---|
{ "coupon": string } |
Felder | |
---|---|
coupon |
Erforderlich: Gutscheincode, der auf dieses Angebot angewendet wurde. |
PurchaseOrderExtension
Bestellerweiterung für die Branche „Käufe“. Diese Eigenschaften gelten für alle Werbebuchungen innerhalb des Auftrags, sofern sie nicht in einer Werbebuchung ü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 zur Bestellung. |
fulfillmentInfo |
Informationen zur Ausführung der Bestellung. |
purchaseLocationType |
Ort des Kaufs (im Geschäft / online) |
errors[] |
Optional: Fehler, aufgrund derer diese Bestellung abgelehnt wurde. |
extension |
Zusätzliche Felder, die zwischen dem Händler und Google ausgetauscht werden Hinweis: Von dieser Erweiterung wird dringend abgeraten. Ziehen Sie je nach Anwendungsfall bzw. den jeweiligen Bedingungen eine der folgenden Möglichkeiten in Betracht: 1. Definieren Sie Felder in PurchaseOrderExtension, wenn diese für andere Anwendungsfälle (z. B. allgemeine Funktionen/Funktionen) verwendet werden könnten. 2. Verwenden Sie „Vertical_extension“, wenn dies für einen benutzerdefinierten, nicht generischen Anwendungsfall oder eine benutzerdefinierte Funktion spezifisch ist. Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld |
PurchaseLocationType
Standorttyp des Kaufs.
Enums | |
---|---|
UNSPECIFIED_LOCATION |
Unbekannter Wert. |
ONLINE_PURCHASE |
Alle Käufe, die online gekauft wurden. |
INSTORE_PURCHASE |
Alle Käufe im Geschäft |
PurchaseError
Fehler, aufgrund derer ein Auftrag abgelehnt werden kann.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich: Dies ist der Grund, aus dem eine Bestellung vom Händler abgelehnt wird. |
description |
Zusätzliche Fehlerbeschreibung. |
entityId |
Die Entitäts-ID, die dem Fehler entspricht. Ein Beispiel hierfür ist „LineItemId“/„ItemOptionId“. |
updatedPrice |
Relevant im Fall des Fehlertyps PRICE_CHANGED / INORRECT_PRICE. |
availableQuantity |
Jetzt verfügbare Menge. Anwendbar im Fall von AVAILABILITY_CHANGED. |
ErrorType
Mögliche Fehlertypen.
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Unbekannter Fehler |
NOT_FOUND |
Entity nicht gefunden. Kann Artikel, FulfillmentOption, Promotion sein. Entitäts-ID erforderlich. |
INVALID |
Entitätsdaten ungültig. „Item“, „FulfillmentOption“ oder „Promotion“. 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 Artikelentität. Entitäts-ID und aktualisierter Preis erforderlich. |
INCORRECT_PRICE |
Preisfehler bei Gebühren, Gesamtbetrag. Entitäts-ID und aktualisierter Preis erforderlich. |
REQUIREMENTS_NOT_MET |
Einschränkungen beim Annehmen der Bestellung nicht erfüllt, z. B. Mindestbestellmenge usw. |
TOO_LATE |
FulfillmentOption abgelaufen. |
NO_CAPACITY |
Keine verfügbare Dienstkapazität. Verwenden Sie diesen Fehlercode, wenn keiner der detaillierteren Fehlertypen anwendbar ist. |
NO_COURIER_AVAILABLE |
Es wurde kein Kurierdienst gefunden. Ein detaillierter Fehlertyp, der als NO_CAPACITY kategorisiert werden kann. |
INELIGIBLE |
Nutzer ist nicht berechtigt, Bestellungen aufzugeben (auf die schwarze Liste gesetzt) |
OUT_OF_SERVICE_AREA |
Die Lieferung an die gewünschte Adresse ist aufgrund von Grenzen usw. nicht möglich. |
CLOSED |
Das Restaurant ist bei der Bestellung geschlossen. |
PROMO_NOT_APPLICABLE |
Allgemeiner Fehlercode, um alle Fälle abzufangen, in denen der Gutscheincode nicht angewendet werden kann, wenn keiner der unten genannten passt. 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, da 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 |
Für die aktuelle Bestellung ist dieser Gutschein nicht verfügbar. Fügen Sie den Gutscheincode als Entitäts-ID hinzu. |
UNAVAILABLE_SLOT |
Der Slot für Vorbestellungen ist nicht verfügbar. |
FAILED_PRECONDITION |
Einschränkungen beim Annehmen der Bestellung nicht erfüllt, z. B. Mindestbestellmenge usw. |
PAYMENT_DECLINED |
Ungültige Zahlung. |
MERCHANT_UNREACHABLE |
Händler ist nicht erreichbar. Das ist hilfreich, wenn ein Partner ein Aggregator ist und den Händler nicht erreichen kann. |
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
Inhalte für Ticketbestellungen wie Filme, Sport usw. bestellen
JSON-Darstellung | |
---|---|
{
"ticketEvent": {
object ( |
Felder | |
---|---|
ticketEvent |
Das Ereignis wurde auf alle Werbebuchungstickets angewendet. |
TicketEvent
Stellt ein einzelnes Ereignis dar.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich: Typ der Ticketveranstaltung, z.B. Film, Konzert. |
name |
Erforderlich: Name des Ereignisses. Handelt es sich bei dem Ereignis beispielsweise um einen Film, sollte hier der Name des Films angegeben werden. |
description |
Beschreibung der Veranstaltung. |
url |
URL zu den Ereignisinformationen. |
location |
Der Ort, an dem das Ereignis stattfindet, oder eine Organisation. |
eventCharacters[] |
Die Zeichen, die sich auf dieses Ereignis beziehen. Dies können Regisseure oder Schauspieler eines Filmereignisses, Darsteller eines Konzerts usw. sein. |
startDate |
Start. |
endDate |
Ende. |
doorTime |
Beginn; kann vom Beginn der Veranstaltung abweichen. z.B. Die Veranstaltung beginnt um 09:00 Uhr, der Einlass ist jedoch 8:30 Uhr. |
Typ
Der Typ des Ereignisses.
Enums | |
---|---|
EVENT_TYPE_UNKNOWN |
Unbekannter Ereignistyp. |
MOVIE |
Film |
CONCERT |
Konzert. |
SPORTS |
Sport |
EventCharacter
Ein Ereigniszeichen, z.B. Organisator, Künstler usw.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Typ des Ereigniszeichens, z.B. Schauspieler oder Regisseur. |
name |
Name des Zeichens. |
image |
Bilder der Charaktere |
Typ
Zeichentyp
Enums | |
---|---|
TYPE_UNKNOWN |
Unbekannter Typ. |
ACTOR |
Akteur: |
PERFORMER |
Künstler. |
DIRECTOR |
Einen Regisseur |
ORGANIZER |
Organisator. |
UserNotification
Optionale Nutzerbenachrichtigung, die als Teil der Bestellaktualisierung angezeigt wird.
JSON-Darstellung | |
---|---|
{ "title": string, "text": string } |
Felder | |
---|---|
title |
Der Titel der 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 bereits in der Sitzung definierten Parametern zusammengeführt. 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. Sitzungstypdefinitionen können 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. Wenn für die Aktion mehrsprachige Funktionen verwendet werden, kann dies von der Sprache des Nutzers abweichen. Wenn beispielsweise "handler_response.expected.language_code" festgelegt ist, wird die Konversationssprache für alle nachfolgenden Runden 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. 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 den zuvor definierten Typdefinitionen zusammengeführt. 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
Ein Eintrag für einen Synonymtyp.
JSON-Darstellung | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
Felder | |
---|---|
name |
Erforderlich. Name des Eintrags (z.B. „Fahrrad“). Der Eintrag in diesem Feld muss in das Feld für wiederholte Synonyme aufgenommen werden, um als gültiger Typwert erkannt zu werden. |
synonyms[] |
Erforderlich. Liste der Synonyme für den Eintrag (z.B. "Fahrrad", "Zyklus"). |
display |
Optional. Die Informationen zum Element werden angezeigt. |
EntryDisplay
JSON-Darstellung | |
---|---|
{ "title": string, "description": string, "image": { object ( |
Felder | |
---|---|
title |
Erforderlich. Titel des Artikels. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss unter den Sammlungselementen eindeutig sein. |
description |
Optional. Der Text der Karte. |
image |
Optional. Das Bild, das angezeigt werden soll. |
footer |
Optional. Text in der Fußzeile für das Element der Sammlung „Durchsuchen“, der unter der Beschreibung angezeigt wird. Einzelne, mit Auslassungspunkten abgeschnittene Textzeile. |
openUrl |
URL des Dokuments, das mit dem Karussellelement verknüpft ist. Erforderlich zum Durchsuchen des Karussells. |
Nutzer
Stellt den Nutzer dar, der eine Anfrage an die Aktion stellt.
JSON-Darstellung | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
Felder | |
---|---|
locale |
Einstellung des primären Gebietsschemas des Nutzers, der die Anfrage stellt. Entspricht dem IETF BCP-47-Sprachcode http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Das Subtag des Skripts 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 |
Ob das Nutzerkonto mit der App verknüpft ist |
verificationStatus |
Zeigt 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 einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
engagement |
Das Engagement des aktuellen Nutzers, einschließlich Abos von Intents. |
packageEntitlements[] |
Nutzerberechtigungen, die sich auf das mit der aktuellen Aktion verknüpfte Android-Paket beziehen. |
permissions[] |
Enthält Berechtigungen, die der Nutzer für diese Aktion erteilt hat. |
AccountLinkingStatus
Gibt an, ob der Endnutzer sein Konto mit dieser App verknüpft hat. Weitere Informationen findest du 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 verifiziert wurde. Der Status VERIFIED gibt an, dass Sie Daten über das Feld "params" oder über die Kontoverknüpfung zwischen Konversationen hinweg speichern können.
Enums | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED |
Unbekannt |
GUEST |
Gastnutzer. |
VERIFIED |
Bestätigter Nutzer. |
Engagement
Bietet zusätzliche schreibgeschützte Informationen zu den Interaktionsmechanismen, für die sich der aktuelle Nutzer registriert hat. Es kann beispielsweise nützlich sein, zu wissen, welche Intents der Nutzer bereits abonniert hat, damit er nicht noch einmal aufgefordert wird, denselben Intent zu abonnieren. Das heißt, diese Informationen können nur dann verwendet werden, um eine bedingte Weiterleitung an eine Szene durchzuführen, um DailyUpdates oder PushNotifications einzurichten, wenn der Nutzer sie noch nicht abonniert hat. 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 die tägliche Aktualisierung aktiviert hat. |
IntentSubscription
Beschreibt ein vorhandenes IntentSubscription-Abo.
JSON-Darstellung | |
---|---|
{ "intent": string, "contentTitle": string } |
Felder | |
---|---|
intent |
Name des Intents, der abonniert wurde. |
contentTitle |
Eine kurze Beschreibung des Abos. Es wird als Benachrichtigungslabel verwendet und wenn Assistant den Nutzer um Erlaubnis bittet. |
PackageEntitlements
Eine Liste der Nutzerberechtigungen, die sich auf einen Paketnamen beziehen. Weitere Informationen finden Sie in der Dokumentation zu Transaktionen für digitale Waren: 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-Artikelposition (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 findest du in der Dokumentation zur InApp-Abrechnung von 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 finden Sie in Tabelle 6 unter https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
Stimmt mit IN_APP_DATA_SIGNATURE aus der Methode getPurchases() in der Play InApp Billing API überein. |
Berechtigung
Mögliche Werte für die Berechtigung.
Enums | |
---|---|
PERMISSION_UNSPECIFIED |
Unbekannte Berechtigung. |
DEVICE_PRECISE_LOCATION |
Fragen Sie den Nutzer nach dem genauen Standort, dem Längen- und Breitengrad sowie der formatierten Adresse. |
DEVICE_COARSE_LOCATION |
Fragen Sie den Nutzer nach dem ungefähren Standort, der Postleitzahl, der Stadt und der Landesvorwahl. |
UPDATE |
Fordere Berechtigungen zum Senden von Updates an. Weitere Informationen finden Sie unter https://developers.google.com/assistant/engagement/daily. |
Startseite
Die HomeGraph-Struktur, 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 zu Google Home: https://developers.google.com/assistant/conversational/storage-home. Ein Objekt, das eine Liste von |
Gerät
Stellt das Gerät dar, das der Nutzer verwendet, um eine Anfrage an die Aktion zu senden.
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 erst eingefügt, nachdem der Endnutzer die Berechtigung zur Standortermittlung erteilt hat. Weitere Informationen dazu, welche Felder von groben oder detaillierten Berechtigungen festgelegt werden, finden Sie in der Meldung zur Standortermittlung. Weitere Informationen finden Sie in der Dokumentation zu Berechtigungen unter https://developers.google.com/assistant/conversational/permissions. |
timeZone |
Optional. Zeitzone, die dem Clientgerät zugeordnet ist. Es könnte verwendet werden, um Datum/Uhrzeit-Werte aufzulösen. |
Funktion
Funktionen, die die Geräteoberfläche zum Zeitpunkt der Anfrage unterstützt.
Enums | |
---|---|
UNSPECIFIED |
Nicht spezifizierte Gerätefunktion. |
SPEECH |
Das Gerät kann über Sprachausgabe oder SSML mit dem Nutzer sprechen. |
RICH_RESPONSE |
Auf dem Gerät können Rich-Antworten wie Karten, Listen und Tabellen angezeigt werden. |
LONG_FORM_AUDIO |
Auf dem Gerät können Audioinhalte im Langformat wie Musik und Podcasts abgespielt werden. |
INTERACTIVE_CANVAS |
Auf dem Gerät kann eine interaktive Canvas-Antwort angezeigt werden. |
WEB_LINK |
Auf dem Gerät können Weblinks in Rich-Antworten verwendet werden, um einen Webbrowser zu öffnen. |
HOME_STORAGE |
Das Gerät kann das Speichern und Abrufen von Speicherplatz im Zuhause unterstützen. |
Standort
Container, der einen Standort darstellt.
JSON-Darstellung | |
---|---|
{ "coordinates": { object ( |
Felder | |
---|---|
coordinates |
Geografische Koordinaten. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION]. |
postalAddress |
Postanschrift. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION]. Wenn die Berechtigung zur Ermittlung des ungefähren Standorts gewährt wird, wird nur der Wert für „postalCode“ und 'Ort' müssen ausgefüllt sein. Mit der Berechtigung „Genauer Standort“ werden zusätzliche Felder wie „administrativeArea“ ausgefüllt. und "addressLines". |
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, den 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 wurde von der Interactive Canvas App eines Drittanbieters festgelegt. Dieses Feld wird nur für die Anfrage festgelegt, nicht für die Antwort. Wenn es sich beispielsweise um eine Rezept-App handelt, kann der Status ein Wert von struct : { "current_page" sein. : 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 zur Sprachgewichtung erwartet. Es sind bis zu 1.000 Wortgruppen zulässig. Hinweis: Dieses Feld hat die gleiche Bedeutung wie ErwarteteInput.speech_biasing_hints in der Version 2 des APIs. |