Method: fulfill

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 (Handler)
  },
  "intent": {
    object (Intent)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "context": {
    object (Context)
  }
}
Felder
handler

object (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

object (Intent)

Erforderlich. Stellt den letzten zugeordneten Intent dar. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/intents.
scene

object (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

object (Session)

Erforderlich. Enthält Sitzungsdaten wie die Sitzungs-ID und Sitzungsparameter.
user

object (User)

Erforderlich. Nutzer, der die Unterhaltung begonnen hat.
home

object (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

object (Device)

Erforderlich. Informationen zu dem Gerät, das der Nutzer verwendet, um mit der Aktion zu interagieren.
context

object (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 (Prompt)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "expected": {
    object (Expected)
  }
}
Felder
prompt

object (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

object (Scene)

Optional. Stellt die aktuelle und die nächste Szene dar. Wenn Scene.next festgelegt ist, geht die Laufzeit sofort zur angegebenen Szene über.
session

object (Session)

Optional. Beschreibt Daten für die aktuelle Sitzung. Sitzungsparameter können durch die Auftragsausführung erstellt, aktualisiert oder entfernt werden.
user

object (User)

Optional. Hiermit können Sie Nutzerparameter angeben, die zurückgesendet werden sollen.
home

object (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

object (Device)

Optional. Wird verwendet, um zwischen Assistant-Geräten zu wechseln, auf die der Nutzer Zugriff hat.
expected

object (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

string

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 (IntentParameterValue)
    },
    ...
  },
  "query": string
}
Felder
name

string

Erforderlich. Der Name des zuletzt zugeordneten Intents.
params

map (key: string, value: object (IntentParameterValue))

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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
query

string

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

string

Erforderlich. Ursprünglicher Textwert, der aus der Äußerung des Nutzers extrahiert wurde.
resolved

value (Value format)

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 (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  },
  "next": {
    object (NextScene)
  }
}
Felder
name

string

Erforderlich. Name der aktuellen Szene.
slotFillingStatus

enum (SlotFillingStatus)

Erforderlich. Der aktuelle Status der Slot-Füllung. Dieses Feld ist schreibgeschützt.
slots

map (key: string, value: object (Slot))

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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
next

object (NextScene)

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 (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
Felder
mode

enum (SlotMode)

Der Modus des Slots (erforderlich oder optional). Kann vom Entwickler festgelegt werden.
status

enum (SlotStatus)

Der Status des Slots.
value

value (Value format)

Der Wert des Slots. Wenn Sie diesen Wert in der Antwort ändern, wird der Wert in der Slot-Füllung geändert.
updated

boolean

Gibt an, ob der Slotwert in der letzten Runde erfasst wurde. Dieses Feld ist schreibgeschützt.
prompt

object (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 (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
Felder
override

boolean

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

object (Simple)

Optional. Die erste reine Sprach- und Textantwort.
content

object (Content)

Optional. Ein Inhalt wie eine Karte, eine Liste oder ein Medium, das bzw. der dem Nutzer angezeigt werden soll.
lastSimple

object (Simple)

Optional. Die letzte reine Sprach- und Textantwort.
suggestions[]

object (Suggestion)

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.
canvas

object (Canvas)

Optional. Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll.
orderUpdate

object (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

string

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

string

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 content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  },
  "collectionBrowse": {
    object (CollectionBrowse)
  }
  // End of list of possible types for union field content.
}
Felder

Union-Feld content.

Für content ist nur einer der folgenden Werte zulässig:
card

object (Card)

Eine einfache Karte.
image

object (Image)

Ein Bild.
table

object (Table)

Tabellenkarte.
media

object (Media)

Antwort, die eine Gruppe von Medien angibt, die abgespielt werden sollen.
collection

object (Collection)

Eine Karte mit einer Auswahl von Optionen.
list

object (List)

Eine Karte mit einer Liste von Optionen zur Auswahl.
collectionBrowse

object (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 (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
Felder
title

string

Gesamttitel der Karte Optional.
subtitle

string

Optional.
text

string

Der Text der Karte. Unterstützt einen begrenzten Satz von Markdown-Syntax für die Formatierung. Erforderlich, sofern kein Bild vorhanden ist.
image

object (Image)

Ein Hero-Image für die Karte. Die Höhe ist auf 192 dp festgelegt. Optional.
imageFill

enum (ImageFill)

Legt fest, wie der Bildhintergrund ausgefüllt wird. Optional.
button

object (Link)

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

string

Die Quell-URL des Bildes. Bilder können das Format JPG, PNG und GIF haben (animiert und nicht animiert). Beispiel: https://www.agentx.com/logo.png. Erforderlich.
alt

string

Eine Textbeschreibung des Bildes, das für Barrierefreiheit verwendet werden soll, z.B. Screenreadern. Erforderlich.
height

integer

Die Höhe des Bilds in Pixeln Optional.
width

integer

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.

OpenUrl

JSON-Darstellung 
{
  "url": string,
  "hint": enum (UrlHint)
}
Felder
url

string

Das URL-Feld, entweder http- oder https-URLs zum Öffnen einer mit Apps verknüpften App oder einer Webseite
hint

enum (UrlHint)

Gibt einen Hinweis für den URL-Typ an.

UrlHint

Verschiedene Arten von URL-Hinweisen

Enums
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 (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
Felder
title

string

Gesamttitel der Tabelle Optional, muss aber festgelegt werden, wenn eine Untertitel festgelegt wurde.
subtitle

string

Untertitel für die Tabelle. Optional.
image

object (Image)

Mit der Tabelle verknüpftes Bild. Optional.
columns[]

object (TableColumn)

Überschriften und Ausrichtung von Spalten.
rows[]

object (TableRow)

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

object (Link)

Schaltfläche.

TableColumn

JSON-Darstellung 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Felder
header

string

Überschrift für die Spalte.
align

enum (HorizontalAlignment)

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 (TableCell)
    }
  ],
  "divider": boolean
}
Felder
cells[]

object (TableCell)

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

boolean

Gibt an, ob nach jeder Zeile eine Trennlinie vorhanden sein soll.

TableCell

Beschreibt eine Zelle in einer Zeile.

JSON-Darstellung 
{
  "text": string
}
Felder
text

string

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 (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode),
  "firstMediaObjectIndex": integer
}
Felder
mediaType

enum (MediaType)
startOffset

string (Duration format)

Startversatz des ersten Medienobjekts.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".
optionalMediaControls[]

enum (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[]

object (MediaObject)

Liste der Medienobjekte
repeatMode

enum (RepeatMode)

Wiederholungsmodus für die Liste der Medienobjekte.
firstMediaObjectIndex

integer

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 (MediaImage)
  }
}
Felder
name

string

Name dieses Medienobjekts.
description

string

Beschreibung dieses Medienobjekts.
url

string

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

object (MediaImage)

Bild, das mit der Medienkarte angezeigt werden soll.

MediaImage

JSON-Darstellung 
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
Felder

Union-Feld image.

Für image ist nur einer der folgenden Werte zulässig:
large

object (Image)

Ein großes Bild, z. B. das Cover des Albums
icon

object (Image)

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 (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Felder
title

string

Titel der Sammlung. Optional.
subtitle

string

Untertitel der Sammlung. Optional.
items[]

object (CollectionItem)

Eine Liste mit Elementen. Er kann einen Mindestwert von 2 und einen Höchstwert von 10 haben.
imageFill

enum (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

string

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 (ListItem)
    }
  ]
}
Felder
title

string

Titel der Liste. Optional.
subtitle

string

Untertitel der Liste. Optional.
items[]

object (ListItem)

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

string

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 (Item)
    }
  ],
  "imageFill": enum (ImageFill)
}
Felder
items[]

