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 Verarbeitung der Anfrage für die Auftragsausführung. Beispielsweise kann eine Anfrage mit dem Ziel, Informationen abzurufen, einen Handler mit dem Namen "getFact" haben.

intent

object (Intent)

Erforderlich. Stellt den zuletzt 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 beim Aufruf der Funktion. Wird ausgefüllt, wenn der Aufruf zur Auftragsausführung im Rahmen einer Szene erfolgt. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/scenes.

session

object (Session)

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

user

object (User)

Erforderlich. Nutzer, der die Unterhaltung gestartet 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 für die Interaktion mit der Aktion verwendet.

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 Aufforderungen dar, die an den Nutzer gesendet werden sollen. Diese Aufforderungen werden an zuvor hinzugefügte Nachrichten angehängt, sofern sie nicht explizit überschrieben werden.

scene

object (Scene)

Optional. Stellt die aktuelle und 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 von der Auftragsausführung erstellt, aktualisiert oder entfernt werden.

user

object (User)

Optional. Wird verwendet, um Nutzerparameter anzugeben, 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. Damit kannst du zwischen Assistant-Geräten 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 von Actions on Google der Auftragsausführung zuordnet. Ermitteln Sie anhand des Handler-Namens, welchen Code Sie in der Auftragsausführung ausführen sollten. Ein Handler kann beispielsweise verwendet werden, um Informationen über die Bestellinformationen eines Nutzers mit einem Handler-Namen wie "OrderLookup" abzurufen, während ein anderer Produktinformationen aus einer Datenbank mit einem Handler-Namen wie "GetProductInfo" abruft.

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

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 werden. Dies ist eine Zuordnung des Namens des identifizierten Parameters zum Wert des Parameters, der aus der Nutzereingabe identifiziert wurde. Alle Parameter, die im übereinstimmenden Intent definiert und identifiziert werden, werden hier angezeigt.

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

query

string

Optional. Eingabe- oder gesprochene Eingabe des Endnutzers, der mit diesem Intent übereinstimmt. Dieses Feld wird ausgefüllt, wenn ein Intent basierend auf der Nutzereingabe zugeordnet wird.

IntentParameterValue

Stellt einen Wert für einen Intent-Parameter dar. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/types.

JSON-Darstellung
{
  "original": string,
  "resolved": value
}
Felder
original

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 der Nutzereingabe extrahiert wurde. Dieses Feld wird nur ausgefüllt, wenn der Parameter im zugeordneten Intent definiert ist und der Wert des Parameters beim Intent-Abgleich identifiziert werden konnte.

Ambiente

Stellen Sie eine Szene dar. Szenen können die Auftragsausführung aufrufen, Aufforderungen hinzufügen und Slotwerte vom Nutzer erfassen. Szenen werden durch Ereignisse oder Intents ausgelöst und können Ereignisse auslösen und Intents mit dem Übergang zu anderen Szenen verknüpfen.

