Files

Wrapper für eine Liste von Dateien.

JSON-Darstellung
{

  // Union field file_type can be only one of the following:
  "configFiles": {
    object (ConfigFiles)
  },
  "dataFiles": {
    object (DataFiles)
  }
  // End of list of possible types for union field file_type.
}
Felder
Union-Feld file_type. Es kann jeweils nur ein Dateityp, Konfigurationsdateien oder Datendateien an den Server gesendet werden. Für file_type ist nur einer der folgenden Werte zulässig:
configFiles

object (ConfigFiles)

Liste der Konfigurationsdateien. Dazu gehören Manifest, Einstellungen, Ressourcen-Bundles für Interaktionsmodelle und mehr.

dataFiles

object (DataFiles)

Liste der Datendateien. Dazu gehören Bilder, Audiodateien und Cloud Functions-Quellcodes.

ConfigFiles

Wrapper für wiederholte Konfigurationsdateien. Wiederkehrende Felder können in einem oneof nicht vorhanden sein.

JSON-Darstellung
{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}
Felder
configFiles[]

object (ConfigFile)

Mehrere Konfigurationsdateien

ConfigFile

Stellt eine einzelne Datei dar, die strukturierte Daten enthält. Entwickler können den Großteil ihrer Projekte mithilfe einer strukturierten Konfiguration definieren, einschließlich Aktionen, Einstellungen und Auftragsausführung.

JSON-Darstellung
{
  "filePath": string,

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}
Felder
filePath

string

Der relative Pfad der Konfigurationsdatei vom Projektstamm in der SDK-Dateistruktur. Jeder der folgenden Dateitypen hat einen zulässigen Dateipfad. Beispiel: settings/settings.yaml

Union-Feld file. Jeder Typ der Konfigurationsdatei sollte ein entsprechendes Feld im oneof haben. Für file ist nur einer der folgenden Werte zulässig:
manifest

object (Manifest)

Einzelne Manifestdatei. Zulässiger Dateipfad: manifest.yaml

actions

object (Actions)

Einzelne Aktionsdatei mit allen definierten Aktionen. Zulässige Dateipfade: actions/{language}?/actions.yaml

settings

object (Settings)

Einzelne Einstellungskonfiguration, die nicht lokalisierbare Einstellungen und Einstellungen für die Standardsprache des Projekts (falls angegeben) enthält. Bei einer Datei zum Überschreiben des Gebietsschemas wird nur das Feld "localizedSettings" ausgefüllt. Zulässige Dateipfade: settings/{language}?/settings.yaml Die nicht lokalisierte Einstellungsdatei settings/settings.yaml muss in Anfragen zum Schreibfluss vorhanden sein.

webhook

object (Webhook)

Definition eines einzelnen Webhooks. Zulässiger Dateipfad: webhooks/{WebhookName}.yaml

intent

object (Intent)

Definition eines einzelnen Intents. Zulässige Dateipfade: custom/intents/{language}?/{IntentName}.yaml

type

object (Type)

Definition eines einzelnen Typs. Zulässige Dateipfade: custom/types/{language}?/{TypeName}.yaml

entitySet

object (EntitySet)

Definition eines Einzelentitäts-Sets. Zulässige Dateipfade: custom/entitySets/{language}?/{EntitySetName}.yaml

globalIntentEvent

object (GlobalIntentEvent)

Einzelne globale Intent-Ereignisdefinition. Zulässige Dateipfade: custom/global/{GlobalIntentEventName}.yaml Der Dateiname (GlobalIntentEventName) muss der Name des Intents sein, dem dieses globale Intent-Ereignis entspricht.

scene

object (Scene)

Definition einer einzelnen Szene. Zulässige Dateipfade: custom/scenes/{SceneName}.yaml

staticPrompt

object (StaticPrompt)

Definition einer einzelnen statischen Aufforderung. Zulässige Dateipfade: custom/prompts/{language}?/{StaticPromptName}.yaml

accountLinkingSecret

object (AccountLinkingSecret)

Metadaten, die dem Clientschlüssel entsprechen, der bei der Kontoverknüpfung verwendet wurde. Zulässiger Dateipfad: settings/accountLinkingSecret.yaml

resourceBundle

object (Struct format)

Einzelnes Ressourcen-Bundle, bei dem es sich um eine Zuordnung von einem String zu einem String oder einer Liste von Strings handelt. Ressourcen-Bundles können zum Lokalisieren von Strings in statischen Prompts verwendet werden. Zulässige Dateipfade: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

Manifest

Enthält Informationen, die als „transportbar“ gekennzeichnet sind d.h., sie sind nicht projektspezifisch und können zwischen Projekten verschoben werden.

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

string

Version des Dateiformats. Die aktuelle Dateiformatversion ist 1.0. Beispiel: „1.0“

Aktionen

Die Liste der in einem Projekt definierten Aktionen.

JSON-Darstellung
{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}
Felder
custom

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

Ordnen Sie Intents benutzerdefinierten Aktionen zu, um den Aufruf für das Projekt zu konfigurieren. Die Aufruf-Intents können entweder System- oder benutzerdefinierte Intents sein, die in „custom/intents/“ definiert sind. Paket. Für alle hier definierten Intents (System-Intents und benutzerdefinierte Intents) muss im Ordner „custom/global/“ eine entsprechende Intent-Datei vorhanden sein. Paket.

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

CustomAction

Details zu einer benutzerdefinierten Aktion.

JSON-Darstellung
{
  "engagement": {
    object (Engagement)
  }
}
Felder
engagement

object (Engagement)

Engagement-Mechanismen, die mit der Aktion verknüpft sind, um Endnutzern zu helfen, Push-Benachrichtigungen und tägliche Updates zu abonnieren. Der Intent-Name, der in der Konfiguration für tägliche Updates/Push-Benachrichtigungsslots angegeben ist, muss dem Intent entsprechen, der dieser Aktion entspricht, damit Endnutzer diese Updates abonnieren können.

Engagement

Definiert die Interaktionsmechanismen, die dieser Aktion zugeordnet sind. So können Endnutzer Push-Benachrichtigungen und tägliche Updates abonnieren.

JSON-Darstellung
{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}
Felder
title

string

Der Titel der Interaktion, der an Endnutzer gesendet wird, um sie um ihre Zustimmung zum Erhalt von Aktualisierungen zu bitten. Die Aufforderung für tägliche Updates an die Endnutzer lautet wie folgt: „Um wie viel Uhr soll ich Ihnen täglich {title}“ senden? und für Push-Benachrichtigungen lautet die Frage "Is it ok if I send push notifications for {title}". Dieses Feld kann lokalisiert werden.

pushNotification

object (PushNotification)

Einstellungen für Push-Benachrichtigungen, die für diese Interaktion unterstützt werden.

dailyUpdate

object (DailyUpdate)

Einstellungen für tägliche Updates, die durch dieses Engagement unterstützt werden.

PushNotification

Definiert Push-Benachrichtigungseinstellungen, die für dieses Engagement unterstützt werden.

DailyUpdate

Legt Einstellungen für tägliche Updates fest, die bei diesem Engagement unterstützt werden.

Einstellungen

Stellt Einstellungen eines Actions-Projekts dar, die nicht sprachspezifisch sind. Nächstes Tag: 22

JSON-Darstellung
{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}
Felder
projectId

string

Actions-Projekt-ID.

defaultLocale

string

Sprache, die der Standardwert für das Projekt ist. Bei allen Dateien außer unter resources/ ohne Sprache im Pfad werden die lokalisierten Daten dieser defaultLocale zugeordnet. Bei Dateien unter resources/ bedeutet keine Sprache, dass die Ressource für alle Sprachen anwendbar ist.

enabledRegions[]

string

Stellt die Regionen dar, in denen Nutzer deine Aktionen aufrufen können (basierend auf dem Standort des Nutzers). Kann nicht festgelegt werden, wenn disabledRegions festgelegt ist. Wenn sowohl enabledRegions als auch disabledRegions nicht angegeben sind, können Nutzer deine Aktionen in allen Regionen aufrufen. Jede Region wird mithilfe des kanonischen Namens der AdWords-Zielregionen dargestellt. Siehe https://developers.google.com/adwords/api/docs/appendix/geotargeting. Beispiele: – "Deutschland" - "Ghana" - "Griechenland" - "Grenada" - "Vereinigtes Königreich" - "USA" - "Kleinere Amerikanische Überseeinseln" – „Uruguay“

disabledRegions[]

string