object (Item)

Eine Liste mit Elementen. Er kann einen Mindestwert von 2 und einen Höchstwert von 10 haben.
imageFill

enum (ImageFill)

Art der Bildanzeigeoption.

Element

Element in der Sammlung.

JSON-Darstellung 
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
Felder
title

string

Erforderlich. Titel des Sammlungselements.
description

string

Beschreibung des Sammlungselements.
footer

string

Fußzeilentext für das Sammlungselement, der unter der Beschreibung angezeigt wird. Einzelne, mit Auslassungspunkten abgeschnittene Textzeile.
image

object (Image)

Bild für das Sammlungselement.
openUriAction

object (OpenUrl)

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

string

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 (ContinuousMatchConfig)
  }
}
Felder
url

string

URL der interaktiven Canvas-Webanwendung, die geladen werden soll. Wenn die Richtlinie nicht konfiguriert ist, wird die URL des aktuell aktiven Canvas wiederverwendet.
data[]

value (Value format)

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

boolean

Optional. Standardwert: false.
continuousMatchConfig

object (ContinuousMatchConfig)

Konfiguration zum Initiieren des Modus für kontinuierliche Übereinstimmungen.

ContinuousMatchConfig

Konfiguration zum Initiieren des Modus für kontinuierliche Übereinstimmungen.

