- JSON-Darstellung
- ConfigFiles
- ConfigFile
- Manifest
- Aktionen
- CustomAction
- Interaktion
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Einstellungen
- Kategorie
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings:
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Handler
- HttpsEndpoint
- InlineCloudFunction
- Intent
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Typ
- SynonymType
- MatchType
- Entität
- EntityDisplay
- RegularExpressionType
- Entität
- FreeTextType
- EntitySet
- Entität
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Auswahl
- SurfaceCapabilities
- Funktion
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Vorschlag
- StaticCanvasPrompt
- Szene
- IntentEvent
- ConditionalEvent
- Slot
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Wrapper für eine Liste von Dateien.
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld file_type . Es kann jeweils nur ein Dateityp an den Server gesendet werden: Konfigurationsdateien oder Datendateien. Für file_type ist nur einer der folgenden Werte zulässig: |
||
configFiles |
Liste der Konfigurationsdateien. Dazu gehören Manifest, Einstellungen, Ressourcen-Bundles für Interaktionsmodelle und mehr. |
|
dataFiles |
Liste der Datendateien. Dazu gehören Bilder, Audiodateien und Cloud Functions-Quellcode. |
ConfigFiles
Wrapper für wiederholte Konfigurationsdateien. Wiederkehrende Felder dürfen nicht in einem oneof enthalten sein.
JSON-Darstellung | |
---|---|
{
"configFiles": [
{
object ( |
Felder | |
---|---|
configFiles[] |
Mehrere Konfigurationsdateien. |
ConfigFile
Stellt eine einzelne Datei dar, die strukturierte Daten enthält. Entwickler können den Großteil ihres Projekts mithilfe von strukturierten Konfigurationen definieren, einschließlich Aktionen, Einstellungen und Auftragsausführung.
JSON-Darstellung | |
---|---|
{ "filePath": string, // Union field |
Felder | ||
---|---|---|
filePath |
Der relative Pfad der Konfigurationsdatei vom Projektstamm in der SDK-Dateistruktur. Für alle unten aufgeführten Dateitypen gibt es einen zulässigen Dateipfad. Beispiel: settings/settings.yaml |
|
Union-Feld file . Für jeden Konfigurationsdateityp sollte ein entsprechendes Feld im oneof vorhanden sein. Für file ist nur einer der folgenden Werte zulässig: |
||
manifest |
Einzelne Manifestdatei. Zulässiger Dateipfad: |
|
actions |
Datei mit einzelnen Aktionen, in der alle Aktionen definiert sind. Zulässige Dateipfade: |
|
settings |
Einzeleinstellungskonfiguration, die nicht lokalisierbare Einstellungen und Einstellungen für die Standardsprache des Projekts enthält (falls angegeben). Bei einer Datei zum Überschreiben des Gebietsschemas wird nur das Feld „localizedSettings“ gefüllt. Zulässige Dateipfade: |
|
webhook |
Einzelne Webhook-Definition. Zulässiger Dateipfad: |
|
intent |
Definition eines einzelnen Intents. Zulässige Dateipfade: |
|
type |
Definition eines einzelnen Typs. Zulässige Dateipfade: |
|
entitySet |
Definition eines einzelnen Entitäts-Sets. Zulässige Dateipfade: |
|
globalIntentEvent |
Definition eines einzelnen globalen Intent-Ereignisses. Zulässige Dateipfade: |
|
scene |
Einzelszenendefinition Zulässige Dateipfade: |
|
staticPrompt |
Eine einzelne statische Eingabeaufforderung. Zulässige Dateipfade: |
|
accountLinkingSecret |
Metadaten, die dem Clientschlüssel entsprechen, der bei der Kontoverknüpfung verwendet wird. Zulässiger Dateipfad: |
|
resourceBundle |
Ein einzelnes Ressourcen-Bundle, das eine Zuordnung von einem String zu einem String oder einer Liste von Strings darstellt. Ressourcen-Bundles können zum Lokalisieren von Strings in statischen Prompts verwendet werden. Zulässige Dateipfade: |
Manifest
Enthält Informationen, die "transportierbar" sind, d.h. nicht projektspezifisch sind und zwischen Projekten verschoben werden können.
JSON-Darstellung | |
---|---|
{ "version": string } |
Felder | |
---|---|
version |
Version des Dateiformats. Die aktuelle Dateiformatversion ist 1.0. Beispiel: „1.0“ |
Aktionen
Stellt die Liste der in einem Projekt definierten Aktionen dar.
JSON-Darstellung | |
---|---|
{
"custom": {
string: {
object ( |
Felder | |
---|---|
custom |
Zuordnung von Intents zu benutzerdefinierten Aktionen, um den Aufruf für das Projekt zu konfigurieren. Die Aufruf-Intents können entweder System- oder benutzerdefinierte Intents sein, die im Paket „custom/intents/“ definiert sind. Für alle hier definierten Intents (System-Intents und benutzerdefinierte Intents) muss im Paket „custom/global/“ eine entsprechende Intent-Datei vorhanden sein. Ein Objekt, das eine Liste von |
CustomAction
Details zu einer benutzerdefinierten Aktion.
JSON-Darstellung | |
---|---|
{
"engagement": {
object ( |
Felder | |
---|---|
engagement |
Einbindungsmechanismen, die mit der Aktion verbunden sind, um Endnutzern zu helfen, Push-Benachrichtigungen und tägliche Updates zu abonnieren. Beachten Sie, dass der in der Konfiguration für Slots für tägliche Updates/Push-Benachrichtigungen angegebene Intent-Name mit dem Intent übereinstimmen muss, der dieser Aktion entspricht, damit Endnutzer diese Updates abonnieren können. |
Engagement
Definiert die mit dieser Aktion verknüpften Mechanismen zur Interaktion. So können Endnutzer Push-Benachrichtigungen und tägliche Updates abonnieren.
JSON-Darstellung | |
---|---|
{ "title": string, "pushNotification": { object ( |
Felder | |
---|---|
title |
Der Titel der Interaktion, die an Endnutzer gesendet wird, die um ihre Zustimmung zum Erhalt von Updates gebeten werden. Die Aufforderung, die an Endnutzer für tägliche Updates gesendet wird, sieht so aus: "Um welche Uhrzeit soll ich Ihnen den {Titel} des Tages senden. Bei Push-Benachrichtigungen ist es in Ordnung, wenn ich Push-Benachrichtigungen für {Titel} sende. Dieses Feld kann lokalisiert werden. |
pushNotification |
Einstellungen für Push-Benachrichtigungen, die von dieser Interaktion unterstützt werden. |
actionLink |
Die Linkkonfiguration für eine Aktion, die bestimmt, ob das Teilen von Links für die Aktion aktiviert ist, und, falls ja, enthält den nutzerfreundlichen Anzeigenamen für den Link. ActionLink wurde eingestellt. Verwende stattdessen AssistantLink. |
assistantLink |
Die Linkkonfiguration für eine Aktion, die bestimmt, ob das Teilen von Links für die Aktion aktiviert ist, und, falls ja, enthält den nutzerfreundlichen Anzeigenamen für den Link. |
dailyUpdate |
Einstellungen für tägliche Updates, die von dieser Interaktion unterstützt werden. |
PushNotification
Definiert die von dieser Interaktion unterstützten Einstellungen für Push-Benachrichtigungen.
DailyUpdate
Definiert die Einstellungen für tägliche Updates, die für diese Interaktion unterstützt werden.
ActionLink
Gibt an, ob Freigabelinks für diese Aktion und die entsprechenden Einstellungen aktiviert sind. Mit Aktionslinks gelangen Nutzer per Deeplink zu einer bestimmten Aktion. ActionLink wurde eingestellt. Verwende stattdessen AssistantLink.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Benutzerfreundlicher Anzeigetitel für den Link. |
AssistantLink
Gibt an, ob Freigabelinks für diese Aktion und die entsprechenden Einstellungen aktiviert sind. Mit Assistant-Links können Nutzer per Deeplink zu einer bestimmten Aktion weitergeleitet werden.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Benutzerfreundlicher Anzeigetitel für den Link. |
Einstellungen
Stellt nicht sprachenspezifische Einstellungen eines Actions-Projekts dar. Nächstes Tag: 22
JSON-Darstellung | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Felder | |
---|---|
projectId |
Actions-Projekt-ID. |
defaultLocale |
Sprache: Dies ist die Standardeinstellung für das Projekt. In allen Dateien außer unter |
enabledRegions[] |
Stellt die Regionen dar, in denen Nutzer deine Aktionen aufrufen können, basierend auf dem aktuellen Standort des Nutzers. Kann nicht festgelegt werden, wenn |
disabledRegions[] |
Gibt die Regionen an, in denen deine Aktionen auf Grundlage des Nutzerstandorts blockiert sind. Kann nicht festgelegt werden, wenn |
category |
Die Kategorie für dieses Actions-Projekt. |
usesTransactionsApi |
Gibt an, ob Aktionen Transaktionen verwenden können (z. B. Reservierungen vornehmen, Bestellungen annehmen usw.) Bei „false“ schlagen Versuche, die Transactions APIs zu verwenden, fehl. |
usesDigitalPurchaseApi |
Gibt an, ob Aktionen Transaktionen für digitale Waren ausführen können. |
usesInteractiveCanvas |
Gibt an, ob für Aktionen der interaktive Canvas verwendet wird. |
usesHomeStorage |
Gibt an, ob Aktionen die Speicherfunktion für zu Hause verwenden. |
designedForFamily |
Gibt an, ob der Aktionsinhalt familiengerecht ist (DFF) |
containsAlcoholOrTobaccoContent |
Gibt an, ob die Aktion Inhalte mit Bezug auf Alkohol oder Tabak enthält. |
keepsMicOpen |
Gibt an, ob das Mikrofon bei Aktionen während der Unterhaltung ohne ausdrückliche Aufforderung eingeschaltet bleiben darf. |
surfaceRequirements |
Die Oberflächenanforderungen, die eine Clientoberfläche unterstützen muss, um Aktionen in diesem Projekt aufzurufen. |
testingInstructions |
Testanleitungen im freien Format für den Prüfer von Aktionen (z. B. Anleitungen zur Kontoverknüpfung). |
localizedSettings |
Lokalisierte Einstellungen für die Standardsprache des Projekts. Für jede zusätzliche Sprache muss eine eigene Einstellungsdatei in einem eigenen Verzeichnis vorhanden sein. |
accountLinking |
Nutzern erlauben, über Google Log-in und/oder Ihren eigenen OAuth-Dienst Konten zu erstellen oder zu verknüpfen. |
selectedAndroidApps[] |
Android-Apps, die für den Zugriff auf Google Play-Käufe für Transaktionen ausgewählt sind. Dies ist eine Auswahl aus Android-Apps, die mit dem Aktionsprojekt 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 / nicht angegeben. |
BUSINESS_AND_FINANCE |
Wirtschaft und Finanzen fest. |
EDUCATION_AND_REFERENCE |
Kategorie „Bildung und Referenz“. |
FOOD_AND_DRINK |
in der Kategorie „Essen und Trinken“. |
GAMES_AND_TRIVIA |
Kategorie "Spiele" und "Quiz". |
HEALTH_AND_FITNESS |
Kategorie „Gesundheit und Fitness“. |
KIDS_AND_FAMILY |
Kinder und Familie. |
LIFESTYLE |
Lifestyle. |
LOCAL |
Lokale Kategorie. |
MOVIES_AND_TV |
Filme und Serien. |
MUSIC_AND_AUDIO |
in der Kategorie „Musik und Audio“. |
NEWS |
Nachrichtenkategorie, |
NOVELTY_AND_HUMOR |
Neuheiten und Humor. |
PRODUCTIVITY |
Produktivitätskategorie. |
SHOPPING |
Shopping-Kategorie. |
SOCIAL |
Soziale Kategorie: |
SPORTS |
Sport. |
TRAVEL_AND_TRANSPORTATION |
Reise- und Transportkategorie. |
UTILITIES |
Dienstprogramme. |
WEATHER |
Wetterkategorie. |
HOME_CONTROL |
Smart-Home-Steuerung. |
SurfaceRequirements
Enthält eine Reihe von Anforderungen, die die Client-Oberfläche unterstützen muss, um Aktionen in Ihrem Projekt aufzurufen.
JSON-Darstellung | |
---|---|
{
"minimumRequirements": [
{
object ( |
Felder | |
---|---|
minimumRequirements[] |
Die Mindestfunktionen, die zum Aufrufen der Aktionen in Ihrem Projekt erforderlich sind. Wenn auf der Oberfläche etwas davon fehlt, wird die Aktion nicht ausgelöst. |
CapabilityRequirement
Stellt eine Anforderung zur Verfügbarkeit einer bestimmten Funktion dar.
JSON-Darstellung | |
---|---|
{
"capability": enum ( |
Felder | |
---|---|
capability |
Die Art der Fähigkeit. |
SurfaceCapability
Möglicher Satz von Oberflächenfunktionen.
Enums | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Unbekannt / nicht angegeben. |
AUDIO_OUTPUT |
Surface unterstützt die Audioausgabe. |
SCREEN_OUTPUT |
Surface unterstützt Bildschirm- und visuelle Ausgabe. |
MEDIA_RESPONSE_AUDIO |
Surface unterstützt Audio von Medienantworten. |
WEB_BROWSER |
Surface unterstützt Webbrowser. |
ACCOUNT_LINKING |
Surface unterstützt die Kontoverknüpfung. |
INTERACTIVE_CANVAS |
„Oberfläche“ unterstützt „Interaktives Canvas“. |
HOME_STORAGE |
Surface unterstützt die Speicherung zu Hause. |
LocalizedSettings
Stellt die Einstellungen eines Actions-Projekts dar, die für die Sprache des Nutzers spezifisch sind. In diesem Fall bezeichnet Nutzer den Endnutzer, 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 ( |
Felder | |
---|---|
displayName |
Erforderlich. Der standardmäßige Anzeigename für dieses Actions-Projekt (falls keine Übersetzung verfügbar ist) |
pronunciation |
Erforderlich. Die Aussprache des Anzeigenamens, um ihn in einem Sprachkontext aufzurufen. |
shortDescription |
Erforderlich. Die standardmäßige Kurzbeschreibung für das Actions-Projekt (falls keine Übersetzung verfügbar ist). Maximal 80 Zeichen. |
fullDescription |
Erforderlich. Die standardmäßige lange Beschreibung für das Actions-Projekt (falls keine Übersetzung verfügbar ist). Maximal 4.000 Zeichen. |
smallLogoImage |
Erforderlich. Kleines quadratisches Bild (192 × 192 Pixel) Diese sollte als Verweis auf das entsprechende Bild im Verzeichnis |
largeBannerImage |
Optional. Großes Bild im Querformat (1.920 x 1.080 Pixel) Diese sollte als Verweis auf das entsprechende Bild im Verzeichnis |
developerName |
Erforderlich. Der Name des Entwicklers, der den Nutzern angezeigt wird. |
developerEmail |
Erforderlich. Die Kontakt-E-Mail-Adresse des Entwicklers. |
termsOfServiceUrl |
Optional. Die URL für die Nutzungsbedingungen. |
voice |
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 |
Optional. Sprache für die angegebene Stimme. Wenn keine Angabe erfolgt, wird dies in die Assistant-Sprache des Nutzers aufgelöst. Falls angegeben, muss das Gebietsschema für die Sprache dieselbe natürliche Sprache haben wie das in LocalizedSettings angegebene Gebietsschema. |
privacyPolicyUrl |
Erforderlich. Die URL der Datenschutzerklärung. |
sampleInvocations[] |
Optional. Beispiele für Aufrufsätze, die als Teil der Beschreibung Ihres Actions-Projekts im Assistant-Verzeichnis angezeigt werden. So lernen die Nutzenden, wie sie verwendet werden. |
themeCustomization |
Optional. Designanpassungen für visuelle Komponenten deiner Aktionen. |
ThemeCustomization
Stile, die auf Karten angewendet werden, die Nutzern präsentiert werden
JSON-Darstellung | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Felder | |
---|---|
backgroundColor |
Hintergrundfarbe von Karten. Fungiert als Fallback, wenn |
primaryColor |
Die Farbe des primären Designs der Aktion wird verwendet, um die Textfarbe des Titels und die Hintergrundfarbe der Aufgabe für Actions on Google-Karten festzulegen. Verwendungsbeispiel: #FAFAFA |
fontFamily |
Die Schriftfamilie, die für den Titel von Karten verwendet wird. Unterstützte Schriftarten: - Sans Serif - Sans Serif Medium - Sans Serif Fett - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Fett - Monospace - Cursiv - Sans Serif Smallcaps |
imageCornerStyle |
Rahmenstil des Vordergrundbilds von Karten. Sie kann beispielsweise auf das Vordergrundbild einer einfachen Karte oder Karussellkarte angewendet werden. |
landscapeBackgroundImage |
Querformat (mindestens 1.920 × 1.200 Pixel) Diese sollte als Verweis auf das entsprechende Bild im Verzeichnis |
portraitBackgroundImage |
Hochformat (mindestens 1.200 × 1.920 Pixel) Diese sollte als Verweis auf das entsprechende Bild im Verzeichnis |
ImageCornerStyle
Beschreibt, wie die Ränder von Bildern gerendert werden sollen.
Enums | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
Nicht definiert / nicht angegeben. |
CURVED |
Runde Ecke für Bild. |
ANGLED |
Rechteckige Ecke für Bild. |
AccountLinking
Mit der Kontoverknüpfung kann Google den Nutzer anweisen, sich in den Webdiensten der App anzumelden.
Für die Verknüpfungstypen „Google Log-in“ und „OAuth + Google Log-in“ generiert Google eine Client-ID, mit der Ihre App gegenüber Google identifiziert wird („Client-ID, die von Google für Ihre Aktionen vergeben wird“ in der Benutzeroberfläche der Console). Dieses Feld ist schreibgeschützt und kann in der Cloud Console auf der Seite „Kontoverknüpfung“ angezeigt werden. Weitere Informationen: https://developers.google.com/assistant/identity/google-sign-in
Hinweis: Für alle Einstellungen zur Kontoverknüpfung (mit Ausnahme von 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. Sie sind für Nutzer nicht sichtbar.
JSON-Darstellung | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Felder | |
---|---|
enableAccountCreation |
Erforderlich. Wenn |
linkingType |
Erforderlich. Der zu verwendende Verknüpfungstyp. Weitere Informationen zu den Verknüpfungstypen findest du unter https://developers.google.com/assistant/identity. |
authGrantType |
Optional. Gibt den Authentifizierungstyp für OAUTH LinkingType an |
appClientId |
Optional. Client-ID, die von Ihrer App an Google vergeben wird. Dies ist die OAuth2-Client-ID, mit der Google deinem Dienst identifiziert wird. Wird nur bei Verwendung von OAuth festgelegt. |
authorizationUrl |
Optional. Endpunkt für deine Anmeldewebseite, der OAuth2-Code oder implizite Abläufe unterstützt. URL muss HTTPS verwenden. Wird nur bei Verwendung von OAuth festgelegt. |
tokenUrl |
Optional. OAuth2-Endpunkt für Tokenaustausch. URL muss HTTPS verwenden. Diese Einstellung ist nicht festgelegt, wenn nur OAuth mit IMPLICIT-Berechtigung als Verknüpfungstyp verwendet wird. Wird nur bei Verwendung von OAuth festgelegt. |
scopes[] |
Optional. Liste der Berechtigungen, denen der Nutzer zustimmen muss, um Ihren Dienst nutzen zu können. Wird nur bei Verwendung von OAuth festgelegt. Geben Sie in den Verzeichnisinformationen im Abschnitt „LocalizedSettings.terms_of_service_url“ Nutzungsbedingungen an, wenn Sie dieses Feld angeben. |
learnMoreUrl |
Optional. Dies ist die Webseite in Ihrem Dienst, auf der die Berechtigungen beschrieben werden, die der Nutzer Google gewährt. Nur festgelegt, wenn OAuth und Google Log-in verwendet werden. Geben Sie in den Verzeichnisinformationen im Abschnitt „LocalizedSettings.terms_of_service_url“ Nutzungsbedingungen an, wenn Sie dieses Feld angeben. |
useBasicAuthHeader |
Optional. Wenn „true“ festgelegt ist, darf Google die Client-ID und das Secret über den HTTP-Header „Basic Auth“ übertragen. Andernfalls verwendet Google die Client-ID und das Secret im Beitragstext. Wird nur bei Verwendung von OAuth festgelegt. Geben Sie in den Verzeichnisinformationen im Abschnitt „LocalizedSettings.terms_of_service_url“ Nutzungsbedingungen an, wenn Sie dieses Feld angeben. |
LinkingType
Die Art der durchzufü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 |
Verknüpfungstyp von OAuth und Google Log-in |
OAUTH |
OAuth-Verknüpfungstyp. |
AuthGrantType
Der OAuth2-Genehmigungstyp, den Google verwendet, um den Nutzer anzuweisen, sich im Webdienst Ihrer App anzumelden.
Enums | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
Nicht angegeben |
AUTH_CODE |
Autorisierungscode-Zuweisung. Erfordert die Angabe der Authentifizierungs-URL und der Zugriffstoken-URL. |
IMPLICIT |
Implizite Codezuweisung. 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 eine Codestruktur wie diese: – /webhooks/my_webhook.yaml
– /webhooks/my_webhook/index.js
– /webhooks/my_webhook/package.json
JSON-Darstellung | |
---|---|
{ "handlers": [ { object ( |
Felder | ||
---|---|---|
handlers[] |
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 |
Benutzerdefinierter Webhook-HTTPS-Endpunkt. |
|
inlineCloudFunction |
Metadaten für Cloud Functions, die aus Code im Webhook-Ordner bereitgestellt werden. |
Handler
Deklariert den Namen des Webhook-Handlers. Für einen Webhook können mehrere Handler registriert sein. Diese Handler können von verschiedenen Stellen in Ihrem Actions-Projekt aus aufgerufen werden.
JSON-Darstellung | |
---|---|
{ "name": string } |
Felder | |
---|---|
name |
Erforderlich. Name des Handlers. Muss für alle Handler im Actions-Projekt eindeutig sein. Sie können den Namen dieses Handlers prüfen, um die richtige Funktion im Quellcode der Auftragsausführung aufzurufen. |
HttpsEndpoint
REST-Endpunkt, um eine Benachrichtigung zu senden, wenn Sie nicht den Inline-Editor verwenden.
JSON-Darstellung | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Felder | |
---|---|
baseUrl |
Die HTTPS-Basis-URL des Endpunkts der Auftragsausführung (HTTP wird nicht unterstützt). Handler-Namen werden nach einem Doppelpunkt an den Basis-URL-Pfad angehängt (gemäß dem Styleguide unter https://cloud.google.com/apis/design/custom_methods). Beispielsweise würde die Basis-URL „https://gactions.service.com/api“ Anfragen mit der URL „https://gactions.service.com/api:{method}“ empfangen. |
httpHeaders |
Zuordnung der HTTP-Parameter, die in die POST-Anfrage aufgenommen werden sollen. Ein Objekt, das eine Liste von |
endpointApiVersion |
Version des Protokolls, das vom Endpunkt verwendet wird. Dies ist das Protokoll, das von allen Auftragsausführungstypen verwendet wird, und ist nicht spezifisch für den Google-Auftragsausführungstyp. |
InlineCloudFunction
Enthält die Metadaten einer Cloud Functions-Inline-Funktion, die aus dem Webhook-Ordner bereitgestellt wurde.
JSON-Darstellung | |
---|---|
{ "executeFunction": string } |
Felder | |
---|---|
executeFunction |
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 über Natural Language Understanding (NLU) von Google 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 ( |
Felder | |
---|---|
parameters[] |
Die Liste der Parameter in den Trainingsformulierungen. Alle Parameter müssen hier definiert werden, um in der Trainingsformulierung verwendet zu werden. |
trainingPhrases[] |
Mithilfe von Trainingsformulierungen kann die NLU von Google Intents automatisch der Nutzereingabe zuordnen. Je mehr eindeutige Wortgruppen angegeben werden, desto höher ist die Wahrscheinlichkeit, dass dieser Intent zugeordnet wird. Im Folgenden sehen Sie das Format für Trainingsformulierungen, die annotiert sind. Das Feld |
IntentParameter
Definition eines Parameters, der in Trainingsformulierungen verwendet werden kann.
JSON-Darstellung | |
---|---|
{ "name": string, // Union field |
Felder | ||
---|---|---|
name |
Erforderlich. Eindeutiger Name des Intent-Parameters. Kann in Bedingungen und Antworten verwendet werden, um auf Intent-Parameter zu verweisen, die von NLU mit $intent.params.[name].resolved extrahiert werden. |
|
Union-Feld parameter_type . Der Typ des Intent-Parameters. Für parameter_type ist nur einer der folgenden Werte zulässig: |
||
type |
Optional. Deklariert den Datentyp dieses Parameters. Bei integrierten Intents sollte dies nicht festgelegt werden. |
|
entitySetReferences |
Optional. Verweise auf die Gruppen zulässiger Entitäten für diesen Intent-Parameter. Nur gültig für Parameter eines integrierten Intents. Diese Verweise verweisen auf Entitäts-Sets im Verzeichnis „custom/entitySets“. |
ClassReference
Ein Verweis auf eine Klasse, mit dem der Typ eines Felds oder Rückgabewerts deklariert wird. Enums sind ebenfalls ein Klassentyp, auf den mithilfe von ClassReference verwiesen werden kann.
JSON-Darstellung | |
---|---|
{ "name": string, "list": boolean } |
Felder | |
---|---|
name |
Erforderlich. Name eines integrierten oder benutzerdefinierten Typs des Parameters. Beispiele: |
list |
Optional. Gibt an, ob der Datentyp eine Liste von Werten darstellt. |
EntitySetReferences
Entitäts-Set-Verweise für einen Intent-Parameter.
JSON-Darstellung | |
---|---|
{
"entitySetReferences": [
{
object ( |
Felder | |
---|---|
entitySetReferences[] |
Erforderlich. Entitäts-Set-Verweise 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 |
Erforderlich. Gibt die spezifische Sammlung von Entitäten an, die für einen bestimmten Parameter in Betracht gezogen werden sollen. Die entsprechende Entitäts-Set-Definition sollte im Verzeichnis „custom/entitySets/“ vorhanden sein. |
Typ
Deklarierung eines benutzerdefinierten Typs im Gegensatz zu integrierten Typen. Typen können Slots in einer Szene oder Parametern der Trainingsformulierungen eines Intents zugewiesen werden. Typen können sich in der Praxis als Enums vorstellen. Hinweis: Der Typname wird im Dateinamen angegeben.
JSON-Darstellung | |
---|---|
{ "exclusions": [ string ], // Union field |
Felder | ||
---|---|---|
exclusions[] |
Eine Reihe außergewöhnlicher Wörter/Wortgruppen, die nicht nach Typ gefunden werden sollten. Hinweis: Wenn das Wort bzw. die Wortgruppe mit dem Typ übereinstimmt, aber als Ausschluss aufgeführt wird, wird sie im Ergebnis der Parameterextraktion nicht zurückgegeben. Dieses Feld kann lokalisiert werden. |
|
Union-Feld sub_type . Auswahl des Untertyps basierend auf dem Typ der durchzuführenden Zuordnung. Für sub_type ist nur einer der folgenden Werte zulässig: |
||
synonym |
Synonymtyp, bei dem es sich im Wesentlichen um eine Enum handelt. |
|
regularExpression |
Regex-Typ, ermöglicht den Abgleich regulärer Ausdrücke. |
|
freeText |
FreeText-Typ. |
SynonymType
Geben Sie ein, das Text mithilfe von Synonymen abgleicht.
JSON-Darstellung | |
---|---|
{ "matchType": enum ( |
Felder | |
---|---|
matchType |
Optional. Die Keyword-Option für das Synonym. |
acceptUnknownValues |
Optional. Wenn die Richtlinie auf „true“ gesetzt ist, werden unbekannte Wörter oder Wortgruppen anhand von umgebenden Eingabe- und Intent-Trainingsdaten abgeglichen, z. B. Artikel, die einer Einkaufsliste hinzugefügt werden könnten. |
entities |
Erforderlich. Benannte Karte von Synonymentitäten Ein Objekt, das eine Liste von |
MatchType
Der Übereinstimmungstyp, der bei Einträgen in diesem Typ verwendet wird. Dadurch wird sichergestellt, dass alle Typen die gleiche Abgleichsmethode verwenden und eine Variation des Abgleichs für den Synonymabgleich (d.h. ungenau oder genau) möglich ist. 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 . Es wird sowohl nach ähnlichen als auch nach genauen Übereinstimmungen gesucht. |
Entität
Stellt ein Synonymentitätsfeld dar, das die Details eines einzelnen Eintrags innerhalb des Typs enthält.
JSON-Darstellung | |
---|---|
{
"display": {
object ( |
Felder | |
---|---|
display |
Optional. Die Anzeigedetails der Entität. |
synonyms[] |
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 |
Optional. Titel des Symbols. |
iconUrl |
Erforderlich. URL des Symbols. |
RegularExpressionType
Geben Sie einen Text ein, der mit regulären Ausdrücken abgleicht. Diese Nachricht kann lokalisiert werden.
JSON-Darstellung | |
---|---|
{
"entities": {
string: {
object ( |
Felder | |
---|---|
entities |
Erforderlich. Benannte Zuordnung von Entitäten, die jeweils Regex-Strings enthalten. Ein Objekt, das eine Liste von |
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 ( |
Felder | |
---|---|
display |
Optional. Elemente, die auf dem Canvas angezeigt werden, nachdem eine Entität aus einer Abfrage extrahiert wurde. Nur für Canvas-fähige Apps relevant. |
regularExpressions[] |
Erforderlich. Verwendet RE2-Regex-Syntax (weitere Informationen unter https://github.com/google/re2/wiki/Syntax) |
FreeTextType
Geben Sie Text ein, der mit einem beliebigen Text übereinstimmt, wenn der Kontext der umgebenden Wörter nahe an den bereitgestellten Trainingsbeispielen liegt.
JSON-Darstellung | |
---|---|
{
"display": {
object ( |
Felder | |
---|---|
display |
Optional. Elemente, die auf dem Canvas angezeigt werden, nachdem eine Entität 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 in integrierten Intent-Parametern von entitySet verwiesen werden.
JSON-Darstellung | |
---|---|
{
"entities": [
{
object ( |
Felder | |
---|---|
entities[] |
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 |
Erforderlich. 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 dürfen innerhalb eines Actions-Projekts nur einmal vorkommen.
Globale Intents können während einer Sitzung jederzeit zugeordnet werden, sodass Nutzer auf gängige Abläufe wie „Hilfe erhalten“ oder „Zurück zur Startseite“ zugreifen können. Sie können auch verwendet werden, um Nutzer per Deeplink zu bestimmten Abläufen zu leiten, wenn sie eine Aktion aufrufen.
Hinweis: Der Intent-Name wird im Namen der Datei angegeben.
JSON-Darstellung | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Felder | |
---|---|
transitionToScene |
Optional. Zielszene, zu der die Unterhaltung springen soll. Der Status der aktuellen Szene wird beim Übergang gelöscht. |
handler |
Optional. Event-Handler, der ausgelöst wird, wenn der Intent zugeordnet wird. Sollte vor dem Übergang zur Zielszene ausgeführt werden. Nützlich, um als Reaktion auf Ereignisse Aufforderungen 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 |
Felder | ||
---|---|---|
webhookHandler |
Name des aufzurufenden Webhook-Handlers. |
|
Union-Feld prompt . Aufforderungen können entweder inline eingefügt oder durch den Namen referenziert werden. Für prompt ist nur einer der folgenden Werte zulässig: |
||
staticPrompt |
Inline-Anzeige mit statischer Aufforderung Kann Verweise auf Stringressourcen in Bundles enthalten. |
|
staticPromptName |
Name der statischen Aufforderung, die aufgerufen werden soll. |
StaticPrompt
Stellt eine Liste mit Vorschlagskandidaten dar. Eine davon wird als Aufforderung ausgewählt, die dem Nutzer in der Antwort angezeigt wird. Diese Nachricht kann lokalisiert werden.
JSON-Darstellung | |
---|---|
{
"candidates": [
{
object ( |
Felder | |
---|---|
candidates[] |
Die Liste der möglichen Eingabeaufforderungen, die an den Client gesendet werden sollen. Für jeden Prompt gibt es eine Auswahl, mit der festgelegt wird, wann er verwendet werden kann. Der erste Selector, der einer Anfrage entspricht, wird gesendet. Der Rest wird ignoriert. |
StaticPromptCandidate
Stellt einen statischen Prompt-Kandidaten dar.
JSON-Darstellung | |
---|---|
{ "selector": { object ( |
Felder | |
---|---|
selector |
Optional. Die Kriterien dafür, ob diese Aufforderung einer Anfrage entspricht. Wenn die Auswahl leer ist, wird diese Eingabeaufforderung immer ausgelöst. |
promptResponse |
Die mit der Auswahl verknüpfte Eingabeaufforderung. |
Selector
Definiert die Kriterien dafür, ob eine Aufforderung mit einer Anfrage übereinstimmt.
JSON-Darstellung | |
---|---|
{
"surfaceCapabilities": {
object ( |
Felder | |
---|---|
surfaceCapabilities |
Die erforderlichen Oberflächenfunktionen. |
SurfaceCapabilities
Stellt die Oberfläche dar, die der Nutzer für eine Anfrage an die Aktion verwendet.
JSON-Darstellung | |
---|---|
{
"capabilities": [
enum ( |
Felder | |
---|---|
capabilities[] |
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 |
Nicht angegebene Oberflächenkapazität. |
SPEECH |
Das Gerät kann über Sprachausgabe oder SSML mit dem Nutzer sprechen. |
RICH_RESPONSE |
Auf dem Gerät können aussagekräftige Antworten wie Karten, Listen und Tabellen angezeigt werden. |
LONG_FORM_AUDIO |
Auf dem Gerät können auch lange Audiomedien wie Musik und Podcasts abgespielt werden. |
INTERACTIVE_CANVAS |
Das Gerät kann eine interaktive Canvas-Antwort anzeigen. |
WEB_LINK |
Auf dem Gerät können Weblinks in Rich-Antworten verwendet werden, um einen Webbrowser zu öffnen. |
HOME_STORAGE |
Das Gerät unterstützt das Speichern und Abrufen von Speicherplatz für dein Zuhause. |
StaticPromptResponse
Stellt strukturierte Antworten dar, die an den Nutzer gesendet werden, z. B. Text, Sprache, Karten, Canvas-Daten oder Vorschlags-Chips.
JSON-Darstellung | |
---|---|
{ "firstSimple": { object ( |
Felder | |
---|---|
firstSimple |
Optional. Die erste Sprach- und Textantwort. |
content |
Optional. Dem Nutzer angezeigte Inhalte wie Karten, Listen oder Medien. |
lastSimple |
Optional. Die letzte Antwort per Sprach- oder Texteingabe. |
suggestions[] |
Optional. Vorschläge, die dem Nutzer immer am Ende der Antwort angezeigt werden. Wenn das Feld |
link |
Optional. Ein zusätzlicher Vorschlags-Chip, der auf die verknüpfte App oder Website verweist. Der Chip wird mit dem Titel „Öffnen |
override |
Optional. Modus für die Zusammenführung dieser Nachrichten mit zuvor definierten Nachrichten. |
canvas |
Eine Antwort, die für die interaktive Canvas-Nutzung verwendet werden soll. |
StaticSimplePrompt
Stellt eine einfache Aufforderung dar, die an einen Nutzer gesendet werden soll.
JSON-Darstellung | |
---|---|
{
"variants": [
{
object ( |
Felder | |
---|---|
variants[] |
Liste der möglichen Varianten. |
Variante
Stellt eine Variante dar, die Teil der einfachen Aufforderung ist.
JSON-Darstellung | |
---|---|
{ "speech": string, "text": string } |
Felder | |
---|---|
speech |
Optional. Stellt die Sprache dar, die für den Nutzer gesprochen wird. Kann SSML oder Text-to-Speech sein. Standardmäßig wird Sprache an die Sprachausgabe des vorherigen einfachen Prompts angehängt. Wenn das Feld |
text |
Optional. Text, der im Infofeld des Chats angezeigt wird. Wenn nicht angegeben, wird das obige Sprachfeld angezeigt. Auf 640 Zeichen begrenzt. Standardmäßig wird Text an den Text der vorherigen einfachen Aufforderung angehängt. Wenn das Feld |
StaticContentPrompt
Ein Platzhalter für den Content-Teil eines StaticPrompt.
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld content . In einer Aufforderung darf nur ein Inhaltstyp enthalten sein. Für content ist nur einer der folgenden Werte zulässig: |
||
card |
Eine einfache Karte. |
|
image |
Ein Bild. |
|
table |
Tabellenkarte. |
|
media |
Antwort, die eine Reihe von Medien angibt, die wiedergegeben werden sollen. |
|
list |
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann. |
|
collection |
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann. |
|
collectionBrowse |
Eine Karte mit mehreren Webseiten, die geöffnet werden sollen. |
StaticCardPrompt
Eine einfache Karte zur Anzeige einiger Informationen, z.B. ein Bild und/oder Text.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Felder | |
---|---|
title |
Optional. Gesamttitel der Karte. |
subtitle |
Optional. Untertitel der Karte. |
text |
Erforderlich. Text der Karte, der benötigt wird, sofern kein Bild vorhanden ist Unterstützt eine begrenzte Anzahl von Markdown-Syntax für die Formatierung. |
image |
Optional. Ein Hero-Image für die Karte. Die Höhe ist auf 192 dp festgelegt. |
imageFill |
Optional. Legt fest, wie der Bildhintergrund ausgefüllt wird. |
button |
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 |
Erforderlich. Die Quell-URL des Bildes. Bilder können das Format JPG, PNG und GIF haben (animiert und nicht animiert). Beispiel: |
alt |
Erforderlich. Eine Textbeschreibung des Bildes, die für Barrierefreiheit verwendet werden soll, z.B. Screenreader. |
height |
Optional. Die Höhe des Bilds in Pixeln |
width |
Optional. Die Breite des Bilds in Pixeln |
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 |
ImageFill nicht angegeben. |
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. |
StaticLinkPrompt
Definiert einen Link, der als Vorschlags-Chip angezeigt wird und vom Nutzer geöffnet werden kann.
JSON-Darstellung | |
---|---|
{
"name": string,
"open": {
object ( |
Felder | |
---|---|
name |
Name des Links |
open |
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 ( |
Felder | |
---|---|
url |
Das URL-Feld, das einen der folgenden Werte annehmen kann: – HTTP- oder HTTPS-URLs zum Öffnen einer mit der App verknüpften App oder einer Webseite |
hint |
Gibt einen Hinweis für den URL-Typ an. |
UrlHint
Verschiedene Arten von URL-Hinweisen.
Enums | |
---|---|
HINT_UNSPECIFIED |
Ohne Angabe |
AMP |
URL, die direkt auf AMP-Inhalte verweist, oder auf eine kanonische URL, 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 ( |
Felder | |
---|---|
title |
Optional. Gesamttitel der Tabelle. Muss festgelegt werden, wenn Untertitel festgelegt sind. |
subtitle |
Optional. Untertitel für die Tabelle. |
image |
Optional. Mit der Tabelle verknüpftes Bild. |
columns[] |
Optional. Überschriften und Spaltenausrichtung. |
rows[] |
Optional. 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 |
button |
Optional. Schaltfläche. |
TableColumn
Beschreibt eine Spalte in der Tabelle.
JSON-Darstellung | |
---|---|
{
"header": string,
"align": enum ( |
Felder | |
---|---|
header |
Überschrift der Spalte. |
align |
Horizontale Ausrichtung des Inhalts in der Spalte „Richtig“. Wenn kein Wert angegeben ist, wird der Inhalt an der obersten Kante ausgerichtet. |
HorizontalAlignment
Die Ausrichtung des Inhalts innerhalb der Zelle.
Enums | |
---|---|
UNSPECIFIED |
Horizontale Ausrichtung nicht angegeben. |
LEADING |
Führende Kante der Zelle Das ist die Standardeinstellung. |
CENTER |
Der Inhalt ist an der Spaltenmitte ausgerichtet. |
TRAILING |
Der Inhalt ist am unteren Rand der Spalte ausgerichtet. |
TableRow
Beschreibt eine Zeile in der Tabelle.
JSON-Darstellung | |
---|---|
{
"cells": [
{
object ( |
Felder | |
---|---|
cells[] |
Zellen in dieser Zeile. Die ersten 3 Zellen werden garantiert angezeigt, andere werden jedoch möglicherweise auf bestimmten Oberflächen ausgeschnitten. Testen Sie mit dem Simulator, welche Zellen für eine bestimmte Oberfläche angezeigt werden. |
divider |
Gibt an, ob nach jeder Zeile eine Trennlinie eingefügt werden soll. |
TableCell
Beschreibt eine Zelle in einer Zeile.
JSON-Darstellung | |
---|---|
{ "text": string } |
Felder | |
---|---|
text |
Textinhalt der Zelle |
StaticMediaPrompt
Enthält Informationen zum Medium, z. B. Name, Beschreibung und URL. Nächste ID: 11
JSON-Darstellung | |
---|---|
{ "mediaType": enum ( |
Felder | |
---|---|
mediaType |
Medientyp dieser Antwort. |
startOffset |
Startversatz des ersten Medienobjekts. Dauer in Sekunden mit bis zu neun Nachkommastellen und einem ' |
optionalMediaControls[] |
Optionale Arten der Mediensteuerung, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, erfolgt bei einem bestimmten Medienereignis die Anfrage an 15:00 Uhr. Wenn die Richtlinie nicht konfiguriert ist, muss Drittanbieter immer noch zwei Standardsteuerungstypen verarbeiten: FINISHED und FAILED. |
mediaObjects[] |
Liste der Medienobjekte. |
repeatMode |
Wiederholungsmodus für die Liste der Medienobjekte. |
MediaType
Medientyp dieser Antwort.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
UNANGEGEBENER Wert |
AUDIO |
Audiodatei. |
MEDIA_STATUS_ACK |
Antwort zur Bestätigung eines Medienstatusberichts. |
OptionalMediaControls
Typen der Mediensteuerelemente, die die Medienantworten optional unterstützen können
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 Drittanbietersitzung während der Medienwiedergabe beendet. |
MediaObject
Stellt ein einzelnes Medienobjekt dar.
JSON-Darstellung | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Felder | |
---|---|
name |
Name dieses Medienobjekts. |
description |
Beschreibung dieses Medienobjekts. |
url |
Die URL, die auf den Medieninhalt verweist |
image |
Bild, das mit der Medienkarte angezeigt wird. |
MediaImage
Bild, das in einem MediaPrompt angezeigt wird
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld image . Es ist nur ein MediaImage-Typ zulässig. Für image ist nur einer der folgenden Werte zulässig: |
||
large |
Ein großes Bild wie das Cover des Albums usw. |
|
icon |
Ein kleines Bildsymbol, das rechts neben dem Titel angezeigt wird. Die Größe wird auf 36 × 36 dp angepasst. |
RepeatMode
Die Typen des Wiederholungsmodus für eine Liste von Medienobjekten.
Enums | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Entspricht AUS. |
OFF |
Mediensitzung am Ende des letzten Medienobjekts beenden. |
ALL |
Schleife zum Anfang des ersten Medienobjekts, wenn das Ende des letzten Medienobjekts erreicht ist. |
StaticListPrompt
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann.
JSON-Darstellung | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Felder | |
---|---|
title |
Optional. Titel der Liste. |
subtitle |
Optional. Untertitel der Liste. |
items[] |
Erforderlich. Listenelemente. |
ListItem
Ein Element in der Liste.
JSON-Darstellung | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Felder | |
---|---|
key |
Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Zugangscodes im zugehörigen Typ übereinstimmt. Wenn auf das Element getippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben. |
title |
Erforderlich. Titel des Artikels Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Elementgruppe eindeutig sein. |
description |
Optional. Text des Elements. |
image |
Optional. Bild des Artikels. |
StaticCollectionPrompt
Eine Karte mit einer Reihe von Optionen, aus denen ausgewählt werden kann.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Felder | |
---|---|
title |
Optional. Titel der Sammlung |
subtitle |
Optional. Untertitel der Sammlung |
items[] |
Erforderlich. Sammlungselemente. |
imageFill |
Optional. Art der Bildanzeigeoption. |
CollectionItem
Ein Element in der Sammlung.
JSON-Darstellung | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Felder | |
---|---|
key |
Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Zugangscodes im verknüpften Typ übereinstimmt. Wenn auf das Element getippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben. |
title |
Erforderlich. Titel des Artikels Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Elementgruppe eindeutig sein. |
description |
Optional. Text des Elements. |
image |
Optional. Bild des Artikels. |
StaticCollectionBrowsePrompt
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.
JSON-Darstellung | |
---|---|
{ "items": [ { object ( |
Felder | |
---|---|
items[] |
Elemente in der Sammlung „Stöbern“. Die Listengröße sollte im Bereich [2, 10] liegen. |
imageFill |
Anzeigeoption für Bilder in der Sammlung |
CollectionBrowseItem
Element in der Sammlung.
JSON-Darstellung | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Felder | |
---|---|
title |
Erforderlich. Titel des Sammlungselements |
description |
Beschreibung des Sammlungselements |
footer |
Fußzeilentext für das Sammlungselement, angezeigt unter der Beschreibung. Einzelne Textzeile, durch Auslassungspunkte abgeschnitten. |
image |
Bild für das Sammlungselement. |
openUriAction |
Erforderlich. URI, der geöffnet werden soll, wenn das Element ausgewählt wurde. |
Vorschlag
Stellt einen Vorschlags-Chip dar. Dies ist ein UI-Element, das dem Nutzer der Einfachheit halber angezeigt wird.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Erforderlich. Der Text im Vorschlags-Chip. Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel darf unter den Vorschlags-Chips nur einmal vorkommen. Maximal 25 Zeichen |
StaticCanvasPrompt
Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. Dies kann in Verbindung 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.
JSON-Darstellung | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
Felder | |
---|---|
url |
Erforderlich. URL der zu ladenden Webansicht. |
data[] |
Optional. JSON-Daten, die als Ereignis an die Webseite mit dem immersiven Erlebnis übergeben werden. Wenn das Feld |
suppressMic |
Optional. Der Wert „true“ bedeutet, dass das Mikrofon nicht mehr geöffnet wird, um Eingaben zu erfassen, nachdem dem Nutzer diese umfassende Antwort präsentiert wurde. |
sendStateDataToCanvasApp |
Optional. Wenn |
enableFullScreen |
Optional. Bei |
Ambiente
Die Szene ist die grundlegende Einheit des Steuerungsablaufs beim Entwerfen einer Unterhaltung. Sie können mit anderen Szenen verkettet werden, Prompts für den Endnutzer generieren und Slots definieren. Der Szenenname wird im Namen der Datei angegeben.
JSON-Darstellung | |
---|---|
{ "onEnter": { object ( |
Felder | |
---|---|
onEnter |
Handler, der beim Übergang zu dieser Szene aufgerufen werden soll. |
intentEvents[] |
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 Intents, die auf diese Szene beschränkt sind. Sie haben Vorrang vor allen global definierten Ereignissen, die dieselben Intents oder ihre auslösenden Wortgruppen haben. Intent-Namen müssen innerhalb einer Szene eindeutig sein. |
conditionalEvents[] |
Die Liste der Ereignisse, die basierend auf bedingten Anweisungen ausgelöst werden sollen. Sie werden ausgewertet, nachdem das Formular ausgefüllt wurde, oder direkt nach on_load, wenn in dieser Szene kein Formular vorhanden ist (die Auswertung wird nur einmal durchgeführt). Nur das erste übereinstimmende Ereignis wird ausgelöst. |
slots[] |
Sortierte Liste der Slots. Jeder Slot definiert den Typ der aufzulösenden Daten und die Konfiguration, um die Darstellung dieser Auflösung (z.B. Aufforderungen) anzupassen. |
onSlotUpdated |
Handler wird aufgerufen, wenn sich der Status eines Slots ändert, der nicht durch Aktualisierungen innerhalb eines anderen Handlers verursacht wird. Dadurch können Slots entwertet, die Szene entwertet oder andere Änderungen am Szenenstatus vorgenommen werden. |
IntentEvent
Registriert Ereignisse, die als Ergebnis eines Intent-Abgleichs ausgelöst werden.
JSON-Darstellung | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Felder | |
---|---|
intent |
Erforderlich. Intent, der das Ereignis auslöst. |
transitionToScene |
Optional. Zielszene, zu der die Unterhaltung springen soll. Der Status der aktuellen Szene wird beim Übergang gelöscht. |
handler |
Optional. Event-Handler, der ausgelöst wird, wenn der Intent zugeordnet wird. Sollte vor dem Übergang zur Zielszene ausgeführt werden. Nützlich, um als Reaktion auf Ereignisse Prompts zu generieren. |
ConditionalEvent
Registriert Ereignisse, die als Ergebnis einer wahren Bedingung ausgelöst werden.
JSON-Darstellung | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Felder | |
---|---|
condition |
Erforderlich. Filterbedingung für das Ereignis, das ausgelöst werden soll. Wenn die Bedingung als „true“ ausgewertet wird, wird das zugehörige |
transitionToScene |
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 |
Optional. Event-Handler, der ausgelöst wird, wenn die zugehörige Bedingung als |
Slot
Konfiguration für einen Slot. Slots sind einzelne Dateneinheiten, die durch natürliche Sprache (z. B. Intent-Parameter), Sitzungsparameter und andere Quellen gefüllt werden können.
JSON-Darstellung | |
---|---|
{ "name": string, "type": { object ( |
Felder | |
---|---|
name |
Erforderlich. Name der Anzeigenfläche. |
type |
Erforderlich. Deklariert den Datentyp dieses Slots. |
required |
Optional. Gibt an, ob die Anzeigenfläche gefüllt werden muss, bevor die Anzeige fortgesetzt wird. Nicht gefüllte Anzeigenflächen lösen eine anpassbare Aufforderung für den Nutzer aus. |
promptSettings |
Optional. Registriert Aufforderungen für verschiedene Phasen der Slot-Füllung. |
commitBehavior |
Optional. Mit dem Slot verknüpftes Commit-Verhalten. |
config |
Optional. Zusätzliche mit der Anzeigenfläche verknüpfte Konfiguration, die zum Füllen der Anzeigenfläche verwendet wird. Das Format der Konfiguration richtet sich nach dem Slottyp. Dieser Konfiguration können Ressourcenverweise auf Nutzer- oder Sitzungsparameter hinzugefügt werden. Diese Konfiguration wird zum Füllen von Slots im Zusammenhang mit Transaktionen und Nutzerinteraktionen benötigt. Beispiel: Für einen Slot vom Typ actions.type.CompletePurchaseValue wird mit der folgenden Konfiguration eine digitale Ware mit einem Verweis auf den clientseitigen Sitzungsparameter { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } } |
defaultValue |
Optional. Konfiguration zum Ausfüllen eines Standardwerts für diesen Slot. |
PromptSettings
Ein zentraler Ort, an dem Slot-Aufforderungen definiert werden.
JSON-Darstellung | |
---|---|
{ "initialPrompt": { object ( |
Felder | |
---|---|
initialPrompt |
Geben Sie den Slotwert selbst ein. Beispiel: „Welche Größe möchtest du?“ |
noMatchPrompt1 |
Aufforderung zur Ausgabe, wenn die Eingabe des Nutzers zum ersten Mal nicht mit dem erwarteten Werttyp für die Anzeigenfläche übereinstimmt. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“ |
noMatchPrompt2 |
Aufforderung zur Ausgabe, 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 |
Aufforderung zur Ausgabe, wenn die Eingabe des Nutzers beim letzten Mal nicht mit dem erwarteten Werttyp für den Slot übereinstimmt. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“ |
noInputPrompt1 |
Aufforderung zu geben, wenn der Nutzer zum ersten Mal keine Eingabe vornimmt. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“ |
noInputPrompt2 |
Aufforderung zur Ausgabe, wenn der Nutzer zum zweiten Mal keine Eingabe abgibt. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“ |
noInputFinalPrompt |
Aufforderung zu geben, wenn der Nutzer zum letzten Mal keine Eingabe gegeben hat. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“ |
CommitBehavior
Meldung, die das Commit-Verhalten beschreibt, das mit dem Slot verknüpft ist, nachdem er erfolgreich gefüllt wurde.
JSON-Darstellung | |
---|---|
{ "writeSessionParam": string } |
Felder | |
---|---|
writeSessionParam |
Sitzungsparameter zum Schreiben des Slotwerts, nachdem dieser gefüllt wurde. Verschachtelte Pfade werden derzeit nicht unterstützt. Mit „$$“ wird der Slotwert in einen Sitzungsparameter mit demselben Namen wie der Slot geschrieben. Beispiel: writeSessionParam = "fruit" entspricht "$session.params.fruit". writeSessionParam = "ticket" entspricht "$session.params.ticket". |
DefaultValue
Konfiguration zum Ausfüllen eines Standardwerts für diesen Slot.
JSON-Darstellung | |
---|---|
{ "sessionParam": string, "constant": value } |
Felder | |
---|---|
sessionParam |
Optional. Sitzungsparameter, der zum Initialisieren des Slotwerts verwendet werden soll, falls ein Wert nicht leer ist Der Typ des Werts muss mit dem Typ der Anzeigenfläche übereinstimmen. Verschachtelte Pfade werden derzeit nicht unterstützt. Beispiel: |
constant |
Optional. Konstanter Standardwert für die Anzeigenfläche Wird nur verwendet, wenn ein Wert für diesen Slot nicht über |
DataFiles
Wrapper für wiederholte Datendatei. Wiederkehrende Felder dürfen nicht in einem oneof enthalten sein.
JSON-Darstellung | |
---|---|
{
"dataFiles": [
{
object ( |
Felder | |
---|---|
dataFiles[] |
Mehrere Datendateien. |
DataFile
Stellt eine einzelne Datei dar, die unstrukturierte Daten enthält. Beispiele hierfür sind Bilddateien, Audiodateien und der Quellcode von Cloud Functions.
JSON-Darstellung | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Felder | |
---|---|
filePath |
Der relative Pfad der Datendatei vom Projektstamm in der SDK-Dateistruktur. Zulässige Dateipfade: – Bilder: |
contentType |
Erforderlich. Der Inhaltstyp dieses Assets. Beispiel: |
payload |
Inhalt der Datendatei. Beispiele hierfür sind Rohbyte von Bildern, Audiodateien oder das ZIP-Format der Cloud Functions-Funktion. Die Nutzlastgröße ist auf 10 MB beschränkt. Ein base64-codierter String. |