Stellt die Regionen dar, in denen deine Aktionen basierend auf dem aktuellen Standort des Nutzers blockiert sind. Kann nicht festgelegt werden, wenn enabledRegions festgelegt ist. Jede Region wird mithilfe des kanonischen Namens der AdWords-Zielregionen dargestellt. Siehe https://developers.google.com/adwords/api/docs/appendix/geotargeting. Beispiele: – "Deutschland" - "Ghana" - "Griechenland" - "Grenada" - "Vereinigtes Königreich" - "USA" - "Kleinere Amerikanische Überseeinseln" – „Uruguay“

category

enum (Category)

Die Kategorie für dieses Actions-Projekt.

usesTransactionsApi

boolean

Gibt an, ob Aktionen Transaktionen verwenden können (z. B. Reservierungen vornehmen, Bestellungen annehmen usw.) Bei „false“ schlägt der Versuch, die Transaktions-APIs zu verwenden, fehl.

usesDigitalPurchaseApi

boolean

Gibt an, ob Aktionen Transaktionen für digitale Waren durchführen können.

usesInteractiveCanvas

boolean

Gibt an, ob Aktionen den interaktiven Canvas verwenden.

usesHomeStorage

boolean

Gibt an, ob Aktionen die Speicherfunktion des Zuhauses verwenden.

designedForFamily

boolean

Gibt an, ob Actions-Inhalte für Familien gedacht sind.

containsAlcoholOrTobaccoContent

boolean

Ob Aktionen alkohol- oder tabakbezogene Inhalte enthalten

keepsMicOpen

boolean

Legt fest, ob das Mikrofon in Actions ohne explizite Aufforderung während einer Unterhaltung eingeschaltet bleibt.

surfaceRequirements

object (SurfaceRequirements)

Die Oberflächenanforderungen, die eine Client-Oberfläche unterstützen muss, um Aktionen in diesem Projekt aufzurufen.

testingInstructions

string

Anleitung zum Testen im freien Format für Actions-Prüfer, z. B. Anleitungen zur Kontoverknüpfung

localizedSettings

object (LocalizedSettings)

Lokalisierte Einstellungen für die Standardsprache des Projekts. Für jedes zusätzliche Gebietsschema sollte eine eigene Einstellungsdatei in einem eigenen Verzeichnis vorhanden sein.

accountLinking

object (AccountLinking)

Nutzern erlauben, über Google Log-in und/oder Ihren eigenen OAuth-Dienst Konten zu erstellen oder zu verknüpfen.

selectedAndroidApps[]

string

Android-Apps, die für den Zugriff auf Google Play-Käufe für Transaktionen ausgewählt wurden Dies ist eine Auswahl aus den Android-Apps, die mit dem Actions-Projekt verknüpft sind, um die Markeninhaberschaft zu bestätigen und zusätzliche Funktionen zu aktivieren. Weitere Informationen finden Sie unter https://developers.google.com/assistant/console/brand-verification.

Kategorie

Die Kategorieauswahl für ein Actions-Projekt.

Enums
CATEGORY_UNSPECIFIED Unbekannt / Keine Angabe.
BUSINESS_AND_FINANCE Wirtschaft und Finanzen.
EDUCATION_AND_REFERENCE Kategorie „Bildung und Nachschlagewerke“.
FOOD_AND_DRINK Essen und Trinken.
GAMES_AND_TRIVIA Spiele und Quiz.
HEALTH_AND_FITNESS Gesundheit und Fitness.
KIDS_AND_FAMILY Kinder und Familie.
LIFESTYLE Kategorie „Lifestyle“.
LOCAL Lokale Kategorie.
MOVIES_AND_TV Filme und Serien.
MUSIC_AND_AUDIO Musik und Audio.
NEWS Nachrichtenkategorie,
NOVELTY_AND_HUMOR Kategorie Neuheiten und Humor.
PRODUCTIVITY Produktivitätskategorie.
SHOPPING Shopping-Kategorie
SOCIAL Kategorie "Soziale Netzwerke"
SPORTS Sportkategorie.
TRAVEL_AND_TRANSPORTATION Kategorie "Reisen und Transport".
UTILITIES Dienstprogramme.
WEATHER Wetterkategorie.
HOME_CONTROL Smart-Home-Steuerung.

SurfaceRequirements

Enthält eine Reihe von Anforderungen, die die Client-Oberfläche erfüllen muss, um Aktionen in Ihrem Projekt aufzurufen.

JSON-Darstellung
{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}
Felder
minimumRequirements[]

object (CapabilityRequirement)

Die Mindestfunktionen, die zum Aufrufen der Aktionen in Ihrem Projekt erforderlich sind. Fehlt auf der Oberfläche eine dieser Angaben, wird die Aktion nicht ausgelöst.

CapabilityRequirement

Stellt eine Anforderung an die Verfügbarkeit einer bestimmten Funktion dar.

JSON-Darstellung
{
  "capability": enum (SurfaceCapability)
}
Felder
capability

enum (SurfaceCapability)

Der Typ der Funktion.

SurfaceCapability

Mögliche Oberflächenfunktionen.

Enums
SURFACE_CAPABILITY_UNSPECIFIED Unbekannt / Keine Angabe.
AUDIO_OUTPUT Surface unterstützt die Audioausgabe.
SCREEN_OUTPUT Surface unterstützt die Bildschirm- und visuelle Ausgabe.
MEDIA_RESPONSE_AUDIO Oberfläche unterstützt Audio für Medienantworten.
WEB_BROWSER Surface unterstützt Webbrowser.
ACCOUNT_LINKING Surface unterstützt die Kontoverknüpfung.
INTERACTIVE_CANVAS Surface unterstützt Interactive Canvas.
HOME_STORAGE Surface bietet Speicherplatz für dein Zuhause.

LocalizedSettings

Stellt Einstellungen eines Actions-Projekts dar, die für die jeweilige Sprache des Nutzers spezifisch sind. In diesem Fall bezeichnet Nutzer den Endbenutzer, der deine Aktionen aufruft. Diese Nachricht kann lokalisiert werden.

JSON-Darstellung
{
  "displayName": string,
  "pronunciation": string,
  "shortDescription": string,
  "fullDescription": string,
  "smallLogoImage": string,
  "largeBannerImage": string,
  "developerName": string,
  "developerEmail": string,
  "termsOfServiceUrl": string,
  "voice": string,
  "voiceLocale": string,
  "privacyPolicyUrl": string,
  "sampleInvocations": [
    string
  ],
  "themeCustomization": {
    object (ThemeCustomization)
  }
}
Felder
displayName

string

Erforderlich. Der standardmäßige Anzeigename für dieses Actions-Projekt (falls keine Übersetzung verfügbar ist)

pronunciation

string

Erforderlich. Die Aussprache des Anzeigenamens, der in einem Sprachkontext (gesprochen) aufgerufen wird.

shortDescription

string

Erforderlich. Die standardmäßige Kurzbeschreibung für das Actions-Projekt (falls keine Übersetzung verfügbar ist). Maximal 80 Zeichen.

fullDescription

string

Erforderlich. Die standardmäßige lange Beschreibung für das Actions-Projekt (falls keine Übersetzung verfügbar ist). Maximal 4.000 Zeichen.

smallLogoImage

string

Erforderlich. Kleines quadratisches Bild, 192 x 192 Pixel Sollte als Verweis auf das entsprechende Bild im Verzeichnis resources/images/ angegeben werden. Beispiel: $resources.images.foo (ohne die Erweiterung) für ein Image in resources/images/foo.jpg. Wenn Sie an einem Projekt arbeiten, das aus der Console abgerufen wird, kann die von Google verwaltete URL verwendet werden. URLs aus externen Quellen sind nicht zulässig.

largeBannerImage

string

Optional. Großes Bild im Querformat, 1.920 x 1.080 Pixel Sollte als Verweis auf das entsprechende Bild im Verzeichnis resources/images/ angegeben werden. Beispiel: $resources.images.foo (ohne die Erweiterung) für ein Image in resources/images/foo.jpg. Wenn Sie an einem Projekt arbeiten, das aus der Console abgerufen wird, kann die von Google verwaltete URL verwendet werden. URLs aus externen Quellen sind nicht zulässig.

developerName

string

Erforderlich. Der Name des Entwicklers, der den Nutzern angezeigt wird.

developerEmail

string

Erforderlich. Die Kontakt-E-Mail-Adresse des Entwicklers.

termsOfServiceUrl

string

Optional. Die URL der Nutzungsbedingungen.

voice

string