JSON-Darstellung 
{
  "expectedPhrases": [
    {
      object (ExpectedPhrase)
    }
  ],
  "durationSeconds": integer
}
Felder
expectedPhrases[]

object (ExpectedPhrase)

Alle möglichen während dieser Sitzung im Abgleichmodus möglichen erwarteten Wortgruppen.
durationSeconds

integer

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

string

Die Wortgruppe, die während einer Sitzung im kontinuierlichen Abgleichsmodus abgeglichen werden soll.
alternativePhrases[]

string

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 (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Felder
type
(deprecated)

enum (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

object (Order)
updateMask

string (FieldMask format)

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: "user.displayName,photo".
userNotification

object (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

string

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 (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
Felder
googleOrderId

string

Von Google zugewiesene Bestell-ID.
merchantOrderId

string

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

string

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
(deprecated)

string

Eingestellt: Verwenden Sie stattdessen den Status „OrderExtensions“. Für den Nutzer sichtbares Label für den Status dieser Bestellung.
buyerInfo

object (UserInfo)

Informationen zum Käufer.
image

object (Image)

Mit der Bestellung verknüpftes Bild.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
lastUpdateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
transactionMerchant

object (Merchant)

Händler, der den Bezahlvorgang vereinfacht hat. Dies kann sich von einem Anbieter auf Werbebuchungsebene unterscheiden. Beispiel: Expedia-Auftrag mit Werbebuchung von ANA
contents

object (Contents)

Erforderlich: Auftragsinhalt, der eine Gruppe von Werbebuchungen ist.
priceAttributes[]

object (PriceAttribute)

Preise, Rabatte, Steuern usw.
followUpActions[]

object (Action)

Folgeaktionen auf Auftragsebene.
paymentData

object (PaymentData)

Zahlungsbezogene Daten für die Bestellung.
termsOfServiceUrl

string

Ein Link zu den Nutzungsbedingungen, die für die Bestellung bzw. vorgeschlagene Bestellung gelten.
note

string

Mit einer Bestellung verknüpfte Notizen.
promotions[]

object (Promotion)

Alle Angebote, die mit dieser Bestellung verknüpft sind.
disclosures[]

object (Disclosure)

Mit dieser Anordnung verbundene Offenlegungen.
vertical
(deprecated)

object

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: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.
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

object (PurchaseOrderExtension)

Auftrag
ticket

object (TicketOrderExtension)

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 (PhoneNumber)
    }
  ]
}
Felder
email

string

E-Mail-Adresse des Nutzers, z. B.: janedoe@gmail.com.
firstName

string

Vorname des Nutzers
lastName

string

Nachname des Nutzers
displayName

string

Der Anzeigename des Nutzers kann vom Vor- oder Nachnamen abweichen.
phoneNumbers[]

object (PhoneNumber)

Telefonnummern des Nutzers

PhoneNumber

Standardmäßige Darstellung der Telefonnummer

JSON-Darstellung 
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
Felder
e164PhoneNumber

string

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

string

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

string

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

string

Die Quell-URL des Bildes. Bilder können das Format JPG, PNG und GIF haben (animiert und nicht animiert). Beispiel: https://www.agentx.com/logo.png. Erforderlich.
accessibilityText

string

Eine Textbeschreibung des Bildes, das für Barrierefreiheit verwendet werden soll, z.B. Screenreadern. Erforderlich.
height

integer

Die Höhe des Bilds in Pixeln Optional.
width

integer

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 (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
Felder
id

string

Optionale ID, die dem Händler zugewiesen wird (sofern vorhanden).
name

string

Der Name des Händlers, z. B. "Panera-Brot".
image

object (Image)

Das mit dem Händler verknüpfte Bild.
phoneNumbers[]

object (PhoneNumber)

Telefonnummern des Händlers
address

object (Location)

Adresse des Händlers.

Standort

Container, der einen Standort darstellt.

JSON-Darstellung 
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
Felder
coordinates

object (LatLng)

Geografische Koordinaten. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].
formattedAddress

string

Anzeigeadresse, z.B. „1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA“. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].
zipCode