JSON-Darstellung
{
  "name": string,
  "slotFillingStatus": enum (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 Slots, die der aktuellen Szene zugewiesen sind. Handler-Antworten können keine Slots zurückgeben, die nicht in der Anfrage gesendet wurden.

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

next

object (NextScene)

Optional. Informationen zur Szene, die als Nächstes hingenommen werden soll.

SlotFillingStatus

Gibt den aktuellen Status der Slot-Füllung an.

Enums
UNSPECIFIED Fallback-Wert, wenn das Feld für die Nutzung nicht ausgefüllt ist.
INITIALIZED Die Slots wurden initialisiert, aber die Slot-Füllung wurde nicht gestartet.
COLLECTING Die Slotwerte werden erfasst.
FINAL Alle Slotwerte sind endgültig und können nicht geändert werden.

Slot

Stellt einen Slot dar.

JSON-Darstellung
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
Felder
mode

enum (SlotMode)

Der Modus der Anzeigenfläche (erforderlich oder optional). Kann vom Entwickler festgelegt werden.

status

enum (SlotStatus)

Der Status der Anzeigenfläche.

value

value (Value format)

Der Wert der Anzeigenfläche. Wenn Sie diesen Wert in der Antwort ändern, wird auch der Wert in der Slot-Füllung geändert.

updated

boolean

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

prompt

object (Prompt)

Optional. Diese Aufforderung wird an den Nutzer gesendet, wenn er eine erforderliche Anzeigenfläche füllen muss. Diese Eingabeaufforderung überschreibt die vorhandene Eingabeaufforderung, die in der Konsole definiert ist. Dieses Feld ist nicht in der Webhook-Anfrage enthalten.

SlotMode

Stellt den Modus eines Slots dar, d. h., ob er erforderlich ist oder nicht.

Enums
MODE_UNSPECIFIED Fallback-Wert, wenn das Feld für die Nutzung nicht ausgefüllt ist.
OPTIONAL Gibt an, dass der Slot nicht erforderlich ist, um die Slot-Füllung abzuschließen.
REQUIRED Gibt an, dass der Slot erforderlich ist, um die Slot-Füllung abzuschließen.

SlotStatus

Stellt den Status eines Slots dar.

Enums
SLOT_UNSPECIFIED Fallback-Wert, wenn das Feld für die Nutzung nicht ausgefüllt ist.
EMPTY Gibt an, dass der Slot keine Werte hat. Dieser Status kann nicht über die Antwort geändert werden.
INVALID Gibt an, dass der Slotwert ungültig ist. Dieser Status kann über die Antwort festgelegt werden.
FILLED Gibt an, dass der Slot einen Wert hat. Dieser Status kann nicht über die Antwort geändert werden.

Eingabeaufforderung

Eine Antwort an einen Nutzer darstellen. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts.

JSON-Darstellung
{
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
Felder
override

boolean

Optional. Modus für die Zusammenführung dieser Nachrichten mit zuvor definierten Nachrichten. „true“ löscht alle zuvor definierten Nachrichten (erste und letzte einfache, Inhalt, Link und Canvas mit Vorschlägen) und fügt Nachrichten hinzu, die in diesem Prompt definiert wurden. Bei „false“ werden die in diesem Prompt definierten Nachrichten den Nachrichten hinzugefügt, die in den vorherigen Antworten definiert wurden. Wenn Sie dieses Feld auf „false“ belassen, können Daten auch an einige Felder in den einfachen Prompts, der Vorschlagsaufforderung und dem Canvas-Prompt (Teil der Inhaltsaufforderung) angehängt werden. Die Inhalts- und Linkmeldungen werden immer überschrieben, wenn sie in der Eingabeaufforderung definiert sind. Der Standardwert ist „false“.

firstSimple

object (Simple)

Optional. Die erste Sprach- und Textantwort.

content

object (Content)

Optional. Dem Nutzer angezeigte Inhalte wie Karten, Listen oder Medien.

lastSimple

object (Simple)

Optional. Die letzte Antwort per Sprach- oder Texteingabe.

suggestions[]

object (Suggestion)

Optional. Vorschläge, die dem Nutzer immer am Ende der Antwort angezeigt werden. Wenn das Feld „override“ in der zugehörigen Aufforderung „false“ ist, werden die in diesem Feld definierten Titel den Titeln hinzugefügt, die in den zuvor definierten Vorschlägen für Vorschläge definiert wurden. Doppelte Werte werden entfernt.

canvas

object (Canvas)

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

orderUpdate

object (OrderUpdate)

Die optionale Aktion antwortet mit einer OrderUpdate, nachdem sie die Bestellung während des Transaktionsablaufs erhalten hat. Nach Erhalt dieser Informationen zeichnet Google diese Aktualisierung der Bestellung auf. Ist der Vorgang erfolgreich, wird eine Belegkarte zusammen mit der Sprachausgabe angezeigt, die auf Anzeigegeräten gesendet wird.

Einfach

Stellt eine einfache Aufforderung dar, die an einen Nutzer gesendet werden soll. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-simple.

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

string

Optional. Stellt die Sprache dar, die für den Nutzer gesprochen wird. Kann SSML oder Text-to-Speech sein. Wenn das Feld „override“ in der zugehörigen Aufforderung „true“ ist, ersetzt die in diesem Feld definierte Sprache die Sprache der vorherigen einfachen Aufforderung. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/ssml.

text

string

Optionaler Text, der im Chat-Infofeld angezeigt wird. Wenn nicht angegeben, wird das obige Sprachfeld angezeigt. Auf 640 Zeichen begrenzt. Wenn das Feld „Überschreiben“ in der zugehörigen Aufforderung „true“ ist, wird der in diesem Feld definierte Text durch den Text der vorherigen einfachen Aufforderung ersetzt.

Inhalte

Containerobjekt für umfangreiche Prompts oder Auswahlaufforderungen.

JSON-Darstellung
{

  // Union field 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 Reihe von Medien angibt, die wiedergegeben werden sollen.

collection

object (Collection)

Eine Karte mit einer Reihe von Optionen, aus denen Sie auswählen können.

list

object (List)

Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann.

collectionBrowse

object (CollectionBrowse)

Eine Karte mit mehreren Webseiten, die geöffnet werden sollen.

Infokarte

Eine einfache Karte zur Anzeige einiger Informationen, z.B. ein Bild und/oder Text. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-rich#basic_card.

JSON-Darstellung
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
Felder
title

string

Gesamttitel der Karte. Optional.

subtitle

string

Optional.

text

string

Text der Karte Unterstützt eine begrenzte Anzahl 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, die für Barrierefreiheit verwendet werden soll, z.B. Screenreader. Erforderlich.

height

integer

Die Höhe des Bilds in Pixeln Optional.

width

integer

Die Breite des Bilds in Pixeln Optional.

ImageFill

Mögliche Bildanzeigeoptionen, die die Darstellung des Bildes beeinflussen können. Diese Option sollte verwendet werden, wenn das Seitenverhältnis des Bildes nicht mit dem des Bildcontainers übereinstimmt.

Enums
UNSPECIFIED
GRAY Füllen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit grauen Balken.
WHITE Füllen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit weißen Balken.
CROPPED Das Bild wird so skaliert, dass die Breite und Höhe des Bilds den Abmessungen des Containers entsprechen oder diese überschreiten. Dadurch wird möglicherweise der obere und untere Bereich des Bildes abgeschnitten, wenn die skalierte Bildhöhe größer als die Containerhöhe ist. Wenn die skalierte Bildbreite größer als die Containerbreite ist, wird die linke und rechte Bildbreite abgeschnitten. Dies ähnelt dem „Zoommodus“ auf einem Breitbildfernseher bei der Wiedergabe eines 4:3-Videos.

OpenUrl

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

string

Das URL-Feld, das einen der folgenden Werte annehmen kann: – HTTP- oder HTTPS-URLs zum Öffnen einer mit der App verknüpften App oder einer Webseite

hint

enum (UrlHint)

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

UrlHint

Verschiedene Arten von URL-Hinweisen.

Enums
AMP URL, die direkt auf AMP-Inhalte verweist, oder auf eine kanonische URL, die über auf AMP-Inhalte verweist. Weitere Informationen finden Sie unter https://amp.dev/.

Tabelle

Eine Tabellenkarte zum Anzeigen einer Tabelle mit Text. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-rich#table_cards.

JSON-Darstellung
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
Felder
title

string

Gesamttitel der Tabelle. Optional, muss jedoch festgelegt werden, wenn Untertitel angegeben wurden.

subtitle

string

Untertitel für die Tabelle. Optional.

image

object (Image)

Mit der Tabelle verknüpftes Bild. Optional.

columns[]

object (TableColumn)

Überschriften und Spaltenausrichtung.

rows[]

object (TableRow)

Zeilendaten der Tabelle Die ersten 3 Zeilen werden garantiert angezeigt, aber andere werden auf bestimmten Oberflächen möglicherweise ausgeschnitten. Testen Sie mit dem Simulator, welche Zeilen für eine bestimmte Oberfläche angezeigt werden. Auf Oberflächen, die die WEB_BROWSER-Funktion unterstützen, können Sie den Nutzer auf eine Webseite mit mehr Daten verweisen.

button

object (Link)

Schaltfläche.

TableColumn

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

string

Überschrift der Spalte.

align

enum (HorizontalAlignment)

Horizontale Ausrichtung des Inhalts in der Spalte „Richtig“. Wenn kein Wert angegeben ist, wird der Inhalt an der obersten Kante ausgerichtet.

HorizontalAlignment

Die Ausrichtung des Inhalts innerhalb der Zelle.

Enums
UNSPECIFIED
LEADING Führende Kante der Zelle Das ist die Standardeinstellung.
CENTER Der Inhalt ist an der Spaltenmitte ausgerichtet.
TRAILING Der Inhalt ist am unteren Rand der Spalte ausgerichtet.

TableRow

Beschreibt eine Zeile in der Tabelle.

JSON-Darstellung
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Felder
cells[]

object (TableCell)

Zellen in dieser Zeile. Die ersten 3 Zellen werden garantiert angezeigt, andere werden jedoch möglicherweise auf bestimmten Oberflächen ausgeschnitten. Testen Sie mit dem Simulator, welche Zellen für eine bestimmte Oberfläche angezeigt werden.

divider

boolean

Gibt an, ob nach jeder Zeile eine Trennlinie eingefügt werden soll.

TableCell

Beschreibt eine Zelle in einer Zeile.

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

string

Textinhalt der Zelle

Medien

Stellt ein Medienobjekt dar. Enthält Informationen zu den Medien, z. B. Name, Beschreibung und URL. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-media.

JSON-Darstellung
{
  "mediaType": enum (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 Arten der Mediensteuerung, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, erfolgt bei einem bestimmten Medienereignis die Anfrage an 15:00 Uhr. Wenn die Richtlinie nicht konfiguriert ist, muss Drittanbieter immer noch zwei Standardsteuerungstypen verarbeiten: FINISHED und FAILED.

mediaObjects[]

object (MediaObject)

Liste der Medienobjekte

repeatMode

enum (RepeatMode)

Wiederholungsmodus für die Liste der Medienobjekte.

firstMediaObjectIndex

integer

Der 0-basierte Index des ersten Medienobjekts in „mediaObjects“, das wiedergegeben werden soll. Wenn nicht angegeben, null oder außerhalb der Grenzen, beginnt die Wiedergabe beim ersten Medienobjekt in „mediaObjects“.

MediaType

Medientyp dieser Antwort.

Enums
MEDIA_TYPE_UNSPECIFIED
AUDIO Audiodatei.
MEDIA_STATUS_ACK Antwort zur Bestätigung eines Medienstatusberichts.

OptionalMediaControls

Optionale Arten der Mediensteuerung, die von der Medienantwort unterstützt werden

Enums
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Nicht angegebener Wert
PAUSED Ereignis pausiert. Wird ausgelöst, wenn der Nutzer die Medien pausiert
STOPPED Termin beendet. Wird ausgelöst, wenn der Nutzer die 3P-Sitzung während der Medienwiedergabe verlässt.

MediaObject

Stellt ein einzelnes Medienobjekt dar

JSON-Darstellung
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (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 wird.

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 wie das Cover des Albums usw.

icon

object (Image)

Ein kleines Bildsymbol, das rechts neben dem Titel angezeigt wird. Die Größe wird auf 36 × 36 dp angepasst.

RepeatMode

Die Typen des Wiederholungsmodus für eine Liste von Medienobjekten.

Enums
REPEAT_MODE_UNSPECIFIED Entspricht AUS.
OFF Mediensitzung am Ende des letzten Medienobjekts beenden.
ALL Schleife zum Anfang des ersten Medienobjekts, wenn das Ende des letzten Medienobjekts erreicht ist.

Sammlung

Eine Karte mit einer Reihe von Optionen, aus denen ausgewählt werden kann. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-selection#collection.

JSON-Darstellung
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Felder
title

string

Titel der Sammlung Optional.

subtitle

string

Untertitel der Sammlung Optional.

items[]

object (CollectionItem)

Eine Liste von Elementen. Er darf mindestens 2 und maximal 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 Zugangscodes im verknüpften Typ übereinstimmt.

Liste

Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-selection#list.

JSON-Darstellung
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Felder
title

string

Titel der Liste. Optional.

subtitle

string

Untertitel der Liste. Optional.

items[]

object (ListItem)

Eine Liste von Elementen. Sie kann einen Mindestwert von 2 und einen Höchstwert von 30 haben.

ListItem

Ein Element in der Liste

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

string

Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Zugangscodes im verknüpften Typ übereinstimmt.

CollectionBrowse

Stellt eine Reihe von Webdokumenten als eine Sammlung großer Kacheln dar. Sie können Elemente auswählen, um das zugehörige Webdokument in einem Web Viewer zu öffnen. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.

JSON-Darstellung
{
  "items": [
    {
      object (Item)
    }
  ],
  "imageFill": enum (ImageFill)
}
Felder
items[]

object (Item)

Eine Liste von Elementen. Er darf mindestens 2 und maximal 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, angezeigt unter der Beschreibung. Einzelne Textzeile, durch Auslassungspunkte abgeschnitten.

image

object (Image)

Bild für das Sammlungselement.

openUriAction

object (OpenUrl)

Erforderlich. URI, der geöffnet werden soll, wenn das Element ausgewählt wurde.

Vorschlag

Vorschläge bieten Nutzern auf Display-fähigen Geräten Chips für Vorschläge, wenn Assistant die Aufforderung anzeigt. Verwenden Sie Vorschlags-Chips, um Nutzerantworten zu kennzeichnen und die Unterhaltung fortzusetzen oder neu auszurichten. Wenn Sie darauf tippen, wird der angezeigte Text wortgetreu an die Unterhaltung zurückgegeben, so als ob der Nutzer ihn eingegeben hätte. Weitere Informationen finden Sie unter https://developers.google.com/assistant/conversational/prompts#suggestions.

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

string

Erforderlich. Der Text im Vorschlags-Chip. Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel darf unter den Vorschlags-Chips nur einmal vorkommen. Maximal 25 Zeichen

Canvas

Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. Dies kann zusammen mit dem Feld „firstSimple“ in der zugehörigen Aufforderung verwendet werden, um mit dem Nutzer zu sprechen und zusätzlich eine interaktive Canvas-Antwort anzuzeigen. Die maximale Größe der Antwort beträgt 50.000 Byte. Weitere Informationen finden Sie unter https://developers.google.com/assistant/interactivecanvas.

JSON-Darstellung
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "continuousMatchConfig": {
    object (ContinuousMatchConfig)
  }
}
Felder
url

string

URL der interaktiven Canvas-Web-App, die geladen werden soll. Wenn die Richtlinie nicht konfiguriert ist, wird die URL des aktuellen aktiven Canvas wiederverwendet.

data[]

value (Value format)

Optional. JSON-Daten, die als Ereignis an die Webseite mit dem immersiven Erlebnis übergeben werden. Wenn das Feld „Überschreiben“ im zugehörigen Prompt „false“ ist, werden die in diesem Canvas-Prompt definierten Datenwerte hinzugefügt, nachdem die Datenwerte aus den vorherigen Canvas-Prompts hinzugefügt wurden.

suppressMic

boolean

Optional. Standardwert: false.

continuousMatchConfig

object (ContinuousMatchConfig)

Konfiguration zum Initiieren des kontinuierlichen Abgleichmodus.

ContinuousMatchConfig

Konfiguration zum Initiieren des kontinuierlichen Abgleichmodus.

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

object (ExpectedPhrase)

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

durationSeconds

integer

Dauer, für die der kontinuierliche Abgleichmodus aktiviert bleibt. Falls angegeben, wird das Mikrofon bei Ablauf der Zeit deaktiviert. Der maximal zulässige Wert ist 180.

ExpectedPhrase

JSON-Darstellung
{
  "phrase": string,
  "alternativePhrases": [
    string
  ]
}
Felder
phrase

string

Die passende Wortgruppe bei einer Sitzung im Modus „Kontinuierliche Übereinstimmung“

alternativePhrases[]

string

Einige Wortgruppen werden vom Sprachmodell möglicherweise auch bei Sprachgewichtung falsch erkannt. So können Entwickler alternative Trigger für Homophone angeben.

OrderUpdate

Aktualisieren Sie eine Bestellung.

JSON-Darstellung
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Felder
type
(deprecated)

enum (Type)

Eingestellt: Verwende stattdessen „OrderUpdate.update_mask“. Wenn der Typ = SNAPSHOT lautet, sollte OrderUpdate.order die gesamte Bestellung sein. Wenn der Typ = ORDER_STATUS, entspricht dies der Statusänderung auf Auftragsebene. Nur „order.last_update_time“ und dieser Branchenstatus werden abgerufen. Hinweis: type.ORDER_STATUS unterstützt nur PurcahaseOrderExtension-Statusaktualisierungen. Es ist nicht geplant, diesen Support zu erweitern. Stattdessen empfehlen wir „updateMask“, da es allgemeiner und erweiterbar ist und für alle Branchen verwendet werden kann.

order

object (Order)

updateMask

string (FieldMask format)

Hinweis: Für die folgenden Sonderfelder gibt es folgende Hinweise bzw. Empfehlungen: 1. order.last_update_time wird immer im Rahmen der Aktualisierungsanfrage aktualisiert. 2. order.create_time, order.google_order_id und order.merchant_order_id werden ignoriert, wenn sie als Teil von „updateMask“ bereitgestellt werden.

Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

userNotification

object (UserNotification)

Wenn dieses Flag angegeben ist, wird dem Nutzer eine Benachrichtigung mit dem angegebenen Titel und Text angezeigt. Das Angeben einer Benachrichtigung ist ein Vorschlag für die Benachrichtigung und führt nicht zwangsläufig zu einer Benachrichtigung.

reason

string

Grund für die Änderung/Aktualisierung.

Typ

Eingestellt: Verwende stattdessen „OrderUpdate.update_mask“. Aktualisierungen für einen Auftrag sind zulässig.

Enums
TYPE_UNSPECIFIED Typ nicht angegeben; sollte nicht explizit festgelegt werden.
ORDER_STATUS Aktualisieren Sie nur den Status der Bestellung.
SNAPSHOT Bestellübersicht aktualisieren.

Bestellung

Auftragsentität. Hinweis: 1. Sofern nicht anders angegeben, müssen alle Strings auf allen Ebenen weniger als 1.000 Zeichen lang sein. 2. Sofern nicht anders angegeben, müssen alle wiederkehrenden Felder auf allen Ebenen kleiner als 50 sein. 3. Falls angegeben, müssen alle Zeitstempel auf allen Ebenen gültige Zeitstempel sein.

JSON-Darstellung
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (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 Aktualisierungen der Bestellung erforderlich. Diese ID kann auf die angegebene googleOrderId oder einen anderen eindeutigen Wert festgelegt werden. Beachten Sie, dass die ID, die Nutzern präsentiert wird, die uservisibleOrderId ist, bei der es sich möglicherweise um einen anderen, nutzerfreundlicheren Wert handelt. Die maximal zulässige Länge beträgt 128 Zeichen.

userVisibleOrderId

string

Die für den Nutzer sichtbare ID, die auf die aktuelle Bestellung verweist. Diese ID sollte mit der ID übereinstimmen, die in anderen Kontexten wie Websites, Apps und E-Mails für diese Bestellung angezeigt wird.

userVisibleStateLabel
(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 Nanosekundenauflösung 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 des Auftrags. Erforderlich für OrderUpdate.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 ermöglicht hat. Dieser kann sich von einem Anbieter auf Werbebuchungsebene unterscheiden. Beispiel: Expedia-Auftrag mit Werbebuchung von ANA

contents

object (Contents)

Erforderlich: Auftragsinhalte, die eine Gruppe von Werbebuchungen sind.

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/den vorgeschlagenen Auftrag gelten.

note

string

Notizen, die einer Bestellung zugeordnet sind.

promotions[]

object (Promotion)

Alle Werbeaktionen, die mit dieser Bestellung verknüpft sind.

disclosures[]

object (Disclosure)

Offenlegungen im Zusammenhang mit dieser Bestellung.

vertical
(deprecated)

object

Eingestellt: Verwenden Sie stattdessen Branchen. Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie nicht in einer Werbebuchung überschrieben werden. Diese Branche muss dem Branchentyp auf Werbebuchungsebene entsprechen. Mögliche Werte: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Ein Objekt mit Feldern eines beliebigen Typs. 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 nicht in einer Werbebuchung überschrieben werden. Diese Branche muss dem Branchentyp auf Werbebuchungsebene entsprechen. Für verticals ist nur einer der folgenden Werte zulässig:
purchase

object (PurchaseOrderExtension)

Auftrag

ticket

object (TicketOrderExtension)

Ticketbestellung

UserInfo

Informationen zum Nutzer. Dieses Feld wird verwendet, um Informationen des Nutzers darzustellen, der mit einer Bestellung verknüpft ist.

JSON-Darstellung
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (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

Anzeigename des Nutzers, der sich vom Vor- oder Nachnamen unterscheiden kann

phoneNumbers[]

object (PhoneNumber)

Telefonnummern des Nutzers

PhoneNumber

Standarddarstellung der Telefonnummer.

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

string

Telefonnummer im E.164-Format, wie in der Empfehlung E.164 der International Telecommunication Union (ITU) definiert. Wiki-Link: https://en.wikipedia.org/wiki/E.164

extension

string

Die Erweiterung ist in den ITU-Empfehlungen nicht standardisiert, mit der Ausnahme, dass sie als Zahlenfolge mit einer maximalen Länge von 40 Ziffern definiert ist. Er wird hier als String definiert, um die mögliche Verwendung einer führenden Null in der Erweiterung zu berücksichtigen. Organisationen haben dabei völlige Freiheit, da kein Standard definiert ist. Neben Ziffern können hier auch andere Wählzeichen wie „,“ gespeichert werden, die eine Wartezeit anzeigen. Beispiel: In xxx-xxx-xxxx Durchwahl 123 ist „123“ die Durchwahl.

preferredDomesticCarrierCode

string

Der Code zur Auswahl des Mobilfunkanbieters, der bei Anrufen dieser Telefonnummer im Inland bevorzugt wird Dazu gehören auch Codes, die in einigen Ländern gewählt werden müssen, wenn Sie von Festnetz- zu Mobiltelefonen anrufen oder umgekehrt. In Kolumbien muss zum Beispiel bei Anrufen von einem Mobiltelefon zu einem inländischen Festnetz und umgekehrt eine „3“ vor der Telefonnummer gewählt werden. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code

Hierbei handelt es sich um den „bevorzugten“ Code, d. h., andere Codes können ebenfalls verwendet werden.

Bild

Ein Bild, das auf der Karte angezeigt wird.

JSON-Darstellung
{
  "url": string,
  "accessibilityText": string,
  "height": integer,
  "width": integer
}
Felder
url

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, die für Barrierefreiheit verwendet werden soll, z.B. Screenreader. Erforderlich.

height

integer

Die Höhe des Bilds in Pixeln Optional.

width

integer

Die Breite des Bilds in Pixeln Optional.

Händler

Händler für den Einkaufswagen/die Bestellung/die Werbebuchung.

JSON-Darstellung
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
Felder
id

string

Optionale ID, die dem Händler zugewiesen ist, falls vorhanden.

name

string

Der Name des Händlers, z. B. „Panera Bread“.

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)

Geokoordinaten: Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

Angezeigte Adresse, z.B. „1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA“. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

zipCode

string

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

city

string

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

postalAddress

object (PostalAddress)

Postanschrift. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

name

string

Name des Orts.

phoneNumber

string

Telefonnummer des Standorts, z. B. Kontaktnummer des Unternehmensstandorts oder Telefonnummer des Lieferorts

notes

string

Hinweise 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. Dies wird als Paar von Double-Werten zur Darstellung von Breiten- und Längengraden ausgedrückt. Sofern nicht anders angegeben, muss dieses Objekt dem WGS84-Standard entsprechen. Die Werte müssen innerhalb normalisierter Bereiche liegen.

JSON-Darstellung
{
  "latitude": number,
  "longitude": number
}
Felder
latitude

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 in Ländern, in denen dieses Feld verwendet wird, keine UI-Elemente für die Eingabe oder Bearbeitung von Feldern sehen.

Weitere Informationen zur Verwendung dieses Schemas finden Sie unter https://support.google.com/business/answer/6397478.

JSON-Darstellung
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Felder
revision

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 Auftragswerbebuchungen. Mindestens 1 Werbebuchung ist erforderlich, höchstens 50. Alle Werbebuchungen müssen zur selben Branche gehören.

LineItem

Eine Werbebuchung enthält eine Branche. Ein Auftrag oder Einkaufswagen kann mehrere Werbebuchungen derselben Branche enthalten. Unterwerbebuchungen, Add-ons usw. sollten je nach Anwendungsfall in vertikalen Proto-Dateien definiert werden. Hinweis: 1. Sofern nicht anders angegeben, müssen alle Strings auf allen Ebenen weniger als 1.000 Zeichen lang sein. 2. Sofern nicht anders angegeben, müssen alle wiederkehrenden Felder auf allen Ebenen kleiner als 50 sein. 3. Falls angegeben, müssen alle Zeitstempel auf allen Ebenen gültige Zeitstempel sein.

JSON-Darstellung
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (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 ID für die Werbebuchung. Wird verwendet, um eine vorhandene Werbebuchung bei der Anwendung von Teilaktualisierungen zu identifizieren. Die maximal zulässige Länge beträgt 64 Zeichen.

name

string

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

userVisibleStateLabel
(deprecated)

string

Veraltet. Verwenden Sie stattdessen den Status auf Branchenebene. Verwenden Sie für Käufe beispielsweise PurchaseOrderExtension.status. Für den Nutzer sichtbares Label für den Status dieser Werbebuchung.

provider

object (Merchant)

Der Anbieter der jeweiligen Werbebuchung, falls abweichend vom Gesamtauftrag Beispiel: Expedia-Auftrag bei Werbebuchungstyp „ANA“

priceAttributes[]

object (PriceAttribute)

Preis und Anpassungen auf Werbebuchungsebene

followUpActions[]

object (Action)

Follow-up-Aktionen für Werbebuchung.

recipients[]

object (UserInfo)

Für Kunden auf Werbebuchungsebene kann dieser Wert vom Käufer auf Auftragsebene abweichen. Beispiel: Nutzer X hat eine Restaurantreservierung unter dem Namen von Nutzer Y vorgenommen.

image

object (Image)

Kleines, mit diesem Element verknüpftes Bild, falls vorhanden

description

string

Beschreibung der Werbebuchung.

notes[]

string

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

disclosures[]

object (Disclosure)

Offenlegungen im Zusammenhang mit dieser Position.

vertical
(deprecated)

object

Eingestellt: Verwenden Sie stattdessen Branchen. Erforderlich: Semantischer Content der Werbebuchung basierend auf Typ/Branche Jede Branche sollte eigene Details zur Auftragsausführung enthalten. Muss einer der folgenden Werte sein: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

Ein Objekt mit Feldern eines beliebigen Typs. 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: Semantischer Content der Werbebuchung basierend auf Typ/Branche Jede Branche sollte eigene Details zur Auftragsausführung enthalten. Für verticals ist nur einer der folgenden Werte zulässig:
purchase

object (PurchaseItemExtension)

Bestellungen wie Waren, Essen usw.

reservation

object (ReservationItemExtension)

Reservierungsbestellungen wie Restaurant, Friseur usw.

PriceAttribute

Preisattribut einer Bestellung oder 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: Attribut für die Art des Geldes.

name

string

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

id

string

Optional: ID der Position, der dieser Preis entspricht.

state

enum (State)

Erforderlich: Status des Preises: Schätzung vs. tatsächlicher Preis

taxIncluded

boolean

Gibt an, ob der Preis inklusive Steuern ist.

Union-Feld spec. Stellt entweder einen Geldbetrag oder einen Milli-Prozentsatz dar. Für spec ist nur einer der folgenden Werte zulässig:
amount

object (Money)

Geldbetrag.

amountMillipercentage
(deprecated)

integer

Die Prozentspezifikation zu 1/1000 Prozent. Beispiel: 8,750% wird als 8.750 dargestellt, negative Prozentsätze für Rabatte in Prozent. Dieses Feld wird verworfen. Wenn ein solider Anwendungsfall erforderlich ist, können Sie das Video wieder hinzufügen.

Typ

Der Geldtyp.

Enums
TYPE_UNSPECIFIED Der Typ ist nicht angegeben. Clients sollten ihn nicht explizit festlegen.
REGULAR Regulärer Preis, bevor Rabatte angewendet werden.
DISCOUNT Wird von der Zwischensumme abgezogen.
TAX Wird der Zwischensumme hinzugefügt.
DELIVERY Wird der Zwischensumme hinzugefügt.
SUBTOTAL Zwischensumme, bevor Gebühren anfallen können.
FEE Etwaige zusätzliche Gebühren.
GRATUITY Wird der Zwischensumme hinzugefügt.
TOTAL Angezeigter Preis des Auftrags oder der Werbebuchung

Status

Stellt den Preisstatus dar.

Enums
STATE_UNSPECIFIED Nicht angegeben.
ESTIMATE Der Preis ist nur eine Schätzung, aber der endgültige Betrag würde ungefähr diesem Betrag entsprechen. Beispiel: Wenn die Steuer zum Zeitpunkt der Transaktion nicht genau bekannt ist, ergibt sich ein ESTIMATE-Betrag.
ACTUAL Tatsächlicher Preis, der dem Nutzer berechnet wird.

Geldbetrag

Stellt einen Geldbetrag mit Währungstyp dar.

JSON-Darstellung
{
  "currencyCode": string,
  "amountInMicros": string
}
Felder
currencyCode

string

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

amountInMicros

string (int64 format)

Betrag in Mikroeinheiten. Dieses Feld sollte beispielsweise als 1990000 für 1, 99 $festgelegt werden.

Aktion

Eine Folgeaktion in Bezug auf den Auftrag oder die Werbebuchung.

JSON-Darstellung
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
Felder
type

enum (Type)

Erforderlich: Art der Aktion.

title

string

Titel oder Label der Aktion, 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 angegebene Aktion.
VIEW_DETAILS Aktion „Bestelldetails ansehen“.
MODIFY Aktion zum Ändern der Bestellung.
CANCEL Bestellaktion abbrechen.
RETURN Aktion für Rückgabebestellung.
EXCHANGE Aktion für Anzeigenplattform-Bestellung.
EMAIL

E-Mail-Aktion. Die Typen EMAIL und CALL werden nicht mehr unterstützt. openUrlAction.url kann als Telefonnummer oder E-Mail-Adresse verwendet werden.

CALL

Anrufaktion.

REORDER Aktion „Neu anordnen“.
REVIEW Bestellaktion überprüfen.
CUSTOMER_SERVICE Kundenservice kontaktieren.
FIX_ISSUE Verweisen Sie auf die Website oder App des Händlers, um das Problem zu beheben.
DIRECTION Link zur Wegbeschreibung.

OpenUrlAction

Öffnet die angegebene URL.

JSON-Darstellung
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
Felder
url

string

Das URL-Feld, das einen der folgenden Werte annehmen kann: – HTTP- oder HTTPS-URLs zum Öffnen einer mit der App verknüpften App oder einer Webseite

androidApp

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 bei der 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 die Anwendung durch jede Filterübereinstimmung ausgelöst.

VersionFilter

VersionFilter sollte einbezogen werden, wenn bestimmte Versionen der Anwendung erforderlich sind.

JSON-Darstellung
{
  "minVersion": integer,
  "maxVersion": integer
}
Felder
minVersion

integer

Mindestversionscode oder 0 (einschließlich).

maxVersion

integer

Code für die maximale Version (einschließlich). Der berücksichtigte Bereich ist [minVersion:maxVersion]. Ein Nullbereich gilt für jede Version. Beispiele: Um eine einzelne Version anzugeben, verwenden Sie: [target_version:target_version]. Wenn Sie eine beliebige Version angeben möchten, lassen Sie „minVersion“ und „maxVersion“ nicht angegeben. Wenn Sie alle Versionen bis „maxVersion“ angeben möchten, geben Sie „minVersion“ nicht an. Wenn Sie alle Versionen aus „minVersion“ angeben möchten, geben Sie für „maxVersion“ keine Angabe.

UrlTypeHint

Verschiedene Arten von URL-Hinweisen.

Enums
URL_TYPE_HINT_UNSPECIFIED Ohne Angabe
AMP_CONTENT URL, die direkt auf AMP-Inhalte verweist, oder auf eine kanonische URL, die über <link rel="amphtml"> auf AMP-Inhalte verweist

ActionMetadata

Zugehörige Metadaten pro Aktion.

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

string (Timestamp format)

Zeitpunkt, zu dem diese Aktion abläuft.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Offenlegung

Informationen zu 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 erlaubt.

presentationOptions

object (DisclosurePresentationOptions)

Darstellungsoptionen für die Offenlegung.

DisclosureText

Stellt einen einfachen 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 einzufügenden Textlink. Beispiel: „WARNUNG: Dieses Produkt kann Chemikalien ausgesetzt werden, die laut dem US-Bundesstaat Kalifornien Krebs verursachen können. Weitere Informationen finden Sie unter {0}." Dieser Offenlegungstext darf keine Werbeinhalte oder anzeigenähnlichen Inhalte enthalten.

DisclosurePresentationOptions

Optionen für die Darstellung einer Offenlegung.

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

enum (PresentationRequirement)

Die Offenlegung muss vorgelegt werden.

initiallyExpanded

boolean

Gibt an, ob der Inhalt der Offenlegung anfangs erweitert werden soll. Standardmäßig ist sie zunächst minimiert.

PresentationRequirement

Voraussetzung für die Präsentation der Offenlegung.

Enums
REQUIREMENT_UNSPECIFIED Nicht angegebene Anforderung. Sollte nicht explizit festgelegt werden.
REQUIREMENT_OPTIONAL Die Offenlegung ist optional. Sie kann übersprungen werden, wenn das Gerät die Anzeige von Offenlegungen nicht unterstützt.
REQUIREMENT_REQUIRED Die Offenlegung ist erforderlich. Wenn das Gerät die Darstellung von Offenlegungen nicht unterstützt, wird für das Gespräch eine Punt-to-Phone-Antwort ausgeführt.

PurchaseItemExtension

Artikelinhalte der Kaufbranche.

JSON-Darstellung
{
  "status": enum (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

Produkt- oder Angebots-ID, die dieser Werbebuchung zugeordnet ist.

quantity

integer

Menge des Artikels

unitMeasure

object (MerchantUnitMeasure)

Maßeinheit. Gibt die Größe des Artikels in ausgewählten Einheiten an. Die Größe ergibt zusammen mit dem aktiven Preis den Preis pro Einheit.

returnsInfo

object (PurchaseReturnsInfo)

Gibt Informationen zu dieser Werbebuchung zurück. Wenn kein Wert festgelegt ist, übernimmt diese Werbebuchung Rückgabeinformationen auf Auftragsebene.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informationen zur Auftragsausführung für diese Werbebuchung. Wenn kein Wert festgelegt ist, übernimmt diese Werbebuchung Informationen zur Auftragsausführung auf Auftragsebene.

itemOptions[]

object (ItemOption)

Zusätzliche Add-ons oder Unterobjekte.

productDetails

object (ProductDetails)

Details zum Produkt.

extension
(deprecated)

object

Alle zusätzlichen Felder, die zwischen Händler und Google ausgetauscht werden Hinweis: Von der Verwendung dieser Erweiterung wird dringend abgeraten. Überlegen Sie sich je nach Anwendungsfall/den jeweiligen Umständen eine der folgenden Optionen: 1. Definieren Sie Felder in PurchaseItemExtension, wenn sie für andere Anwendungsfälle verwendet werden könnten (z. B. allgemeine Funktionen/Funktionalität). 2. Verwenden Sie „Vertical_extension“, wenn es sich speziell auf einen benutzerdefinierten, nicht generischen Anwendungsfall oder eine allgemeine Funktion bezieht.

Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld "@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" kann in einem anderen Kontext unterschiedliche Bedeutungen haben. Bei der FOOD-Bestellung könnte es sein, dass das Essen vorbereitet wird. Im Einzelhandel könnte es sein, dass ein Artikel verpackt wird.
CREATED Der Auftrag wird erstellt.
CONFIRMED Der Händler hat die Bestellung bestätigt.
REJECTED Der Händler hat den Auftrag oder die Werbebuchung abgelehnt.
RETURNED Der Artikel wurde vom Nutzer zurückgegeben.
CANCELLED Der Auftrag oder die Werbebuchung wurde vom Nutzer storniert.
CHANGE_REQUESTED Der Nutzer hat eine Änderung an der Bestellung angefordert und der Integrator verarbeitet diese Änderung. Die Bestellung sollte nach der Verarbeitung der Anfrage in einen anderen Status verschoben werden.

PurchaseType

Die Kaufkategorie.

Enums
PURCHASE_TYPE_UNSPECIFIED Unbekannter Wert.
RETAIL Dazu gehören Käufe wie physische Waren.
FOOD Dazu gehören auch Essensbestellungen.
GROCERY Einkauf von Lebensmitteln.
MOBILE_RECHARGE Kauf eines Prepaidguthabens.

MerchantUnitMeasure

Mengeneinheit des Preises pro Einheit des Händlers.

JSON-Darstellung
{
  "measure": number,
  "unit": enum (Unit)
}
Felder
measure

number

Wert: Beispiel 1.2.

unit

enum (Unit)

Einheit: Beispiel POUND, GRAM.

Einheit

Enums
UNIT_UNSPECIFIED Einheit nicht angegeben.
MILLIGRAM ein Milligramm.
GRAM Gramm.
KILOGRAM Kilogramm.
OUNCE Unze.
POUND Pfund.

PurchaseReturnsInfo

Gibt Informationen zurück, die mit einem Auftrag oder einer bestimmten Werbebuchung verknüpft sind.

JSON-Darstellung
{
  "isReturnable": boolean,
  "daysToReturn": integer,
  "policyUrl": string
}
Felder
isReturnable

boolean

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

daysToReturn

integer

Die Rückgabe ist innerhalb dieser Tage möglich.

policyUrl

string

Link zu den Rückgabebedingungen.

PurchaseFulfillmentInfo

Informationen zur Auftragsausführung, die mit einem Auftrag oder einer bestimmten Position verknüpft sind.

JSON-Darstellung
{
  "id": string,
  "fulfillmentType": enum (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 Serviceoption.

fulfillmentType

enum (Type)

Erforderlich: Der Auftragsausführungstyp.

expectedFulfillmentTime

object (Time)

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

expectedPreparationTime

object (Time)

Ein Fenster, wenn ein Zeitraum angegeben ist, oder eine ETA, wenn eine einzelne Zeit angegeben ist. Voraussichtliche Zeit für die Zubereitung des Essens. Einmalig bevorzugt.

location

object (Location)

Abhol- oder Lieferort.

expireTime

string (Timestamp format)

Zeit, zu der diese Auftragsausführungsoption abläuft.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 Versandmethode, die der Nutzer ausgewählt hat.

storeCode

string

StoreCode des Standorts. Beispiel: Walmart ist der Händler und storeCode ist der Walmart-Shop, in dem die Auftragsausführung stattfindet. https://support.google.com/business/answer/3370250?ref_topic=4596653

pickupInfo

object (PickupInfo)

Zusätzliche Informationen zur Auswahl der Bestellung. Dieses Feld ist nur anwendbar, wenn der Auftragsausführungstyp PICKUP ist.

Typ

Ausführungstyp.

Enums
TYPE_UNSPECIFIED Der Typ ist nicht angegeben.
DELIVERY Diese Bestellung wird geliefert.
PICKUP Diese Bestellung muss abgeholt werden.

Zeit

Zeitkonstrukt zur Darstellung der Zeit eines Ereignisses, das beim Anzeigen einer Bestellung für den Nutzer verwendet werden soll.

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

string

Stellt eine Bestellereigniszeit wie die Reservierungszeit, die Lieferzeit usw. dar. Dabei kann es sich um eine Dauer (Start- und Endzeit), nur das Datum, die Uhrzeit usw. handeln. Alle unterstützten Formate finden Sie unter https://en.wikipedia.org/wiki/ISO_8601.

PickupInfo

Details zur Abholung einer Bestellung Sie enthält Details wie den Abholtyp und gegebenenfalls zusätzliche Metadaten für jeden Typ.

JSON-Darstellung
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
Felder
pickupType

enum (PickupType)

Abholoption, z. B. INSTORE, CURBSIDE usw.

curbsideInfo

object (CurbsideInfo)

Spezifische Details zu den Informationen zum Straßenrand. Wenn pickupType nicht „CURBSIDE“ ist, wird dieses Feld ignoriert.

checkInInfo[]

object (CheckInInfo)

Liste der verschiedenen Methoden, die vom Partner für den Check-in unterstützt werden.

PickupType

Liste der unterstützten Abholtypen.

Enums
UNSPECIFIED Abholtyp nicht angegeben.
INSTORE Essen im Restaurant abholen.
CURBSIDE Parken Sie das Fahrzeug an einer ausgewiesenen Stelle vor dem Restaurant, damit dort Essen geliefert wird.

CurbsideInfo

Details dazu, wie die Bestellung vor dem Laden abgewickelt wird

JSON-Darstellung
{
  "curbsideFulfillmentType": enum (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 vom ausgewählten Auftragsausführungstyp werden entsprechende Daten vom Nutzer erhoben.

userVehicle

object (Vehicle)

Fahrzeugdetails des Nutzers, der die Bestellung aufgibt.

CurbsideFulfillmentType

Mögliche Werte der Auftragsausführungstypen vor dem Laden.

Enums
UNSPECIFIED Art der Auftragsausführung vor dem Laden nicht angegeben.
VEHICLE_DETAIL Für die Abholung vor dem Laden sind Fahrzeugdetails erforderlich.

Fahrzeug

Details zu einem Fahrzeug

JSON-Darstellung
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
Felder
make

string

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

model

string

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

licensePlate

string

Kfz-Kennzeichen (z. B. 1ABC234) Erforderlich.

colorName

string

Farbname des Fahrzeugs, z. B. Schwarz (optional).

image

object (Image)

URL zu einem Foto des Fahrzeugs. Das Foto wird mit einer Größe von etwa 256 x 256 Pixel angezeigt. Muss im JPG- oder PNG-Format vorliegen. Optional.

CheckInInfo

Metadaten, die vom Partner benötigt werden, um eine Check-in-Methode zu unterstützen.

JSON-Darstellung
{
  "checkInType": enum (CheckInType)
}
Felder
checkInType

enum (CheckInType)

Methode zum Senden von Check-in-Anweisungen.

CheckInType

Verschiedene Methoden zum Senden von Check-in-Anweisungen.

Enums
CHECK_IN_TYPE_UNSPECIFIED Unbekannter Wert.
EMAIL Check-In-Informationen werden per E-Mail gesendet.
SMS Check-In-Informationen werden per SMS gesendet.

ItemOption

Add-ons oder Unterobjekte.

JSON-Darstellung
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
Felder
id

string

Für Optionen, die Artikel sind, die eindeutige Artikel-ID

name

string

Optionsname.

prices[]

object (PriceAttribute)

Gesamtpreis der Option.

note

string

Hinweis zu der Option.

quantity

integer

Für Optionen, nämlich Artikel, Menge

productId

string

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

Produkt- oder Angebots-ID, die dieser Werbebuchung zugeordnet ist.

gtin

string

Global Trade Item Number des Produkts. Dies ist hilfreich, wenn im Merchant Center keine Angebots-ID vorhanden ist. Optional.

plu

string

Preissuchcodes, allgemein als PLU-Codes, PLU-Nummern, PLUs, Produkcodes oder Etiketten bezeichnet, sind ein Zahlensystem, das in Lebensmittelgeschäften und Supermärkten verkaufte Großpackungen eindeutig identifiziert.

productType

string

Vom Händler definierte Produktkategorie. Beispiel: „Startseite > Lebensmittel > Milchprodukte & Eier > Milch > Vollmilch“

productAttributes

map (key: string, value: string)

Vom Händler bereitgestellte Details zum Produkt, z.B. { "allergen": "erdnuss" }. Nützlich, wenn im Merchant Center keine Angebots-ID vorhanden ist. Optional.

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

ReservationItemExtension

Werbebuchungsinhalte für Reservierungsaufträge 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 sein, wenn keine der Typoptionen anwendbar ist.

reservationTime

object (Time)

Uhrzeit, zu der die Dienstleistung bzw. das Ereignis geplant ist. Dabei kann es sich um einen Zeitraum, ein Datum oder ein genaues Datum und eine Uhrzeit handeln.

userAcceptableTimeRange

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)

Moderatoren, die für die Reservierung zuständig sind. Beispiel: Der Friseur.

location

object (Location)

Ort der Dienstleistung/Veranstaltung

ReservationStatus

Status der Reservierung.

Enums
RESERVATION_STATUS_UNSPECIFIED Nicht angegebener Status.
PENDING Die Reservierung steht aus.
CONFIRMED Die Reservierung ist bestätigt.
CANCELLED Die Reservierung wird vom Nutzer storniert.
FULFILLED Die Reservierung wurde erfüllt.
CHANGE_REQUESTED Änderung der Reservierung wurde angefordert
REJECTED Die Reservierung ist entweder abgelaufen oder wurde vom Integrator abgelehnt.

ReservationType

Art der Reservierung.

Enums
RESERVATION_TYPE_UNSPECIFIED Nicht definierter Typ.
RESTAURANT Restaurantreservierung.
HAIRDRESSER Reservierung beim Friseur.

StaffFacilitator

Informationen zur Soldaten.

JSON-Darstellung
{
  "name": string,
  "image": {
    object (Image)
  }
}
Felder
name

string

Der Name der moderierenden Person. Beispiel: „Max Mustermann“

image

object (Image)

Bilder des Künstlers

PaymentData

Zahlungsdaten 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 Interaktion mit dem Nutzer hilfreich sind.

PaymentResult

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 sind entweder Google-Zahlungsdaten oder die Zahlungsmethode des Händlers angegeben. Für result ist nur einer der folgenden Werte zulässig:
googlePaymentData

string

Google hat Daten zur Zahlungsmethode bereitgestellt. Wenn Ihr Zahlungsabwickler hier als von Google unterstützter Zahlungsabwickler aufgeführt ist: https://developers.google.com/pay/api/ Rufen Sie den Zahlungsabwickler über den Link auf, um weitere Informationen zu erhalten. Weitere Informationen zur Nutzlast findest du in der folgenden Dokumentation: https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

Vom Händler/Aktion bereitgestellte Zahlungsmethode vom Nutzer ausgewählt.

PaymentInfo

Zahlungsinformationen zur aufgegebenen Bestellung Dieses Proto erfasst Informationen, die für die Interaktion mit Nutzenden nützlich sind.

JSON-Darstellung
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Felder
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

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

paymentMethodProvenance

enum (PaymentMethodProvenance)

Herkunft der Zahlungsmethode, die für die Transaktion verwendet wurde. Der Nutzer hat möglicherweise dieselbe Zahlungsmethode bei Google und beim Händler registriert.

PaymentMethodDisplayInfo

Zahlungsergebnis, das vom Integrator für den Abschluss einer Transaktion verwendet wird.

JSON-Darstellung
{
  "paymentType": enum (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 auf Geräten mit Sprachassistenten vorgelesen wird. Beispiele: „Visum mit den Endziffern eins zwei drei vier“ oder „Girokonto mit den Endziffern fünf sechs sieben acht“. Hinweis: Dies ist der sprachoptimierte String, der anstelle des paymentMethodDisplayName für Geräte mit Sprachassistenten verwendet wird. Wenn dieser String nicht festgelegt ist, wird „paymentMethodDisplayName“ dem Nutzer ausgesprochen.

PaymentType

PaymentType gibt das Zahlungsmittel an, das für die vom Händler bereitgestellte Zahlungsmethode verwendet wird. Die Aktion muss auch einen Anzeigenamen für die Zahlungsmethode enthalten.

Enums
PAYMENT_TYPE_UNSPECIFIED Zahlungsart nicht angegeben.
PAYMENT_CARD Eine Kredit-/Debit- oder Prepaidkarte
BANK Die Zahlungsmethode ist ein Bankkonto.
LOYALTY_PROGRAM Die Zahlungsmethode ist ein Treuepunkteprogramm.
CASH Als Zahlungsmethode gilt Bargeld.
GIFT_CARD Die Zahlungsmethode ist eine Geschenkkarte.
WALLET Drittanbieter-Wallet, z.B. PayPal

PaymentMethodProvenance

Gibt die Herkunft der Zahlungsmethode an, die für die Transaktion verwendet wurde.

Enums
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED Die Herkunft ist nicht angegeben.
PAYMENT_METHOD_PROVENANCE_GOOGLE Die Herkunft ist Google.
PAYMENT_METHOD_PROVENANCE_MERCHANT Herkunft ist Händler.

Werbung

Aktionen/Angebote, die dem Einkaufswagen hinzugefügt wurden.

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

string

Erforderlich: Gutscheincode, der auf dieses Angebot angewendet wird.

PurchaseOrderExtension

Bestellerweiterung für die Kaufbranche. Diese Eigenschaften gelten für alle Werbebuchungen im Auftrag, sofern sie in einer Werbebuchung nicht überschrieben werden.

JSON-Darstellung
{
  "status": enum (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 für die Bestellung.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informationen zur Auftragsausführung für die 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

Alle zusätzlichen Felder, die zwischen Händler und Google ausgetauscht werden Hinweis: Von der Verwendung dieser Erweiterung wird dringend abgeraten. Überlegen Sie sich je nach Anwendungsfall/den jeweiligen Umständen eine der folgenden Optionen: 1. Definieren Sie Felder in „PurchaseOrderExtension“, wenn sie für andere Anwendungsfälle verwendet werden könnten (z. B. allgemeine Funktionen/Funktionalität). 2. Verwenden Sie „Vertical_extension“, wenn es sich speziell auf einen benutzerdefinierten, nicht generischen Anwendungsfall oder eine allgemeine Funktion bezieht.

Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld "@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 wurden online gekauft.
INSTORE_PURCHASE Alle Käufe im Geschäft.

PurchaseError

Fehler, bei denen ein Auftrag abgelehnt werden kann.

JSON-Darstellung
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
Felder
type

enum (ErrorType)

Erforderlich: Gibt den genauen Grund an, warum eine Bestellung vom Händler abgelehnt wird.

description

string

Zusätzliche Fehlerbeschreibung.

entityId

string

Entitäts-ID, die dem Fehler entspricht. Beispiel: „LineItemId“ oder „ItemOptionId“.

updatedPrice

object (PriceAttribute)

Relevant bei dem Fehlertyp PRICE_CHANGED / INCORRECT_PRICE.

availableQuantity

integer

Jetzt verfügbar. Anwendbar bei AVAILABILITY_CHANGED

ErrorType

Mögliche Fehlertypen.

Enums
ERROR_TYPE_UNSPECIFIED Unbekannter Fehler
NOT_FOUND Entität nicht gefunden, könnte Artikel, FulfillmentOption oder Promotion sein. Entitäts-ID erforderlich.
INVALID Entitätsdaten ungültig. könnten Artikel, FulfillmentOption oder Promotion sein. Entitäts-ID erforderlich.
AVAILABILITY_CHANGED Artikel nicht verfügbar oder nicht genügend Artikel, um die Anfrage zu erfüllen. Entitäts-ID erforderlich.
PRICE_CHANGED Der Artikelpreis unterscheidet sich vom Preis in der Elemententität. Die Entitäts-ID und der aktualisierte Preis sind erforderlich.
INCORRECT_PRICE Preisfehler in den Gebühren, insgesamt. Die Entitäts-ID und der aktualisierte Preis sind erforderlich.
REQUIREMENTS_NOT_MET Bedingungen für die Annahme der Bestellung nicht erfüllt – Mindestbestellmenge usw.
TOO_LATE Auftragsausführungsoption abgelaufen.
NO_CAPACITY Keine Dienstkapazität verfügbar. Verwenden Sie diesen Fehlercode, wenn keiner der detaillierteren Fehlertypen zutrifft.
NO_COURIER_AVAILABLE Es wurde kein Kurierdienst gefunden. Ein detaillierter Fehlertyp, der als NO_CAPACITY kategorisiert werden kann.
INELIGIBLE Nutzer kann keine Bestellung aufgeben (auf schwarzer Liste).
OUT_OF_SERVICE_AREA Lieferung an die gewünschte Adresse aufgrund von Grenzregelungen usw. nicht möglich.
CLOSED Das Restaurant ist während der Bestellung geschlossen.
PROMO_NOT_APPLICABLE Generischer Fehlercode, um alle Fälle zu erfassen, in denen der Gutscheincode nicht eingelöst wird, falls keiner der folgenden Punkte zutrifft. Fügen Sie den Gutscheincode als Entitäts-ID hinzu.
PROMO_NOT_RECOGNIZED Der Gutscheincode wurde vom Partner nicht erkannt. Fügen Sie den Gutscheincode als Entitäts-ID hinzu.
PROMO_EXPIRED Das Angebot konnte nicht angewendet werden, weil es abgelaufen ist. Fügen Sie den Gutscheincode als Entitäts-ID hinzu.
PROMO_USER_INELIGIBLE Der aktuelle Nutzer kann diesen Gutschein nicht einlösen. Fügen Sie den Gutscheincode als Entitäts-ID hinzu.
PROMO_ORDER_INELIGIBLE Dieser Gutschein kann nicht für die aktuelle Bestellung eingelöst werden. Fügen Sie den Gutscheincode als Entitäts-ID hinzu.
UNAVAILABLE_SLOT Der Slot für die Vorbestellungen ist nicht verfügbar.
FAILED_PRECONDITION Bedingungen für die Annahme der Bestellung nicht erfüllt - Mindestbestellmenge für Warenkorb usw.
PAYMENT_DECLINED Ungültige Zahlung.
MERCHANT_UNREACHABLE Der Händler ist nicht erreichbar. Das ist hilfreich, wenn ein Partner ein Aggregator ist und den Händler nicht erreichen konnte.
ACCOUNT_LINKING_FAILED Der Händler hat versucht, das Google-Konto des Nutzers mit einem Konto in seinem System zu verknüpfen. Dabei ist jedoch ein Fehler aufgetreten.

TicketOrderExtension

Bestelle Inhalte für Ticketbestellungen wie Kino, Sport usw.

JSON-Darstellung
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Felder
ticketEvent

object (TicketEvent)

Das Ereignis, das auf alle Werbebuchungstickets angewendet wurde.

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: Art des Ticketereignisses, z. B. Film, Konzert

name

string

Erforderlich: Name des Ereignisses Wenn das Ereignis beispielsweise ein Film ist, sollte dies der Filmname sein.

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 im Zusammenhang mit diesem Ereignis. Das können Regisseure oder Schauspieler eines Filmereignisses oder Darsteller eines Konzerts sein.

startDate

object (Time)

Start.

endDate

object (Time)

Ende.

doorTime

object (Time)

Eintrittszeitpunkt, der sich von der Startzeit der Veranstaltung unterscheiden kann, z. B. um 9:00 Uhr, aber um 8:30 Uhr.

Typ

Der Typ des Ereignisses.

Enums
EVENT_TYPE_UNKNOWN Unbekannter Ereignistyp.
MOVIE Film.
CONCERT Konzert.
SPORTS Sport

EventCharacter

Ein Termincharakter, z.B. Organisator, Künstler usw.

JSON-Darstellung
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Felder
type

enum (Type)

Typ des Ereignischarakters, z. B. Schauspieler oder Regisseur

name

string

Name der Figur.

image

object (Image)

Bilder der Charaktere

Typ

Zeichentyp.

Enums
TYPE_UNKNOWN Unbekannter Typ.
ACTOR Schauspieler.
PERFORMER Künstler
DIRECTOR Einen Regisseur
ORGANIZER Organisator.

UserNotification

Optionale Nutzerbenachrichtigung, die im Rahmen der Bestellaktualisierung angezeigt wird.

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

string

Der Titel für die 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 Parametern zusammengeführt, die bereits in der Sitzung definiert wurden. Parameter mit einem Nullwert werden aus der Sitzung entfernt. Weitere Informationen finden Sie in der Dokumentation zum Sitzungsspeicher: https://developers.google.com/assistant/conversational/storage-session.

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

typeOverrides[]

object (TypeOverride)

Optional. Auf die Sitzung beschränkte Typen. Die Definition des Sitzungstyps kann 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. Dies kann vom Gebietsschema des Nutzers abweichen, wenn bei der Aktion mehrsprachige Funktionen verwendet werden. Wenn beispielsweise „Handler_response.expected.language_code“ festgelegt ist, wird die Sprache der Unterhaltung für alle folgenden Abzweigungen geändert, was in diesem Feld angezeigt wird.

TypeOverride

Stellt eine Überschreibung für einen Typ dar.

JSON-Darstellung
{
  "name": string,
  "mode": enum (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
Felder
name

string

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

mode

enum (TypeOverrideMode)

Erforderlich. Gibt an, 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 Typdefinitionen zusammengeführt, die zuvor definiert wurden. 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

Stellt einen Eintrag für einen Synonymtyp dar.

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 im Feld für wiederholte Synonyme enthalten sein, damit er als gültiger Typwert neu interpretiert werden kann.

synonyms[]

string

Erforderlich. Liste mit Synonymen für den Eintrag (z.B. „Fahrrad“, „Fahrrad“).

display

object (EntryDisplay)

Optional. Die Informationen zum Artikel 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 wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel darf innerhalb der Gruppe von Sammlungselementen nur einmal vorkommen.

description

string

Optional. Text der Karte

image

object (Image)

Optional. Das Bild, das angezeigt werden soll.

footer

string

Optional. Fußzeilentext für das durchsuchende Sammlungselement, angezeigt unter der Beschreibung. Einzelne Textzeile, durch Auslassungspunkte abgeschnitten.

openUrl

object (OpenUrl)

URL des Dokuments, das mit dem Karussellelement zum Durchsuchen verknüpft ist. Erforderlich zum Durchsuchen des Karussells.

Nutzer

Stellt den Nutzer dar, der eine Anfrage an die Aktion sendet.

JSON-Darstellung
{
  "locale": string,
  "params": {
    string: value,
    ...
  },
  "accountLinkingStatus": enum (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
Felder
locale

string

Primäre Spracheinstellung des Nutzers, der die Anfrage stellt. Entspricht dem IETF-BCP-47-Sprachcode http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Das Skript-Subtag ist jedoch nicht enthalten.

params

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)

Gibt an, ob das Nutzerkonto mit der App verknüpft ist.

verificationStatus

enum (UserVerificationStatus)

Gibt 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 Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

engagement

object (Engagement)

Die Interaktion des aktuellen Nutzers, einschließlich Abos für Intents.

packageEntitlements[]

object (PackageEntitlements)

Die Berechtigungen des Nutzers für das Android-Paket, das der aktuellen Aktion zugeordnet ist.

permissions[]

enum (Permission)

Enthält Berechtigungen, die der Nutzer für diese Aktion gewährt hat.

AccountLinkingStatus

Gibt an, ob der Endnutzer sein Konto mit dieser App verknüpft hat. Weitere Informationen finden Sie in der Dokumentation zur Kontoverknüpfung: https://developers.google.com/assistant/identity.

Enums
ACCOUNT_LINKING_STATUS_UNSPECIFIED Unbekannt.
NOT_LINKED Der Nutzer hat sein Konto nicht mit dieser App verknüpft.
LINKED Der Nutzer hat sein Konto mit dieser App verknüpft.

UserVerificationStatus

Gibt an, ob der Nutzer von Google überprüft wurde. Der Status VERIFIED (BESTÄTIGT) bedeutet, dass Sie Daten in mehreren Konversationen mithilfe des Felds "Parameter" oder über die Kontoverknüpfung speichern können.

Enums
USER_VERIFICATION_STATUS_UNSPECIFIED Unbekannt.
GUEST Gastnutzer.
VERIFIED Bestätigter Nutzer.

Engagement

Bietet zusätzliche schreibgeschützte Informationen darüber, für welche Mechanismen der aktuelle Nutzer sich registriert hat. Es kann beispielsweise nützlich sein, zu wissen, welche Intents der Nutzer bereits abonniert hat. So wird vermieden, dass der Nutzer denselben Intent noch einmal abonnieren muss. Das heißt, diese Informationen können nur dann verwendet werden, wenn der Nutzer den Intent unter bestimmten Bedingungen an eine Szene weiterleitet, um DailyUpdates oder PushNotifications einzurichten. Weitere Informationen finden Sie in der Dokumentation zum Nutzer-Engagement: https://developers.google.com/assistant/engagement.

JSON-Darstellung
{
  "pushNotificationIntents": [
    {
      object (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 ein tägliches Update aktiviert hat.

IntentSubscription

Beschreibt ein vorhandenes IntentSubscription.

JSON-Darstellung
{
  "intent": string,
  "contentTitle": string
}
Felder
intent

string

Name des Intents, der abonniert wurde.

contentTitle

string

Eine kurze Beschreibung des Abos. Sie wird als Label für die Benachrichtigung verwendet und wenn Assistant eine Berechtigung vom Nutzer anfordert.

PackageEntitlements

Eine Liste der Nutzerberechtigungen für einen Paketnamen. Weitere Informationen finden Sie in der Dokumentation zu digitalen Warentransaktionen: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.

JSON-Darstellung
{
  "packageName": string,
  "entitlements": [
    {
      object (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-SKU Paketname für kostenpflichtige App, Suffix „Finsky docid“ für In-App-Käufe und In-App-Abos. Stimmt mit „getSku()“ in der Play InApp Billing API überein. Weitere Informationen finden Sie in der Dokumentation zur In-App-Abrechnung in Google Play: https://developer.android.com/google/play/billing.

skuType

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 findest du in Tabelle 6 unter https://developer.android.com/google/play/billing/billing_reference.html.

inAppDataSignature

string

Stimmt mit IN_APP_DATA_SIGNATURE aus der getPurchases()-Methode in der Play InApp Billing API überein.

Berechtigung

Mögliche Werte für Berechtigung.

Enums
PERMISSION_UNSPECIFIED Unbekannte Berechtigung.
DEVICE_PRECISE_LOCATION Fragen Sie den Nutzer nach dem genauen Standort, dem Breiten- und Längengrad und der formatierten Adresse.
DEVICE_COARSE_LOCATION Fragen Sie nach dem ungefähren Standort, der Postleitzahl, der Stadt und dem Ländercode des Nutzers.
UPDATE Fragen Sie nach Berechtigungen zum Senden von Updates. Weitere Informationen finden Sie unter https://developers.google.com/assistant/engagement/daily.

Startseite

Stellt die HomeGraph-Struktur dar, zu der das Zielgerät des Nutzers gehört.

JSON-Darstellung
{
  "params": {
    string: value,
    ...
  }
}
Felder
params

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 zum Speicherplatz für zu Hause: 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 für eine Anfrage an die Aktion verwendet.

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 nur ausgefüllt, wenn der Endnutzer die Berechtigung zur Standortermittlung erteilt hat. In der Standortnachricht finden Sie weitere Informationen dazu, welche Felder je nach grober bzw. detaillierter Berechtigung festgelegt werden. Weitere Informationen finden Sie in der Dokumentation zu Berechtigungen: https://developers.google.com/assistant/conversational/permissions.

timeZone

object (TimeZone)

Optional. Zeitzone, die dem Clientgerät zugeordnet ist. Damit können Datum/Uhrzeit-Werte aufgelöst werden.

Funktion

Funktionen, die die Geräteoberfläche zum Zeitpunkt der Anfrage unterstützt.

Enums
UNSPECIFIED Nicht angegebene Gerätefunktion.
SPEECH Das Gerät kann über Sprachausgabe oder SSML mit dem Nutzer sprechen.
RICH_RESPONSE Auf dem Gerät können aussagekräftige Antworten wie Karten, Listen und Tabellen angezeigt werden.
LONG_FORM_AUDIO Auf dem Gerät können auch lange Audiomedien wie Musik und Podcasts abgespielt werden.
INTERACTIVE_CANVAS Das Gerät kann eine interaktive Canvas-Antwort anzeigen.
HOME_STORAGE Das Gerät unterstützt das Speichern und Abrufen von Speicherplatz für dein Zuhause.

Standort

Container, der einen Standort darstellt.

JSON-Darstellung
{
  "coordinates": {
    object (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
Felder
coordinates

object (LatLng)

Geokoordinaten: Die Berechtigung [DEVICE_PRECISE_LOCATION] ist erforderlich.

postalAddress

object (PostalAddress)

Postanschrift. Erfordert die Berechtigung [DEVICE_PRECISE_LOCATION] oder [DEVICE_COARSE_LOCATION]. Wenn die Berechtigung zur groben Standortbestimmung gewährt wurde, werden nur die Felder „postalCode“ und „Ort“ ausgefüllt. Durch die Berechtigung für den genauen Standort werden zusätzliche Felder wie „administrativeArea“ und „addressLines“ ausgefüllt.

TimeZone

Stellt eine Zeitzone aus der IANA-Zeitzonendatenbank dar.

JSON-Darstellung
{
  "id": string,
  "version": string
}
Felder
id

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, zum 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 wird von der Drittanbieter-App „Interactive Canvas“ festgelegt. Dieser Status wird nur für Anfragen festgelegt, nicht für Antworten. Wenn dies beispielsweise eine Rezeptanwendung ist, kann der Zustand ein Wert von struct sein : { "current_page" : 5, "last_page" : 3, } Die Größenbeschränkung beträgt 50 KB.

Erwartet

Beschreibt die Erwartungen an den nächsten Dialog.

JSON-Darstellung
{
  "speech": [
    string
  ]
}
Felder
speech[]

string

Liste der Wortgruppen, die die Aktion von der Äußerung des Nutzers für die Sprachgewichtung erwartet. Es sind bis zu 1.000 Wortgruppen erlaubt. Hinweis: Dieses Feld hat die gleiche Bedeutung wie „ErwarteteInput.speech_biasing_hints“ in der API v2.