Erforderlich. Der Google Assistant-Sprachtyp, den Nutzer hören, wenn sie mit deinen Aktionen interagieren. Die unterstützten Werte sind „male_1“, „male_2“, „female_1“ und „female_2“.

voiceLocale

string

Optional. Die Sprache für die angegebene Stimme. Wenn keine Angabe erfolgt, wird die Assistant-Sprache des Nutzers verwendet. Wenn angegeben, muss die Sprache der Sprache mit der in „LocalizedSettings“ angegebenen Sprache übereinstimmen.

privacyPolicyUrl

string

Erforderlich. Die URL der Datenschutzerklärung.

sampleInvocations[]

string

Optional. Beispiele für Aufrufformulierungen, die als Teil der Beschreibung Ihres Actions-Projekts im Assistant-Verzeichnis angezeigt werden. So lernen die Nutzenden, wie sie verwendet werden.

themeCustomization

object (ThemeCustomization)

Optional. Designanpassungen für visuelle Komponenten deiner Aktionen.

ThemeCustomization

Stile, die auf Karten angewendet werden, die Nutzern angezeigt werden

JSON-Darstellung
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
Felder
backgroundColor

string

Hintergrundfarbe von Karten Fungiert als Fallback, wenn background_image nicht von Entwicklern bereitgestellt wird oder background_image für bestimmte Oberflächen nicht geeignet ist. Beispielverwendung: #FAFAFA

primaryColor

string

Die primäre Designfarbe der Aktion wird verwendet, um die Textfarbe für den Titel und die Hintergrundfarbe der Aufgaben für Actions on Google-Karten festzulegen. Beispielverwendung: #FAFAFA

fontFamily

string

Die Schriftfamilie, die für den Titel der Karten verwendet wird. Unterstützte Schriftarten: - Serifenschrift - Serifenlose Schriften - Serifenlose Schriften - Serifenlose Schriften - Serifen ohne Serifen Schwarz - Gesprochen

imageCornerStyle

enum (ImageCornerStyle)

Rahmenlinienstil des Vordergrundbilds von Karten. Sie kann beispielsweise auf das Vordergrundbild einer Standard- oder Karussellkarte angewendet werden.

landscapeBackgroundImage

string

Querformat (mindestens 1.920 x 1.200 Pixel) Sollte als Verweis auf das entsprechende Bild im Verzeichnis resources/images/ angegeben werden. Beispiel: $resources.images.foo (ohne die Erweiterung) für ein Image in resources/images/foo.jpg. Wenn Sie an einem Projekt arbeiten, das aus der Console abgerufen wird, kann die von Google verwaltete URL verwendet werden.

portraitBackgroundImage

string

Porträtmodus (mindestens 1.200 × 1.920 Pixel) Sollte als Verweis auf das entsprechende Bild im Verzeichnis resources/images/ angegeben werden. Beispiel: $resources.images.foo (ohne die Erweiterung) für ein Image in resources/images/foo.jpg. Wenn Sie an einem Projekt arbeiten, das aus der Console abgerufen wird, kann die von Google verwaltete URL verwendet werden.

ImageCornerStyle

Beschreibt, wie die Rahmen von Bildern gerendert werden sollen.

Enums
IMAGE_CORNER_STYLE_UNSPECIFIED Nicht definiert / Nicht angegeben.
CURVED Abgerundete Ecke für Bild.
ANGLED Rechteckige Ecke für Bild.

AccountLinking

Mithilfe der Kontoverknüpfung kann Google den Nutzer dazu führen, dass er sich in den Webdiensten der App anmeldet.

Für die Verknüpfungstypen „Google Log-in“, „OAuth + Google Log-in“ generiert Google eine Client-ID, mit der deine App für Google identifiziert wird („Client-ID, die von Google für deine Aktionen ausgegeben wird“ auf der Console-UI). Dieses Feld ist schreibgeschützt und kann auf der Kontoverknüpfungsseite der Console-Benutzeroberfläche überprüft werden. Weitere Informationen: https://developers.google.com/assistant/identity/google-sign-in

Hinweis: Für alle Einstellungstypen für die Kontoverknüpfung (außer Google Log-in) musst du unter Settings.testing_instructions einen Nutzernamen und ein Passwort für ein Testkonto angeben, damit das Prüfteam die App prüfen kann. Für Nutzer sind sie nicht sichtbar.