string

Postleitzahl. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].
city

string

Stadt. Erfordert [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].
postalAddress

object (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

string

Name des Orts.
phoneNumber

string

Telefonnummer des Standorts, z.B. Kontaktnummer des Geschäftsstandorts oder Telefonnummer des Lieferorts
notes

string

Notizen zum Ort.
placeId

string

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

number

Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen.
longitude

number

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

integer

Die Schemaversion von PostalAddress. Die Einstellung muss 0 lauten, was der aktuellen Überarbeitung entspricht.

Alle neuen Überarbeitungen müssen abwärtskompatibel zu alten Überarbeitungen sein.
regionCode

string

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

string

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

string

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

string

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

string

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

string

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

string

Optional. Unterlokalität der Adresse. Dies können beispielsweise Stadtviertel, Stadtteile und Bezirke sein.
addressLines[]

string

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[]

string

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

string

Optional. Der Name der Organisation an der Adresse.

Inhalt

Wrapper für Werbebuchungen.

JSON-Darstellung 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
Felder
lineItems[]

object (LineItem)

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 (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
Felder
id

string

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

string

Name der Position, wie auf dem Beleg angegeben. Die maximal zulässige Länge beträgt 100 Zeichen.
userVisibleStateLabel
(deprecated)

string

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

object (Merchant)

Der Anbieter der jeweiligen Werbebuchung, falls dieser vom Gesamtauftrag abweicht Beispiel: Expedia-Auftrag mit Werbebuchungsanbieter ANA
priceAttributes[]

object (PriceAttribute)

Preis und Anpassungen auf Werbebuchungsebene.
followUpActions[]

object (Action)

Folgeaktionen in der Werbebuchung
recipients[]

object (UserInfo)

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

object (Image)

Kleines Bild, das mit diesem Element verknüpft ist, falls vorhanden.
description

string

Werbebuchungsbeschreibung.
notes[]

string

Zusätzliche Hinweise, die für diese bestimmte Position gelten, z. B. Stornierungsrichtlinien
disclosures[]

object (Disclosure)

Mit dieser Werbebuchung verknüpfte Offenlegungen.
vertical
(deprecated)

object

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: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.
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

object (PurchaseItemExtension)

Bestellungen wie Waren, Lebensmittel usw.
reservation

object (ReservationItemExtension)

Reservierungsbestellungen wie Restaurant, Haarschnitt usw.

PriceAttribute

Preisattribut eines Auftrags oder einer Werbebuchung.

JSON-Darstellung 
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
Felder
type

enum (Type)

Erforderlich: Art des Geldattributs.
name

string

Erforderlich: Der vom Nutzer angezeigte String des Preisattributs. Wird vom Händler gesendet und lokalisiert.
id

string

Optional: ID der Position, zu der dieser Preis gehört.
state

enum (State)

Erforderlich: Preisangabe: Schätzung vs. tatsächlicher Wert.
taxIncluded

boolean

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

object (Money)

Geldbetrag.
amountMillipercentage
(deprecated)

integer

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

string

Der aus drei Buchstaben bestehende Währungscode gemäß ISO 4217.
amountInMicros

string (int64 format)

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 (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
Felder
type

enum (Type)

Erforderlich: Aktionstyp.
title

string

Titel oder Label der Aktion, der bzw. der dem Nutzer angezeigt wird. Die maximal zulässige Länge beträgt 100 Zeichen.
openUrlAction

object (OpenUrlAction)

Erforderliche Maßnahmen
actionMetadata

object (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 (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
Felder
url

string

Das URL-Feld, entweder http- oder https-URLs zum Öffnen einer mit Apps verknüpften App oder einer Webseite
androidApp

object (AndroidApp)

Informationen zur Android-App, wenn die URL voraussichtlich von einer Android-App bereitgestellt wird.
urlTypeHint

enum (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 (VersionFilter)
    }
  ]
}
Felder
packageName

string

Paketname Der Paketname muss bei der Android-Auftragsausführung angegeben werden.
versions[]

object (VersionFilter)

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

integer

Code der Mindestversion oder 0 (einschließlich).
maxVersion

integer

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

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Offenlegung

Offenlegung von Produkten, Dienstleistungen oder Richtlinien, die dem Nutzer angezeigt werden können.

JSON-Darstellung 
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
Felder
title

string

Titel der Offenlegung. Beispiel: „Sicherheitsinformationen“.
disclosureText

object (DisclosureText)

Inhalt der Offenlegung. Weblinks sind zulässig.
presentationOptions

object (DisclosurePresentationOptions)

Darstellungsoptionen für die Offenlegung.

DisclosureText

Stellt einen Nur-Text mit Weblinks dar.

JSON-Darstellung 
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
Felder
template

string

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.

DisclosurePresentationOptions

Optionen für die Darstellung einer Offenlegung.

JSON-Darstellung 
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
Felder
presentationRequirement

enum (PresentationRequirement)

Die Offenlegungspflicht.
initiallyExpanded

boolean

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 (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": integer,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "productDetails": {
    object (ProductDetails)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Felder
status

enum (PurchaseStatus)

Erforderlich: Status auf Werbebuchungsebene.
userVisibleStatusLabel

string

Erforderlich: Für den Nutzer sichtbares Label/String für den Status. Die maximal zulässige Länge beträgt 50 Zeichen.
type

enum (PurchaseType)

Erforderlich: Art des Kaufs.
productId
(deprecated)

string

Die mit dieser Position verknüpfte Produkt- oder Angebots-ID.
quantity

integer

Menge des Artikels.
unitMeasure

object (MerchantUnitMeasure)

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

object (PurchaseReturnsInfo)

Gibt Informationen für diese Position zurück. Wenn die Richtlinie nicht konfiguriert ist, werden Informationen auf Auftragsebene für diese Werbebuchung übernommen.
fulfillmentInfo

object (PurchaseFulfillmentInfo)

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[]

object (ItemOption)

Zusätzliche Add-ons oder Unterelemente.
productDetails

object (ProductDetails)

Details zum Produkt
extension
(deprecated)

object

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 "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

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 (Unit)
}
Felder
measure

number

Wert: Beispiel 1.2.
unit

enum (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

boolean

Bei „true“ ist die Rückgabe zulässig.
daysToReturn

integer

Die Rückgabe ist innerhalb dieser Anzahl von Tagen möglich.
policyUrl

string

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 (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
Felder
id

string

Eindeutige Kennung für diese Dienstleistungsoption.
fulfillmentType

enum (Type)

Erforderlich: Der Typ der Auftragsausführung.
expectedFulfillmentTime

object (Time)

Ein Fenster, wenn ein Zeitraum angegeben ist, oder ETA, wenn eine einzelne Zeit angegeben ist. Voraussichtliche Liefer- oder Abholzeit.
expectedPreparationTime

object (Time)

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

object (Location)

Abhol- oder Lieferort.
expireTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
price

object (PriceAttribute)

Kosten dieser Option.
fulfillmentContact

object (UserInfo)

Nutzerkontakt für diese Auftragsausführung.
shippingMethodName

string

Name der Versandart, die vom Nutzer ausgewählt wurde.
storeCode

string

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

object (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

string

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 (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
Felder
pickupType

enum (PickupType)

Abholoption, z. B. IM GESCHÄFT, VORHERIGE usw.
curbsideInfo

object (CurbsideInfo)

Spezifische Angaben zur Abholung vor dem Laden. Wenn für pickupType nicht „CURBSIDE“ angegeben ist, wird dieses Feld ignoriert.
checkInInfo[]

object (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 (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
Felder
curbsideFulfillmentType

enum (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

object (Vehicle)

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 (Image)
  }
}
Felder
make

string

Fahrzeugmarke (z.B. „Honda“). Dies wird dem Nutzer angezeigt und muss lokalisiert werden. Erforderlich.
model

string

Fahrzeugmodell (z.B. „Grom“). Dies wird dem Nutzer angezeigt und muss lokalisiert werden. Erforderlich.
licensePlate

string

Kfz-Kennzeichen (z.B. „1ABC234“). Erforderlich.
colorName

string

Name der Fahrzeugfarbe, z. B. Schwarz (optional)
image

object (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 (CheckInType)
}
Felder
checkInType

enum (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 (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
Felder
id

string

Eindeutige Artikel-ID bei Optionen, bei denen es sich um Artikel handelt.
name

string

Optionsname.
prices[]

object (PriceAttribute)

Gesamtpreis der Option.
note

string

Hinweis zur Option.
quantity

integer

Bei Optionen, bei denen es sich um Artikel handelt, Menge.
productId

string

Die Produkt- oder Angebots-ID, die mit dieser Option verknüpft ist.
subOptions[]

object (ItemOption)

Zum Definieren anderer verschachtelter Unteroptionen.

ProductDetails

Details zum Produkt

JSON-Darstellung 
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
Felder
productId

string

Die mit dieser Position verknüpfte Produkt- oder Angebots-ID.
gtin

string

Global Trade Item Number des Produkts. Dies ist hilfreich, wenn das Attribut „offerId“ nicht im Merchant Center vorhanden ist. Optional.
plu

string

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

string

Vom Händler definierte Produktkategorie. Beispiel: "Startseite > Lebensmittel > Milchprodukte und Eier > Milch > Vollmilch
productAttributes

map (key: string, value: string)

Vom Händler bereitgestellte Details zum Produkt, z.B. { &quot;allergen&quot;: &quot;peanut&quot; }. Dies ist hilfreich, wenn das Attribut „offerId“ nicht im Merchant Center vorhanden ist. Optional.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ReservationItemExtension

Werbebuchungsinhalte für Reservierungsbestellungen wie Restaurant, Friseur usw.

JSON-Darstellung 
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": integer,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  }
}
Felder
status

enum (ReservationStatus)

Erforderlich: Reservierungsstatus.
userVisibleStatusLabel

string

Erforderlich: Für den Nutzer sichtbares Label/String für den Status. Die maximal zulässige Länge beträgt 50 Zeichen.
type

enum (ReservationType)

Art der Reservierung. Kann nicht festgelegt werden, wenn keine der Typoptionen anwendbar ist.
reservationTime

object (Time)

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

object (Time)

Zeitraum, der für den Nutzer akzeptabel ist.
confirmationCode

string

Bestätigungscode für diese Reservierung.
partySize

integer

Die Anzahl der Personen.
staffFacilitators[]

object (StaffFacilitator)

Personalunterstützer, die die Reservierung durchführen. Beispiel: Der Friseur.
location

object (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 (Image)
  }
}
Felder
name

string

Name der moderierenden Person Beispiel: „Max Mustermann“
image

object (Image)

Bilder des Künstlers

PaymentData

Zahlungsdaten zu einer Bestellung.

JSON-Darstellung 
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Felder
paymentResult

object (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

object (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 result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
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

string

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

string

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 (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Felder
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

Die angezeigten Informationen der Zahlungsmethode, die für die Transaktion verwendet wurde.
paymentMethodProvenance

enum (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 (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
Felder
paymentType

enum (PaymentType)

Die Art der Zahlung.
paymentMethodDisplayName

string

Für den Nutzer sichtbarer Name der Zahlungsmethode. Beispiel: VISA **** 1234 Girokonto **** 5678
paymentMethodVoiceName

string

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

string

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 (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Felder
status

enum (PurchaseStatus)

Erforderlich: Gesamtstatus der Bestellung.
userVisibleStatusLabel

string

Für den Nutzer sichtbares Label/String für den Status. Die maximal zulässige Länge beträgt 50 Zeichen.
type

enum (PurchaseType)

Erforderlich: Art des Kaufs.
returnsInfo

object (PurchaseReturnsInfo)

Rückgabeinformationen zur Bestellung.
fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informationen zur Ausführung der Bestellung.
purchaseLocationType

enum (PurchaseLocationType)

Ort des Kaufs (im Geschäft / online)
errors[]

object (PurchaseError)

Optional: Fehler, aufgrund derer diese Bestellung abgelehnt wurde.
extension
(deprecated)

object

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 "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

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 (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
Felder
type

enum (ErrorType)

Erforderlich: Dies ist der Grund, aus dem eine Bestellung vom Händler abgelehnt wird.
description

string

Zusätzliche Fehlerbeschreibung.
entityId

string

Die Entitäts-ID, die dem Fehler entspricht. Ein Beispiel hierfür ist „LineItemId“/„ItemOptionId“.
updatedPrice

object (PriceAttribute)

Relevant im Fall des Fehlertyps PRICE_CHANGED / INORRECT_PRICE.
availableQuantity

integer

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 (TicketEvent)
  }
}
Felder
ticketEvent

object (TicketEvent)

Das Ereignis wurde auf alle Werbebuchungstickets angewendet.

TicketEvent

Stellt ein einzelnes Ereignis dar.

JSON-Darstellung 
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
Felder
type

enum (Type)

Erforderlich: Typ der Ticketveranstaltung, z.B. Film, Konzert.
name

string

Erforderlich: Name des Ereignisses. Handelt es sich bei dem Ereignis beispielsweise um einen Film, sollte hier der Name des Films angegeben werden.
description

string

Beschreibung der Veranstaltung.
url

string

URL zu den Ereignisinformationen.
location

object (Location)

Der Ort, an dem das Ereignis stattfindet, oder eine Organisation.
eventCharacters[]

object (EventCharacter)

Die Zeichen, die sich auf dieses Ereignis beziehen. Dies können Regisseure oder Schauspieler eines Filmereignisses, Darsteller eines Konzerts usw. sein.
startDate

object (Time)

Start.
endDate

object (Time)

Ende.
doorTime

object (Time)

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 (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Felder
type

enum (Type)

Typ des Ereigniszeichens, z.B. Schauspieler oder Regisseur.
name

string

Name des Zeichens.
image

object (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

string

Der Titel der Nutzerbenachrichtigung. Die maximal zulässige Länge beträgt 30 Zeichen.
text

string

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

string

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 (TypeOverride)
    }
  ],
  "languageCode": string
}
Felder
id

string

Erforderlich. Global eindeutige ID der aktuellen Unterhaltungssitzung. Dieses Feld ist schreibgeschützt.
params

map (key: string, value: value (Value format))

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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
typeOverrides[]

object (TypeOverride)

Optional. Auf die Sitzung beschränkte Typen. Sitzungstypdefinitionen können vorhandene Typen ergänzen oder ersetzen. Typnamen müssen eindeutig sein.
languageCode

string

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 (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
Felder
name

string

Erforderlich. Name des Typs, der ergänzt oder überschrieben werden soll.
mode

enum (TypeOverrideMode)

Erforderlich. Wie dieser Typ mit anderen Typwerten zusammengeführt werden soll.
synonym

object (SynonymType)

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 (Entry)
    }
  ]
}
Felder
entries[]

object (Entry)

Erforderlich. Liste der Einträge für den Synonymtyp.

Eintrag

Ein Eintrag für einen Synonymtyp.

JSON-Darstellung 
{
  "name": string,
  "synonyms": [
    string
  ],
  "display": {
    object (EntryDisplay)
  }
}
Felder
name

string

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[]

string

Erforderlich. Liste der Synonyme für den Eintrag (z.B. "Fahrrad", "Zyklus").
display

object (EntryDisplay)

Optional. Die Informationen zum Element werden angezeigt.

EntryDisplay

JSON-Darstellung 
{
  "title": string,
  "description": string,
  "image": {
    object (Image)
  },
  "footer": string,
  "openUrl": {
    object (OpenUrl)
  }
}
Felder
title

string

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

string

Optional. Der Text der Karte.
image

object (Image)

Optional. Das Bild, das angezeigt werden soll.
footer

string

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

object (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 (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
Felder
locale

string

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

map (key: string, value: value (Value format))

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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
accountLinkingStatus

enum (AccountLinkingStatus)

Ob das Nutzerkonto mit der App verknüpft ist
verificationStatus

enum (UserVerificationStatus)

Zeigt den Bestätigungsstatus des Nutzers an.
lastSeenTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
engagement

object (Engagement)

Das Engagement des aktuellen Nutzers, einschließlich Abos von Intents.
packageEntitlements[]

object (PackageEntitlements)

Nutzerberechtigungen, die sich auf das mit der aktuellen Aktion verknüpfte Android-Paket beziehen.
permissions[]

enum (Permission)

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 (IntentSubscription)
    }
  ],
  "dailyUpdateIntents": [
    {
      object (IntentSubscription)
    }
  ]
}
Felder
pushNotificationIntents[]

object (IntentSubscription)

Enthält eine Liste von Intents, für die der Nutzer Push-Benachrichtigungen aktiviert hat.
dailyUpdateIntents[]

object (IntentSubscription)

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

string

Name des Intents, der abonniert wurde.
contentTitle

string

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 (Entitlement)
    }
  ]
}
Felder
packageName

string

Der im Aktionspaket angegebene Android-Paketname.
entitlements[]

object (Entitlement)

Die Berechtigungen des Nutzers für das angegebene Paket.

Berechtigung

Definiert die digitale Berechtigung eines Nutzers.

JSON-Darstellung 
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Felder
sku

string

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

enum (SkuType)

Der SKU-Typ.
inAppDetails

object (SignedData)

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

object (Struct format)

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

string

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

map (key: string, value: value (Value format))

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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Gerät

Stellt das Gerät dar, das der Nutzer verwendet, um eine Anfrage an die Aktion zu senden.

JSON-Darstellung 
{
  "capabilities": [
    enum (Capability)
  ],
  "currentLocation": {
    object (Location)
  },
  "timeZone": {
    object (TimeZone)
  }
}
Felder
capabilities[]

enum (Capability)

Erforderlich. die Funktionen des Geräts, das eine Anfrage an die Aktion sendet.
currentLocation

object (Location)

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

object (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.
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 (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
Felder
coordinates

object (LatLng)

Geografische Koordinaten. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION].
postalAddress

object (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

string

Zeitzone aus der IANA-Zeitzonendatenbank, z. B. "Amerika/New_York".
version

string

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 (MediaContext)
  },
  "canvas": {
    object (CanvasContext)
  }
}
Felder
media

object (MediaContext)

Enthält Kontextinformationen zur aktuellen aktiven Mediensitzung.
canvas

object (CanvasContext)

Enthält Kontextinformationen zum aktuellen Canvas.

MediaContext

Enthält Kontextinformationen zur aktuellen aktiven Mediensitzung.

JSON-Darstellung 
{
  "progress": string,
  "index": integer
}
Felder
progress

string (Duration format)

Medienfortschritt der aktuell aktiven Mediendatei.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".
index

integer

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

value (Value format)

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[]

string

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.