JSON-Darstellung
{
  "enableAccountCreation": boolean,
  "linkingType": enum (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}
Felder
enableAccountCreation

boolean

Erforderlich. Wenn true, können Nutzer sich per Sprachbefehl für neue Konten registrieren. Wenn false, ist die Kontoerstellung nur auf Ihrer Website zulässig. Wählen Sie diese Option aus, wenn Sie Ihre Nutzungsbedingungen anzeigen oder bei der Registrierung die Nutzereinwilligung einholen möchten. „linkingType“ darf nicht GOOGLE_SIGN_IN sein, wenn false verwendet wird. „linkingType“ darf nicht OAUTH sein, wenn true verwendet wird.

linkingType

enum (LinkingType)

Erforderlich. Der zu verwendende Verknüpfungstyp. Weitere Informationen zu den Verknüpfungstypen finden Sie unter https://developers.google.com/assistant/identity.

authGrantType

enum (AuthGrantType)

Optional. Gibt den Authentifizierungstyp für OAUTH LinkingType an.

appClientId

string

Optional. Client-ID, die von deiner App an Google ausgestellt wurde. Dies ist die OAuth2-Client-ID, mit der Google für Ihren Dienst identifiziert wird. Wird nur bei Verwendung von OAuth festgelegt.

authorizationUrl

string

Optional. Endpunkt für deine Anmeldewebseite, der OAuth2-Code oder implizite Abläufe unterstützt. Die URL muss HTTPS verwenden. Wird nur bei Verwendung von OAuth festgelegt.

tokenUrl

string

Optional. OAuth2-Endpunkt für Tokenaustausch. Die URL muss HTTPS verwenden. Dieser wird nicht festgelegt, wenn nur OAuth mit IMPLICIT-Berechtigung als Verknüpfungstyp verwendet wird. Wird nur bei Verwendung von OAuth festgelegt.

scopes[]

string

Optional. Liste der Berechtigungen, denen der Nutzer zustimmen muss, um Ihren Dienst nutzen zu können. Wird nur bei Verwendung von OAuth festgelegt. Wenn Sie dieses Feld angeben, müssen Sie in den Verzeichnisinformationen im Abschnitt „LocalizedSettings.terms_of_service_url“ Nutzungsbedingungen angeben.

learnMoreUrl

string

Optional. Dies ist die Webseite in Ihrem Dienst, auf der die Berechtigungen beschrieben werden, die der Nutzer Google gewährt. Wird nur bei Verwendung von OAuth und Google Log-in festgelegt. Wenn Sie dieses Feld angeben, müssen Sie in den Verzeichnisinformationen im Abschnitt „LocalizedSettings.terms_of_service_url“ Nutzungsbedingungen angeben.

useBasicAuthHeader

boolean

Optional. Falls wahr, erlauben Sie Google, die Client-ID und den Clientschlüssel über den Header für die HTTP-Basisauthentifizierung zu übertragen. Andernfalls verwendet Google die Client-ID und den Secret im Text des Posts. Wird nur bei Verwendung von OAuth festgelegt. Wenn Sie dieses Feld angeben, müssen Sie in den Verzeichnisinformationen im Abschnitt „LocalizedSettings.terms_of_service_url“ Nutzungsbedingungen angeben.

LinkingType

Die Art der auszuführenden Kontoverknüpfung.

Enums
LINKING_TYPE_UNSPECIFIED Nicht angegeben
GOOGLE_SIGN_IN Verknüpfungstyp „Google Log-in“. Wenn Sie diesen Verknüpfungstyp verwenden, müssen unten keine OAuth-bezogenen Felder festgelegt werden.
OAUTH_AND_GOOGLE_SIGN_IN OAuth und Google Log-in-Verknüpfungstyp.
OAUTH OAuth-Verknüpfungstyp.

AuthGrantType

Der OAuth2-Berechtigungstyp, den Google verwendet, um den Nutzer bei der Anmeldung im Webdienst Ihrer Anwendung zu unterstützen.

Enums
AUTH_GRANT_TYPE_UNSPECIFIED Nicht angegeben
AUTH_CODE Autorisierungscode gewährt. Erfordert die Angabe einer Authentifizierungs-URL und einer Zugriffstoken-URL.
IMPLICIT Implizite Codeerteilung. Erfordert nur die Angabe einer Authentifizierungs-URL.

Webhook

Metadaten für verschiedene Arten von Webhooks. Wenn Sie inlineCloudFunction verwenden, muss sich der Quellcode in einem Verzeichnis mit demselben Namen wie der Wert für den Schlüssel executeFunction befinden. Ein Wert von my_webhook für den Schlüssel executeFunction hätte beispielsweise folgende Codestruktur: – /webhooks/my_webhook.yaml/webhooks/my_webhook/index.js/webhooks/my_webhook/package.json

JSON-Darstellung
{
  "handlers": [
    {
      object (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}
Felder
handlers[]

object (Handler)

Liste der Handler für diesen Webhook.

Union-Feld webhook_type. Es wird nur ein Webhook-Typ unterstützt. Für webhook_type ist nur einer der folgenden Werte zulässig:
httpsEndpoint

object (HttpsEndpoint)

Benutzerdefinierter Webhook-HTTPS-Endpunkt.

inlineCloudFunction

object (InlineCloudFunction)

Metadaten für Cloud Functions-Funktionen, die aus Code im Ordner „Webhooks“ bereitgestellt werden.

Handler

Deklariert den Namen des Webhook-Handlers. Für einen Webhook können mehrere Handler registriert sein. Diese Handler können von mehreren Stellen in Ihrem Actions-Projekt aus aufgerufen werden.

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

string

Erforderlich. Name des Handlers. Muss für alle Handler im Actions-Projekt eindeutig sein. Sie können den Namen dieses Handlers überprüfen, um die richtige Funktion in Ihrem Quellcode für die Auftragsausführung aufzurufen.

HttpsEndpoint

REST-Endpunkt zur Benachrichtigung, wenn Sie den Inline-Editor nicht verwenden.

JSON-Darstellung
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
Felder
baseUrl

string

Die HTTPS-Basis-URL für Ihren Auftragsausführungsendpunkt (HTTP wird nicht unterstützt). Handler-Namen werden gemäß dem Styleguide unter https://cloud.google.com/apis/design/custom_methods) nach einem Doppelpunkt an den Basis-URL-Pfad angehängt. Beispiel: Die Basis-URL „https://gactions.service.com/api“ würde Anfragen mit der URL „https://gactions.service.com/api:{method}“ empfangen.

httpHeaders

map (key: string, value: string)

Zuordnung von HTTP-Parametern, die in die POST-Anfrage einbezogen werden sollen.

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

endpointApiVersion

integer

Version des vom Endpunkt verwendeten Protokolls. Dies ist das Protokoll, das von allen Auftragsausführungstypen gemeinsam verwendet wird und nicht spezifisch für den Google-Auftragsausführungstyp.

InlineCloudFunction

Enthält die Metadaten einer Inline-Cloud Functions-Funktion, die aus dem Webhook-Ordner bereitgestellt wird.

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

string

Der Name des Cloud Functions-Einstiegspunkts. Der Wert in diesem Feld sollte mit dem Namen der Methode übereinstimmen, die aus dem Quellcode exportiert wurde.

Absicht

Intents ordnen offene Nutzereingaben strukturierten Objekten zu. Gesprochene Wortgruppen werden mithilfe von Natural Language Understanding (NLU) Intents zugeordnet. Intent-Übereinstimmungen können Ereignisse in Ihrem Unterhaltungsdesign auslösen, um die Unterhaltung des Nutzers voranzutreiben. Der Intent-Name wird im Namen der Datei angegeben.

JSON-Darstellung
{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}
Felder
parameters[]

object (IntentParameter)

Die Liste der Parameter in den Trainingsformulierungen. Hier müssen alle Parameter definiert werden, damit sie in der Trainingsformulierung verwendet werden können.

trainingPhrases[]

string

Trainingsformulierungen ermöglichen es der NLU von Google, Intents automatisch mit Nutzereingaben abzugleichen. Je mehr eindeutige Wortgruppen angegeben sind, desto höher ist die Wahrscheinlichkeit, dass dieser Intent zugeordnet wird. Im Folgenden finden Sie das Format der Trainingsformulierungen, die annotiert sind. Das Feld auto ist optional und das Standardverhalten, wenn auto nicht angegeben ist, entspricht auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true bedeutet, dass der Teil automatisch von NLU annotiert wurde. auto = false bedeutet, dass der Teil vom Nutzer mit einer Anmerkung versehen wurde. Dies ist die Standardeinstellung, wenn „auto“ nicht festgelegt ist. Beispiel: "Buchen Sie einen Flug von ($source 'San Francisco' auto=false) nach ($dest 'Vancouver')"

IntentParameter

Definition eines Parameters, der in Trainingsformulierungen verwendet werden kann.

JSON-Darstellung
{
  "name": string,

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}
Felder
name

string

Erforderlich. Eindeutiger Name des Intent-Parameters. Kann in Bedingungen und Antworten verwendet werden, um auf von NLU mit $intent.params.[name].resolved extrahierte Intent-Parameter zu verweisen.

Union-Feld parameter_type. Der Typ des Intent-Parameters. Für parameter_type ist nur einer der folgenden Werte zulässig:
type

object (ClassReference)

Optional. Deklariert den Datentyp dieses Parameters. Für integrierte Intents sollte dies nicht festgelegt werden.

entitySetReferences

object (EntitySetReferences)

Optional. Verweise auf die Gruppen zulässiger Entitäten für diesen Intent-Parameter. Nur gültig für die Parameter eines integrierten Intents. Diese Verweise verweisen auf Entitäts-Sets in „custom/entitySets“ -Verzeichnis.

ClassReference

Ein Verweis auf eine Klasse, mit der der Typ eines Felds oder Rückgabewerts deklariert wird. Enums sind auch ein Klassentyp, auf den mit ClassReference verwiesen werden kann.

JSON-Darstellung
{
  "name": string,
  "list": boolean
}
Felder
name

string

Erforderlich. Name eines integrierten oder benutzerdefinierten Typs des Parameters. Beispiele: PizzaToppings, actions.type.Number

list

boolean

Optional. Gibt an, ob der Datentyp eine Liste von Werten darstellt.

EntitySetReferences

Entitäts-Set-Referenzen für einen Intent-Parameter

JSON-Darstellung
{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}
Felder
entitySetReferences[]

object (EntitySetReference)

Erforderlich. Entitäts-Set-Referenzen für einen Intent-Parameter

EntitySetReference

Ein Verweis auf die Gruppe zulässiger Entitäten für diesen Intent-Parameter.

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

string

Erforderlich. Gibt die spezifische Sammlung von Entitäten an, die für einen bestimmten Parameter zu berücksichtigen ist. Die entsprechende Entitäts-Set-Definition muss im Verzeichnis „custom/entitySets/“ vorhanden sein.

Typ

Angabe eines benutzerdefinierten Typs im Gegensatz zu integrierten Typen. Typen können Slots in einer Szene oder Parametern der Trainingsformulierungen eines Intents zugewiesen werden. In der Praxis können Typen als Enums betrachtet werden. Hinweis: Der Typname wird im Namen der Datei angegeben.

JSON-Darstellung
{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}
Felder
exclusions[]

string

Gruppe außergewöhnlicher Wörter/Wortgruppen, die nicht mit dem Typ abgeglichen werden sollten Hinweis: Wenn ein Wort oder eine Wortgruppe mit dem Typ übereinstimmt, aber als Ausschluss aufgelistet wird, wird es nicht im Ergebnis der Parameterextraktion zurückgegeben. Dieses Feld kann lokalisiert werden.

Union-Feld sub_type. Auswahl des Untertyps auf Grundlage der Art des durchzuführenden Abgleichs. Für sub_type ist nur einer der folgenden Werte zulässig:
synonym

object (SynonymType)

Synonymtyp, der im Wesentlichen eine Aufzählung ist.

regularExpression

object (RegularExpressionType)

Regex-Typ; ermöglicht den Abgleich regulärer Ausdrücke.

freeText

object (FreeTextType)

Freitexttyp.

SynonymType

Geben Sie Text ein, der mit einer Reihe von Synonymen übereinstimmt.

JSON-Darstellung
{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Felder
matchType

enum (MatchType)

Optional. Die Keyword-Option für das Synonym.

acceptUnknownValues

boolean

Optional. Wenn die Richtlinie auf „true“ gesetzt ist, werden unbekannte Wörter oder Wortgruppen anhand der umgebenden Eingabe- und Intent-Trainingsdaten abgeglichen, z. B. Artikel, die einer Einkaufsliste hinzugefügt werden könnten.

entities

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

Erforderlich. Benannte Karte mit Synonymentitäten.

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

MatchType

Der Übereinstimmungstyp, der von Einträgen in diesem Typ verwendet wird. Dadurch wird sichergestellt, dass für alle Typen die gleiche Abgleichmethode verwendet wird und dass die Übereinstimmung von Synonymen variiert (d.h. ungenau oder genau passend). Wenn der Wert UNSPECIFIED ist, wird er standardmäßig auf EXACT_MATCH gesetzt.

Enums
UNSPECIFIED Die Standardeinstellung ist EXACT_MATCH.
EXACT_MATCH Sucht nach einer genauen Übereinstimmung mit dem Synonym oder Namen.
FUZZY_MATCH Weniger als EXACT_MATCH. Sucht sowohl nach ähnlichen als auch nach genauen Übereinstimmungen.

Entität

Stellt ein Feld für Synonymentitäten dar, das die Details eines einzelnen Eintrags innerhalb des Typs enthält.

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

object (EntityDisplay)

Optional. Die Entitätsdetails.

synonyms[]

string

Optional. Die Liste der Synonyme für die Entität. Dieses Feld kann lokalisiert werden.

EntityDisplay

Elemente, die auf dem Canvas angezeigt werden, nachdem die Entität eines bestimmten Typs aus einer Abfrage extrahiert wurde. Nur für Canvas-fähige Apps relevant. Diese Nachricht kann lokalisiert werden.

JSON-Darstellung
{
  "iconTitle": string,
  "iconUrl": string
}
Felder
iconTitle

string

Optional. Titel des Symbols.

iconUrl

string

Erforderlich. URL des Symbols

RegularExpressionType

Geben Sie einen Text ein, der reguläre Ausdrücke enthält. Diese Nachricht kann lokalisiert werden.

JSON-Darstellung
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Felder
entities

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

Erforderlich. Benannte Zuordnung von Entitäten, die jeweils Regex-Strings enthalten.

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

Entität

Stellt ein Entitätsobjekt dar, das den regulären Ausdruck enthält, der für den Vergleich verwendet wird.

JSON-Darstellung
{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}
Felder
display

object (EntityDisplay)

Optional. Elemente, die auf dem Canvas angezeigt werden, nachdem ein Element aus einer Abfrage extrahiert wurde. Nur für Canvas-fähige Apps relevant.

regularExpressions[]

string

Erforderlich. Verwendet RE2-Regex-Syntax (weitere Informationen unter https://github.com/google/re2/wiki/Syntax)

FreeTextType

Typ, der mit einem beliebigen Text übereinstimmt, wenn der umgebende Wortkontext den bereitgestellten Trainingsbeispielen nahekommt.

JSON-Darstellung
{
  "display": {
    object (EntityDisplay)
  }
}
Felder
display

object (EntityDisplay)

Optional. Elemente, die auf dem Canvas angezeigt werden, nachdem ein Element aus einer Abfrage extrahiert wurde. Nur für Canvas-fähige Apps relevant.

EntitySet

Entitäts-Sets beschreiben die vordefinierten Entitäten, aus denen die Werte integrierter Intent-Parameter stammen können. Auf Entitäts-Sets kann von entitySet in integrierten Intent-Parametern verwiesen werden.

JSON-Darstellung
{
  "entities": [
    {
      object (Entity)
    }
  ]
}
Felder
entities[]

object (Entity)

Erforderlich. Die Liste der Entitäten, die von diesem Entitäts-Set unterstützt werden.

Entität

Eine Entität, aus der ein integrierter Intent-Parameterwert stammen kann.

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

string

Erforderlich. Die ID der Entität. Eine Liste der integrierten Intent-Parameter und ihrer unterstützten Entitäten finden Sie unter https://developers.google.com/assistant/conversational/build/built-in-intents.

GlobalIntentEvent

Definiert einen globalen Intent-Handler. Globale Intent-Ereignisse beziehen sich auf das gesamte Actions-Projekt und können von Intent-Handlern in einer Szene überschrieben werden. Intent-Namen müssen innerhalb eines Actions-Projekts eindeutig sein.

Globale Intents können jederzeit während einer Sitzung zugeordnet werden, sodass Nutzer auf gängige Abläufe wie „Hilfe aufrufen“ zugreifen können oder „Zurück zur Startseite“. Sie können auch verwendet werden, um Nutzer beim Aufrufen einer Aktion per Deeplink zu bestimmten Abläufen zu verknüpfen.

Der Intent-Name wird im Namen der Datei angegeben.

JSON-Darstellung
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Felder
transitionToScene

string

Optional. Zielszene, zu dem die Unterhaltung springen soll. Der Status der aktuellen Szene wird beim Übergang gelöscht.

handler

object (EventHandler)

Optional. Event-Handler, der ausgelöst wird, wenn der Intent zugeordnet wird. Sollte vor dem Übergang zur Zielszene ausgeführt werden. Nützlich, um Aufforderungen als Reaktion auf Ereignisse zu generieren.

EventHandler

Definiert einen Handler, der nach einem Ereignis ausgeführt werden soll. Beispiele für Ereignisse sind Intent- und bedingungsbasierte Ereignisse in einer Szene.

JSON-Darstellung
{
  "webhookHandler": string,

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}
Felder
webhookHandler

string

Name des aufzurufenden Webhook-Handlers.

Union-Feld prompt. Prompts können entweder inline eingefügt oder über einen Namen referenziert werden. Für prompt ist nur einer der folgenden Werte zulässig:
staticPrompt

object (StaticPrompt)

Statischer Inline-Prompt. Kann Verweise auf Stringressourcen in Bundles enthalten.

staticPromptName

string

Name der statischen Aufforderung, die aufgerufen werden soll.

StaticPrompt

Stellt eine Liste mit Prompt-Kandidaten dar, von denen eine als Prompt ausgewählt wird, der dem Nutzer in der Antwort angezeigt wird. Diese Nachricht kann lokalisiert werden.

JSON-Darstellung
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Felder
candidates[]

object (StaticPromptCandidate)

Die Liste der möglichen Prompts, die an den Client gesendet werden sollen. Jeder Prompt hat einen Selector, um festzulegen, wann er verwendet werden kann. Der erste Selector, der einer Anfrage entspricht, wird gesendet und der Rest ignoriert.

StaticPromptCandidate

Stellt einen Kandidaten für statische Aufforderungen dar.

JSON-Darstellung
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Felder
selector

object (Selector)

Optional. Die Kriterien dafür, ob dieser Prompt mit einer Anfrage übereinstimmt. Wenn die Auswahl leer ist, wird diese Aufforderung immer ausgelöst.

promptResponse

object (StaticPromptResponse)

Die mit der Auswahl verknüpfte Prompt-Antwort.

Selector

Definiert die Kriterien dafür, ob eine Aufforderung mit einer Anfrage übereinstimmt.

JSON-Darstellung
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Felder
surfaceCapabilities

object (SurfaceCapabilities)

Die erforderlichen Oberflächenfunktionen.

SurfaceCapabilities

Stellt die Oberfläche dar, über die der Nutzer eine Anfrage an die Aktion sendet.

JSON-Darstellung
{
  "capabilities": [
    enum (Capability)
  ]
}
Felder
capabilities[]

enum (Capability)

Erforderlich. Die Fähigkeiten der Oberfläche, die eine Anfrage an die Aktion sendet.

Funktion

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

Enums
UNSPECIFIED Unbekannte Oberflächenfunktion.
SPEECH Das Gerät kann über Sprachausgabe oder SSML mit dem Nutzer sprechen.
RICH_RESPONSE Auf dem Gerät können Rich-Antworten wie Karten, Listen und Tabellen angezeigt werden.
LONG_FORM_AUDIO Auf dem Gerät können Audioinhalte im Langformat wie Musik und Podcasts abgespielt werden.
INTERACTIVE_CANVAS Auf dem Gerät kann eine interaktive Canvas-Antwort angezeigt werden.
HOME_STORAGE Das Gerät kann das Speichern und Abrufen von Speicherplatz im Zuhause unterstützen.

StaticPromptResponse

Stellt strukturierte Antworten dar, die an den Nutzer gesendet werden, z. B. Text, Sprache, Karten, Canvas-Daten, Chips mit Vorschlägen usw.

JSON-Darstellung
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
Felder
firstSimple

object (StaticSimplePrompt)

Optional. Die erste reine Sprach- und Textantwort.

content

object (StaticContentPrompt)

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

lastSimple

object (StaticSimplePrompt)

Optional. Die letzte reine Sprach- und Textantwort.

suggestions[]

object (Suggestion)

Optional. Vorschläge, die dem Nutzer angezeigt werden und immer am Ende der Antwort angezeigt werden. Wenn das Feld append im zugehörigen Prompt true lautet, werden die in diesem Feld definierten Titel den Titeln hinzugefügt, die in zuvor definierten Prompts für Vorschläge definiert wurden. Doppelte Werte werden entfernt.

override

boolean

Optional. Modus zum Zusammenführen dieser Nachrichten mit zuvor definierten Nachrichten. true löscht alle zuvor definierten Nachrichten (erste und letzte einfache Nachricht, Inhalt, Link für Vorschläge und Canvas) und fügt in diesem Prompt definierte Nachrichten hinzu. false fügt die in diesem Prompt definierten Nachrichten den in früheren Antworten definierten Nachrichten hinzu. Wenn du dieses Feld auf false setzt, wird auch das Anfügen an einige Felder in einfachen Prompts, der Aufforderung „Vorschläge“ und der Canvas-Aufforderung (Teil der Inhaltsaufforderung) aktiviert. Die Inhalts- und Linkmeldungen werden immer überschrieben, wenn sie im Prompt definiert werden. Der Standardwert ist false.

canvas

object (StaticCanvasPrompt)

Eine Antwort, die für das interaktive Canvas-Erlebnis verwendet werden soll.

StaticSimplePrompt

Stellt eine einfache Aufforderung dar, die an einen Nutzer gesendet werden soll.

JSON-Darstellung
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Felder
variants[]

object (Variant)

Liste der möglichen Varianten.

Variante

Stellt eine Variante dar, die Teil des einfachen Prompts ist.

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

string

Optional. Stellt die Sprache dar, die dem Nutzer vorgelesen werden soll. Kann SSML oder Sprachausgabe sein. Standardmäßig wird die Sprachausgabe an die vorherige einfache Aufforderung angehängt. Wenn das Feld override im zugehörigen Prompt true lautet, überschreibt die in diesem Feld definierte Sprache die vorherige Sprache des einfachen Prompts.

text

string

Optional. Text, der im Chat-Infofeld angezeigt wird. Wenn nicht angegeben, wird eine Anzeigedarstellung des obigen Sprachfelds verwendet. Auf 640 Zeichen begrenzt. Standardmäßig wird der Text an den vorherigen einfachen Prompt-Text angehängt. Wenn das Feld override im enthaltenen Prompt true lautet, überschreibt der in diesem Feld definierte Text den vorherigen einfachen Prompt-Text.

StaticContentPrompt

Ein Platzhalter für den Inhaltsteil einer StaticPrompt.

JSON-Darstellung
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}
Felder
Union-Feld content. In einem Prompt kann nur ein Inhaltstyp enthalten sein. Für content ist nur einer der folgenden Werte zulässig:
card

object (StaticCardPrompt)

Eine einfache Karte.

image

object (StaticImagePrompt)

Ein Bild.

table

object (StaticTablePrompt)

Tabellenkarte.

media

object (StaticMediaPrompt)

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

list

object (StaticListPrompt)

Eine Karte, auf der eine Liste mit Optionen präsentiert wird.

collection

object (StaticCollectionPrompt)

Eine Karte mit einer Liste von Optionen zur Auswahl.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Eine Karte mit einer Sammlung von Webseiten, die geöffnet werden können.

StaticCardPrompt

Eine einfache Karte zur Anzeige einiger Informationen, z.B. einem Bild und/oder Text.

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

string

Optional. Gesamttitel der Karte

subtitle

string

Optional. Untertitel der Karte

text

string

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

image

object (StaticImagePrompt)

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

imageFill

enum (ImageFill)

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

button

object (StaticLinkPrompt)

Optional. Eine anklickbare Schaltfläche, die auf der Karte angezeigt wird.

StaticImagePrompt

Ein Bild, das auf der Karte angezeigt wird.

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

string

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

alt

string

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

height

integer

Optional. Die Höhe des Bilds in Pixeln

width

integer

Optional. Die Breite des Bilds in Pixeln

ImageFill

Mögliche Anzeigeoptionen für Bilder, um die Darstellung des Bildes zu beeinflussen Dieser Parameter sollte verwendet werden, wenn das Seitenverhältnis des Bilds nicht mit dem des Bildcontainers übereinstimmt.

Enums
UNSPECIFIED ImageFill nicht angegeben
GRAY Schließen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit grauen Balken.
WHITE Schließen Sie die Lücken zwischen dem Bild und dem Bildcontainer mit weißen Balken.
CROPPED Das Bild wird so skaliert, dass die Bildbreite und -höhe den Containerabmessungen entsprechen oder diese überschreiten. Dadurch kann der obere und untere Bereich des Bilds zugeschnitten werden, wenn die skalierte Bildhöhe größer als die Containerhöhe ist, oder der linke und rechte Teil des Bilds, wenn die skalierte Bildbreite größer als die Containerbreite ist. Dies ähnelt dem „Zoom-Modus“ auf einem Breitbildfernseher.

StaticLinkPrompt

Definiert einen Link, der als Vorschlags-Chip angezeigt wird und vom Nutzer geöffnet werden kann.

JSON-Darstellung
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
Felder
name

string

Name des Links

open

object (OpenUrl)

Definiert das Verhalten, wenn der Nutzer den Link öffnet.

OpenUrl

Definiert das Verhalten, wenn der Nutzer den Link öffnet.

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

string

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

hint

enum (UrlHint)

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

UrlHint

Verschiedene Arten von URL-Hinweisen

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

StaticTablePrompt

Eine Tabellenkarte zum Anzeigen einer Tabelle mit Text.

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

string

Optional. Gesamttitel der Tabelle Muss festgelegt werden, wenn Untertitel festgelegt sind.

subtitle

string

Optional. Untertitel für die Tabelle.

image

object (StaticImagePrompt)

Optional. Mit der Tabelle verknüpftes Bild.

columns[]

object (TableColumn)

Optional. Überschriften und Ausrichtung von Spalten.

rows[]

object (TableRow)

Optional. Zeilendaten der Tabelle. Die ersten 3 Zeilen werden garantiert angezeigt, aber die anderen werden möglicherweise an bestimmten Oberflächen abgeschnitten. Führen Sie einen Test mit dem Simulator durch, um zu sehen, welche Zeilen für eine bestimmte Oberfläche angezeigt werden. Auf Oberflächen, die die Funktion WEB_BROWSER unterstützen, kannst du den Nutzer auf eine Webseite mit weiteren Daten verweisen.

button

object (StaticLinkPrompt)

Optional. Schaltfläche.

TableColumn

Beschreibt eine Spalte in der Tabelle.

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

string

Überschrift für die Spalte.

align

enum (HorizontalAlignment)

Horizontale Ausrichtung des Inhalts mit der Spalte. Wenn kein Wert angegeben ist, wird der Inhalt an der Spitze ausgerichtet.

HorizontalAlignment

Die Ausrichtung des Inhalts innerhalb der Zelle.

Enums
UNSPECIFIED HorizontalAlignment nicht angegeben.
LEADING Oberste Kante der Zelle. Das ist die Standardeinstellung.
CENTER Der Inhalt ist in der Mitte der Spalte ausgerichtet.
TRAILING Der Inhalt ist am Ende der Spalte ausgerichtet.

TableRow

Beschreibt eine Zeile in der Tabelle.

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

object (TableCell)

Zellen in dieser Zeile. Die ersten 3 Zellen werden garantiert angezeigt, aber andere werden möglicherweise an bestimmten Oberflächen ausgeschnitten. Führen Sie einen Test mit dem Simulator durch, um zu sehen, welche Zellen für eine bestimmte Oberfläche angezeigt werden.

divider

boolean

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

TableCell

Beschreibt eine Zelle in einer Zeile.

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

string

Textinhalt der Zelle.

StaticMediaPrompt

Enthält Informationen zum Medium, z. B. Name, Beschreibung, URL usw. Nächste ID: 11

JSON-Darstellung
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode)
}
Felder
mediaType

enum (MediaType)

Medientyp dieser Antwort.

startOffset

string (Duration format)

Startversatz des ersten Medienobjekts.

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

optionalMediaControls[]

enum (OptionalMediaControls)

Optionale Mediensteuerungstypen, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, wird die Anfrage an 3p gesendet, wenn ein bestimmtes Medienereignis eintritt. Wenn die Richtlinie nicht konfiguriert ist, muss 3p dennoch die beiden Standardsteuerungstypen FINISHED und FAILED verarbeiten.

mediaObjects[]

object (MediaObject)

Liste der Medienobjekte.

repeatMode

enum (RepeatMode)

Wiederholungsmodus für die Liste der Medienobjekte.

MediaType

Medientyp dieser Antwort.

Enums
MEDIA_TYPE_UNSPECIFIED Wert OHNE ANGABE
AUDIO Audiodatei.
MEDIA_STATUS_ACK Antwort, um einen Medienstatusbericht zu bestätigen.

OptionalMediaControls

Optional unterstützte Mediensteuerungstypen, die die Medienantwort unterstützen kann

Enums
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Nicht angegebener Wert
PAUSED Ereignis pausiert. Wird ausgelöst, wenn der Nutzer die Medien pausiert.
STOPPED Ereignis wurde beendet. Wird ausgelöst, wenn der Nutzer die Drittanbietersitzung während der Medienwiedergabe beendet.

MediaObject

Stellt ein einzelnes Medienobjekt dar.

JSON-Darstellung
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Felder
name

string

Name dieses Medienobjekts.

description

string

Beschreibung dieses Medienobjekts.

url

string

Die URL, die auf den Medieninhalt verweist

image

object (MediaImage)

Bild, das mit der Medienkarte angezeigt werden soll.

MediaImage

Bild, das in einem MediaPrompt angezeigt wird.

JSON-Darstellung
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
Felder
Union-Feld image. Es ist nur ein MediaImage-Typ zulässig. Für image ist nur einer der folgenden Werte zulässig:
large

object (StaticImagePrompt)

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

icon

object (StaticImagePrompt)

Ein kleines Bildsymbol rechts neben dem Titel. Die Größe wird auf 36 x 36 dp reduziert.

RepeatMode

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

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

StaticListPrompt

Eine Karte, auf der eine Liste mit Optionen präsentiert wird.

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

string

Optional. Titel der Liste.

subtitle

string

Optional. Untertitel der Liste.

items[]

object (ListItem)

Erforderlich. Listenelemente.

ListItem

Ein Element in der Liste.

JSON-Darstellung
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Felder
key

string

Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Eingabeschlüssels im verknüpften Typ übereinstimmt. Wenn ein Element angetippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben.

title

string

Erforderlich. Titel des Artikels. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Gruppe von Elementen eindeutig sein.

description

string

Optional. Text des Elements.

image

object (StaticImagePrompt)

Optional. Bild des Artikels.

StaticCollectionPrompt

Eine Karte, auf der eine Sammlung von Optionen präsentiert wird.

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

string

Optional. Titel der Sammlung.

subtitle

string

Optional. Untertitel der Sammlung.

items[]

object (CollectionItem)

Erforderlich. Sammlungselemente.

imageFill

enum (ImageFill)

Optional. Art der Bildanzeigeoption.

CollectionItem

Ein Element in der Sammlung.

JSON-Darstellung
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Felder
key

string

Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Eingabeschlüssels im verknüpften Typ übereinstimmt. Wenn ein Element angetippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben.

title

string

Erforderlich. Titel des Artikels. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Gruppe von Elementen eindeutig sein.

description

string

Optional. Text des Elements.

image

object (StaticImagePrompt)

Optional. Bild des Artikels.

StaticCollectionBrowsePrompt

Stellt eine Reihe von Webdokumenten als eine Sammlung groß gekachelter Elemente dar. Sie können Elemente auswählen, um das zugehörige Webdokument in einem Web Viewer zu öffnen.

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

object (CollectionBrowseItem)

Elemente in der Sammlung „Stöbern“. Die Listengröße sollte im Bereich [2, 10] liegen.

imageFill

enum (ImageFill)

Anzeigeoption für Bilder in der Sammlung.

CollectionBrowseItem

Element in der Sammlung.

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

string

Erforderlich. Titel des Sammlungselements.

description

string

Beschreibung des Sammlungselements.

footer

string

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

image

object (StaticImagePrompt)

Bild für das Sammlungselement.

openUriAction

object (OpenUrl)

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

Vorschlag

Stellt einen Vorschlags-Chip dar, ein UI-Element, das dem Nutzer der Einfachheit halber angezeigt wird.

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

string

Erforderlich. Der Text, der im Vorschlags-Chip angezeigt wird. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss unter den Vorschlags-Chips eindeutig sein. Maximal 25 Zeichen

StaticCanvasPrompt

Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. Dies kann in Verbindung mit dem Feld firstSimple in der enthaltenen Prompt verwendet werden, um mit dem Nutzer zu sprechen und nicht nur eine interaktive Canvas-Antwort anzuzeigen.

JSON-Darstellung
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}
Felder
url

string

Erforderlich. URL der zu ladenden Webansicht.

data[]

value (Value format)

Optional. JSON-Daten, die als Ereignis an die Webseite des immersiven Erlebnisses übergeben werden. Wenn das Feld override im enthaltenen Prompt false enthält, werden die in diesem Canvas-Prompt definierten Datenwerte nach den in vorherigen Canvas-Prompts definierten Datenwerten hinzugefügt.

suppressMic

boolean

Optional. Ein wahrer Wert bedeutet, dass das Mikrofon nicht für die Erfassung von Eingaben geöffnet wird, nachdem die immersive Antwort dem Nutzer präsentiert wurde.

sendStateDataToCanvasApp

boolean

Optional. Bei true sind unterhaltungsbezogene Metadaten enthalten und werden an die Canvas-Anwendung zurückgesendet.

enableFullScreen

boolean

Optional. Wenn true aktiviert ist, füllt die Canvas-Anwendung den gesamten Bildschirm aus und hat oben keine Kopfzeile. Außerdem wird auf dem Ladebildschirm eine Toast-Nachricht mit dem Anzeigenamen der Aktion, dem Namen des Entwicklers und einer Anleitung zum Beenden der Aktion angezeigt. Standardwert: false.

Szene

Die Szene ist die grundlegende Einheit für den Ablauf beim Entwerfen einer Unterhaltung. Sie können mit anderen Szenen verkettet werden, Prompts für Endnutzer generieren und Slots definieren. Der Szenenname wird im Namen der Datei angegeben.

JSON-Darstellung
{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}
Felder
onEnter

object (EventHandler)

Handler, der beim Übergang zu dieser Szene aufgerufen wird.

intentEvents[]

object (IntentEvent)

Die Liste der Ereignisse, die basierend auf Intents ausgelöst werden. Diese Ereignisse können jederzeit ausgelöst werden, nachdem der on_load-Handler aufgerufen wurde. Wichtig: Diese Ereignisse definieren die Gruppe von Intents, die sich auf diese Szene beziehen. Sie haben Vorrang vor global definierten Ereignissen mit denselben Intents oder ihren Trigger-Ausdrücken. Intent-Namen müssen innerhalb einer Szene eindeutig sein.

conditionalEvents[]

object (ConditionalEvent)

Die Liste der Ereignisse, die basierend auf bedingten Anweisungen ausgelöst werden sollen. Diese werden ausgewertet, nachdem das Formular ausgefüllt wurde, oder sofort nach on_load, falls diese Szene kein Formular enthält (die Bewertung erfolgt nur einmal). Nur das erste übereinstimmende Ereignis wird ausgelöst.

slots[]

object (Slot)

Sortierte Liste von Slots. Jeder Slot definiert den Typ der aufzulösenden Daten und die Konfiguration, um die Darstellung dieser Auflösung anzupassen (z.B. Aufforderungen).

onSlotUpdated

object (EventHandler)

Handler aufgerufen, wenn eine Statusänderung eines Slots auftritt, die nicht durch Updates in einem anderen Handler verursacht wird. Dadurch können Slots, die Szene ungültig gemacht oder andere Änderungen am Szenenstatus vorgenommen werden.

IntentEvent

Registriert Ereignisse, die als Ergebnis einer Intent-Übereinstimmung ausgelöst werden.

JSON-Darstellung
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Felder
intent

string

Erforderlich. Intent, der das Ereignis auslöst.

transitionToScene

string

Optional. Zielszene, zu dem die Unterhaltung springen soll. Der Status der aktuellen Szene wird beim Übergang gelöscht.

handler

object (EventHandler)

Optional. Event-Handler, der ausgelöst wird, wenn der Intent zugeordnet wird. Sollte vor dem Übergang zur Zielszene ausgeführt werden. Nützlich, um Prompts als Reaktion auf Ereignisse zu generieren.

ConditionalEvent

Registriert Ereignisse, die als Ergebnis einer wahren Bedingung ausgelöst werden.

JSON-Darstellung
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Felder
condition

string

Erforderlich. Filterbedingung für das Auslösen dieses Ereignisses. Wenn die Bedingung als „true“ ausgewertet wird, wird die zugehörige handler ausgelöst. Die folgenden Variablenverweise werden unterstützt: $session – um auf Daten im Sitzungsspeicher zu verweisen. $user – um auf Daten im Nutzerspeicher zu verweisen. Die folgenden booleschen Operatoren werden unterstützt (mit Beispielen): &&session.params.counter > 0 && session.params.counter < 100 ||session.params.foo == "John" || session.params.counter == "Adam" !!(session.params.counter == 5) Die folgenden Vergleiche werden unterstützt: ==, !=, <, >, <=, >= Die folgenden Listen- und Stringoperatoren werden unterstützt (mit Beispielen): in – "Wassermelone" in session.params.fruitList sizesize(session.params.fruitList) > 2 substringsession.params.fullName.contains("John")

transitionToScene

string

Optional. Zielszene, zu der die Unterhaltung springen soll, wenn die zugehörige Bedingung als „true“ ausgewertet wird. Der Status der aktuellen Szene wird beim Übergang gelöscht.

handler

object (EventHandler)

Optional. Event-Handler, der ausgelöst wird, wenn die zugehörige Bedingung als true ausgewertet wird. Sollte vor dem Übergang zur Zielszene ausgeführt werden. Nützlich, um Aufforderungen als Reaktion auf Ereignisse zu generieren.

Anzeigenfläche

Konfiguration für einen Slot. Slots sind einzelne Dateneinheiten, die über natürliche Sprache (d. h. Intent-Parameter), Sitzungsparameter und andere Quellen gefüllt werden können.

JSON-Darstellung
{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}
Felder
name

string

Erforderlich. Name des Slots.

type

object (ClassReference)

Erforderlich. Deklariert den Datentyp dieses Slots.

required

boolean

Optional. Gibt an, ob die Anzeigenfläche vor dem Fortfahren gefüllt werden muss. Nicht gefüllte Anzeigenflächen lösen eine anpassbare Aufforderung an den Nutzer aus.

promptSettings

object (PromptSettings)

Optional. Registriert Aufforderungen für verschiedene Phasen der Slot-Füllung.

commitBehavior

object (CommitBehavior)

Optional. Commit-Verhalten in Verbindung mit der Anzeigenfläche.

config

value (Value format)

Optional. Zusätzliche Konfiguration für den Slot, der zum Füllen des Slots verwendet wird. Das Format der Konfiguration ist spezifisch für den Slottyp. Dieser Konfiguration können Ressourcenverweise auf Nutzer- oder Sitzungsparameter hinzugefügt werden. Diese Konfiguration wird benötigt, um Slots im Zusammenhang mit Transaktionen und Nutzer-Engagement zu füllen.

Beispiel: Für einen Slot vom Typ actions.type.CompletePurchaseValue schlägt die folgende Konfiguration eine digitale Ware mit einem Verweis auf einen clientseitig definierten Sitzungsparameter userSelectedSkuId vor:

{ &quot;@type&quot;: &quot;type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec&quot;, &quot;skuId&quot;: { &quot;skuType&quot;: &quot;SKU_TYPE_IN_APP&quot;, &quot;id&quot;: &quot;$session.params.userSelectedSkuId&quot;, &quot;packageName&quot;: &quot;com.example.company&quot; }

defaultValue

object (DefaultValue)

Optional. Konfiguration zum Ausfüllen eines Standardwerts für diese Anzeigenfläche.

PromptSettings

Ein zentraler Ort, an dem Slot-Prompts definiert werden.

JSON-Darstellung
{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}
Felder
initialPrompt

object (EventHandler)

Fragt den Slotwert selbst ab. Beispiel: „Welche Größe wollten Sie?“

noMatchPrompt1

object (EventHandler)

Eine Aufforderung, die ausgegeben wird, wenn die Eingabe des Nutzers zum ersten Mal nicht dem erwarteten Werttyp für den Slot entspricht. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“

noMatchPrompt2

object (EventHandler)

Eine Aufforderung, die ausgegeben wird, wenn die Eingabe des Nutzers zum zweiten Mal nicht mit dem erwarteten Werttyp für den Slot übereinstimmt. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“

noMatchFinalPrompt

object (EventHandler)

Aufforderung, die ausgegeben wird, wenn die Eingabe des Nutzers zum letzten Mal nicht mit dem erwarteten Werttyp für den Slot übereinstimmt. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“

noInputPrompt1

object (EventHandler)

Aufforderung, die gegeben wird, wenn der Nutzer nicht zum ersten Mal eine Eingabe macht. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“

noInputPrompt2

object (EventHandler)

Aufforderung zu geben, wenn der Nutzer zum zweiten Mal keine Eingabe macht. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“

noInputFinalPrompt

object (EventHandler)

Aufforderung, die gegeben wird, wenn der Nutzer zum letzten Mal nichts eingegeben hat. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“

CommitBehavior

Meldung, die das Commit-Verhalten für den Slot beschreibt, nachdem er erfolgreich gefüllt wurde

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

string

Der Sitzungsparameter zum Schreiben des Slotwerts, nachdem er gefüllt wurde. Beachten Sie, dass verschachtelte Pfade derzeit nicht unterstützt werden. „€€“ wird verwendet, um den Slotwert in einen Sitzungsparameter mit dem Namen des Slots zu schreiben. Beispiel: writeSessionParam = "Obst" "$session.params.fruit" entspricht. writeSessionParam = "Ticket" entspricht "$session.params.ticket".

DefaultValue

Konfiguration zum Ausfüllen eines Standardwerts für diese Anzeigenfläche.

JSON-Darstellung
{
  "sessionParam": string,
  "constant": value
}
Felder
sessionParam

string

Optional. Der Sitzungsparameter, der zum Initialisieren des Slotwerts verwendet wird, wenn er einen nicht leeren Wert hat. Der Typ des Werts muss mit dem Typ der Anzeigenfläche übereinstimmen. Beachten Sie, dass verschachtelte Pfade derzeit nicht unterstützt werden. Beispiel: sessionParam = "fruit" entspricht $session.params.fruit. sessionParam = "ticket" entspricht $session.params.ticket.

constant

value (Value format)

Optional. Konstanter Standardwert für die Anzeigenfläche. Wird nur verwendet, wenn ein Wert für diese Anzeigenfläche nicht über sessionParam ausgefüllt wurde. Der Typ für diesen Wert muss mit dem Typ der Anzeigenfläche übereinstimmen.

DataFiles

Wrapper für wiederholte Datendatei. Wiederkehrende Felder können in einem oneof nicht vorhanden sein.

JSON-Darstellung
{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}
Felder
dataFiles[]

object (DataFile)

Mehrere Datendateien

DataFile

Stellt eine einzelne Datei mit unstrukturierten Daten dar. Beispiele hierfür sind Bilddateien, Audiodateien und Cloud Functions-Quellcode.

JSON-Darstellung
{
  "filePath": string,
  "contentType": string,
  "payload": string
}
Felder
filePath

string

Der relative Pfad der Datendatei vom Projektstamm in der SDK-Dateistruktur. Zulässige Dateipfade: – Bilder: resources/images/{multiple directories}?/{ImageName}.{extension} – Audio: resources/audio/{multiple directories}?/{AudioFileName}.{extension} – Cloud Functions-Inline-Code: webhooks/{WebhookName}.zip Zulässige Erweiterungen: – Bilder: png, jpg, jpeg – Audio: mp3, mpeg – Cloud Functions-Inline-Funktionen: zip

contentType

string

Erforderlich. Der Inhaltstyp dieses Assets. Beispiel: text/html. Der Inhaltstyp muss der Spezifikation (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html) entsprechen. Cloud Functions-Funktionen müssen im ZIP-Format vorliegen und der Inhaltstyp muss application/zip;zip_type=cloud_function sein. Der Parameter „zip_type“ gibt an, dass die ZIP-Datei für eine Cloud Functions-Funktion bestimmt ist.

payload

string (bytes format)

Inhalt der Datendatei. Beispiele hierfür sind Rohbyte von Bildern, Audiodateien oder das ZIP-Format mit Cloud Functions-Funktionen. Für die Nutzlastgröße gilt eine strikte Beschränkung von 10 MB.

Ein base64-codierter String.