- JSON-Darstellung
- ConfigFiles
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ConfigFile
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Manifest
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Aktionen
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CustomAction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Interaktion
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Settings
- Kategorie
- SurfaceRequirements
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CapabilityRequirement
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SurfaceCapability
- LocalizedSettings
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ThemeCustomization
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageCornerStyle
- AccountLinking
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- LinkingType
- AuthGrantType
- Webhook
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Handler
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- HttpsEndpoint
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- InlineCloudFunction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Absicht
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- IntentParameter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ClassReference
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- EntitySetReferences
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- EntitySetReference
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SynonymType
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MatchType
- Entity
- EntityDisplay
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- RegularExpressionType
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Entity
- FreeTextType
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- EntitySet
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Entity
- GlobalIntentEvent
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- EventHandler
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticPromptCandidate
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Auswahl
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SurfaceCapabilities
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Funktion
- StaticPromptResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticSimplePrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Variante
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticContentPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticCardPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticImagePrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageFill
- StaticLinkPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OpenUrl
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- UrlHint
- StaticTablePrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TableColumn
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MediaType
- OptionalMediaControls
- MediaObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MediaImage
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- RepeatMode
- StaticListPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ListItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticCollectionPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CollectionItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticCollectionBrowsePrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CollectionBrowseItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Vorschlag
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StaticCanvasPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Szene
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- IntentEvent
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ConditionalEvent
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Steckplatz
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PromptSettings
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CommitBehavior
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DefaultValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DataFiles
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DataFile
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
Wrapper für eine Liste von Dateien.
JSON-Darstellung | |
---|---|
{ // Union field |
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 |
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-Quellcodes. |
ConfigFiles
Wrapper für wiederholte Konfigurationsdateien. Wiederkehrende Felder können in einem oneof nicht vorhanden 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 ihrer Projekte mithilfe einer strukturierten Konfiguration 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. 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 |
Einzelne Manifestdatei. Zulässiger Dateipfad: |
|
actions |
Einzelne Aktionsdatei mit allen definierten Aktionen. Zulässige Dateipfade: |
|
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: |
|
webhook |
Definition eines einzelnen Webhooks. Zulässiger Dateipfad: |
|
intent |
Definition eines einzelnen Intents. Zulässige Dateipfade: |
|
type |
Definition eines einzelnen Typs. Zulässige Dateipfade: |
|
entitySet |
Definition eines Einzelentitäts-Sets. Zulässige Dateipfade: |
|
globalIntentEvent |
Einzelne globale Intent-Ereignisdefinition. Zulässige Dateipfade: |
|
scene |
Definition einer einzelnen Szene. Zulässige Dateipfade: |
|
staticPrompt |
Definition einer einzelnen statischen Aufforderung. Zulässige Dateipfade: |
|
accountLinkingSecret |
Metadaten, die dem Clientschlüssel entsprechen, der bei der Kontoverknüpfung verwendet wurde. Zulässiger Dateipfad: |
|
resourceBundle |
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: |
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 |
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 ( |
Felder | |
---|---|
custom |
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 |
CustomAction
Details zu einer benutzerdefinierten Aktion.
JSON-Darstellung | |
---|---|
{
"engagement": {
object ( |
Felder | |
---|---|
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 ( |
Felder | |
---|---|
title |
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 |
Einstellungen für Push-Benachrichtigungen, die für diese Interaktion unterstützt werden. |
actionLink |
Linkkonfiguration für eine Aktion, die bestimmt, ob die Freigabe von Links für die Aktion aktiviert ist, und ggf. den nutzerfreundlichen Anzeigenamen für den Link enthält. ActionLink wurde eingestellt. Verwende stattdessen AssistantLink. |
assistantLink |
Linkkonfiguration für eine Aktion, die bestimmt, ob die Freigabe von Links für die Aktion aktiviert ist, und ggf. den nutzerfreundlichen Anzeigenamen für den Link enthält. |
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.
ActionLink
Gibt an, ob die Freigabelinks für diese Aktion und die entsprechenden Einstellungen aktiviert sind. Aktionslinks werden verwendet, um einen Nutzer per Deeplink zu einer bestimmten Aktion weiterzuleiten. ActionLink wurde eingestellt. Verwende stattdessen AssistantLink.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Nutzerfreundlicher Anzeigetitel für den Link. |
AssistantLink
Gibt an, ob die Freigabelinks für diese Aktion und die entsprechenden Einstellungen aktiviert sind. Assistant-Links werden verwendet, um einen Nutzer per Deeplink zu einer bestimmten Aktion weiterzuleiten.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Nutzerfreundlicher Anzeigetitel für den Link. |
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 ( |
Felder | |
---|---|
projectId |
Actions-Projekt-ID. |
defaultLocale |
Sprache, die der Standardwert für das Projekt ist. Bei allen Dateien außer unter |
enabledRegions[] |
Stellt die Regionen dar, in denen Nutzer deine Aktionen aufrufen können (basierend auf dem Standort des Nutzers). Kann nicht festgelegt werden, wenn |
disabledRegions[] |
Stellt die Regionen dar, in denen deine Aktionen basierend auf dem aktuellen Standort des Nutzers 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“ schlägt der Versuch, die Transaktions-APIs zu verwenden, fehl. |
usesDigitalPurchaseApi |
Gibt an, ob Aktionen Transaktionen für digitale Waren durchführen können. |
usesInteractiveCanvas |
Gibt an, ob Aktionen den interaktiven Canvas verwenden. |
usesHomeStorage |
Gibt an, ob Aktionen die Speicherfunktion des Zuhauses verwenden. |
designedForFamily |
Gibt an, ob Actions-Inhalte für Familien gedacht sind. |
containsAlcoholOrTobaccoContent |
Ob Aktionen alkohol- oder tabakbezogene Inhalte enthalten |
keepsMicOpen |
Legt fest, ob das Mikrofon in Actions ohne explizite Aufforderung während einer Unterhaltung eingeschaltet bleibt. |
surfaceRequirements |
Die Oberflächenanforderungen, die eine Client-Oberfläche unterstützen muss, um Aktionen in diesem Projekt aufzurufen. |
testingInstructions |
Anleitung zum Testen im freien Format für Actions-Prüfer, z. B. Anleitungen zur Kontoverknüpfung |
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 |
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 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 ( |
Felder | |
---|---|
minimumRequirements[] |
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 ( |
Felder | |
---|---|
capability |
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 ( |
Felder | |
---|---|
displayName |
Erforderlich. Der standardmäßige Anzeigename für dieses Actions-Projekt (falls keine Übersetzung verfügbar ist) |
pronunciation |
Erforderlich. Die Aussprache des Anzeigenamens, der in einem Sprachkontext (gesprochen) aufgerufen wird. |
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 x 192 Pixel Sollte als Verweis auf das entsprechende Bild im Verzeichnis |
largeBannerImage |
Optional. Großes Bild im Querformat, 1.920 x 1.080 Pixel 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 der 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. 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 |
Erforderlich. Die URL der Datenschutzerklärung. |
sampleInvocations[] |
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 |
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 ( |
Felder | |
---|---|
backgroundColor |
Hintergrundfarbe von Karten Fungiert als Fallback, wenn |
primaryColor |
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 |
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 |
Rahmenlinienstil des Vordergrundbilds von Karten. Sie kann beispielsweise auf das Vordergrundbild einer Standard- oder Karussellkarte angewendet werden. |
landscapeBackgroundImage |
Querformat (mindestens 1.920 x 1.200 Pixel) Sollte als Verweis auf das entsprechende Bild im Verzeichnis |
portraitBackgroundImage |
Porträtmodus (mindestens 1.200 × 1.920 Pixel) Sollte als Verweis auf das entsprechende Bild im Verzeichnis |
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 ( |
Felder | |
---|---|
enableAccountCreation |
Erforderlich. Wenn |
linkingType |
Erforderlich. Der zu verwendende Verknüpfungstyp. Weitere Informationen zu den Verknüpfungstypen finden Sie unter https://developers.google.com/assistant/identity. |
authGrantType |
Optional. Gibt den Authentifizierungstyp für OAUTH LinkingType an. |
appClientId |
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 |
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 |
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[] |
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 |
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 |
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 das 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 ( |
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-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 |
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 |
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 |
Zuordnung von HTTP-Parametern, die in die POST-Anfrage einbezogen werden sollen. Ein Objekt, das eine Liste von |
endpointApiVersion |
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 |
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 ( |
Felder | |
---|---|
parameters[] |
Die Liste der Parameter in den Trainingsformulierungen. Hier müssen alle Parameter definiert werden, damit sie in der Trainingsformulierung verwendet werden können. |
trainingPhrases[] |
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 |
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 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 |
Optional. Deklariert den Datentyp dieses Parameters. Für integrierte 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 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 |
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-Referenzen für einen Intent-Parameter
JSON-Darstellung | |
---|---|
{
"entitySetReferences": [
{
object ( |
Felder | |
---|---|
entitySetReferences[] |
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 |
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 |
Felder | ||
---|---|---|
exclusions[] |
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 |
Synonymtyp, der im Wesentlichen eine Aufzählung ist. |
|
regularExpression |
Regex-Typ; ermöglicht den Abgleich regulärer Ausdrücke. |
|
freeText |
Freitexttyp. |
SynonymType
Geben Sie Text ein, der mit einer Reihe von Synonymen übereinstimmt.
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 der umgebenden Eingabe- und Intent-Trainingsdaten abgeglichen, z. B. Artikel, die einer Einkaufsliste hinzugefügt werden könnten. |
entities |
Erforderlich. Benannte Karte mit Synonymentitäten. Ein Objekt, das eine Liste von |
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 ( |
Felder | |
---|---|
display |
Optional. Die Entitätsdetails. |
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 reguläre Ausdrücke enthält. 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 ein Element 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
Typ, der mit einem beliebigen Text übereinstimmt, wenn der umgebende Wortkontext den bereitgestellten Trainingsbeispielen nahekommt.
JSON-Darstellung | |
---|---|
{
"display": {
object ( |
Felder | |
---|---|
display |
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 ( |
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. 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 ( |
Felder | |
---|---|
transitionToScene |
Optional. Zielszene, zu dem 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 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 |
Felder | ||
---|---|---|
webhookHandler |
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 |
Statischer Inline-Prompt. Kann Verweise auf Stringressourcen in Bundles enthalten. |
|
staticPromptName |
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 ( |
Felder | |
---|---|
candidates[] |
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 ( |
Felder | |
---|---|
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 |
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 ( |
Felder | |
---|---|
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 ( |
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 |
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. |
WEB_LINK |
Auf dem Gerät können Weblinks in Rich-Antworten verwendet werden, um einen Webbrowser zu öffnen. |
HOME_STORAGE |
Das Gerät kann das Speichern und Abrufen von Speicherplatz im Zuhause unterstützen. |
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 ( |
Felder | |
---|---|
firstSimple |
Optional. Die erste reine Sprach- und Textantwort. |
content |
Optional. Ein Inhalt wie eine Karte, eine Liste oder ein Medium, das bzw. der dem Nutzer angezeigt werden soll. |
lastSimple |
Optional. Die letzte reine Sprach- und Textantwort. |
suggestions[] |
Optional. Vorschläge, die dem Nutzer angezeigt werden und immer am Ende der Antwort angezeigt werden. Wenn das Feld |
link |
Optional. Ein zusätzlicher Vorschlags-Chip, der auf die verknüpfte App oder Website verweisen kann. Der Chip wird mit dem Titel „Öffnen |
override |
Optional. Modus zum Zusammenführen dieser Nachrichten mit zuvor definierten Nachrichten. |
canvas |
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 ( |
Felder | |
---|---|
variants[] |
Liste der möglichen Varianten. |
Variante
Stellt eine Variante dar, die Teil des einfachen Prompts ist.
JSON-Darstellung | |
---|---|
{ "speech": string, "text": string } |
Felder | |
---|---|
speech |
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 |
text |
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 |
StaticContentPrompt
Ein Platzhalter für den Inhaltsteil einer StaticPrompt.
JSON-Darstellung | |
---|---|
{ // Union field |
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 |
Eine einfache Karte. |
|
image |
Ein Bild. |
|
table |
Tabellenkarte. |
|
media |
Antwort, die eine Gruppe von Medien angibt, die abgespielt werden sollen. |
|
list |
Eine Karte, auf der eine Liste mit Optionen präsentiert wird. |
|
collection |
Eine Karte mit einer Liste von Optionen zur Auswahl. |
|
collectionBrowse |
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 ( |
Felder | |
---|---|
title |
Optional. Gesamttitel der Karte |
subtitle |
Optional. Untertitel der Karte |
text |
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 |
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, das für Barrierefreiheit verwendet werden soll, z.B. Screenreadern. |
height |
Optional. Die Höhe des Bilds in Pixeln |
width |
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 ( |
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, entweder http- oder https-URLs zum Öffnen einer mit Apps verknüpften App oder einer Webseite |
hint |
Gibt einen Hinweis für den URL-Typ an. |
UrlHint
Verschiedene Arten von URL-Hinweisen
Enums | |
---|---|
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 ( |
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 Ausrichtung von Spalten. |
rows[] |
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 |
button |
Optional. Schaltfläche. |
TableColumn
Beschreibt eine Spalte in der Tabelle.
JSON-Darstellung | |
---|---|
{
"header": string,
"align": enum ( |
Felder | |
---|---|
header |
Überschrift für die Spalte. |
align |
Horizontale Ausrichtung des Inhalts mit der Spalte. Wenn kein Wert angegeben ist, wird der Inhalt an der Spitze ausgerichtet. |
HorizontalAlignment
Die Ausrichtung des Inhalts innerhalb der Zelle.
Enums | |
---|---|
UNSPECIFIED |
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 ( |
Felder | |
---|---|
cells[] |
Zellen in dieser Zeile. Die ersten 3 Zellen werden garantiert angezeigt, aber andere werden möglicherweise an bestimmten Oberflächen ausgeschnitten. Führen Sie einen Test mit dem Simulator durch, um zu sehen, welche Zellen für eine bestimmte Oberfläche angezeigt werden. |
divider |
Gibt an, ob nach jeder Zeile eine Trennlinie vorhanden sein soll. |
TableCell
Beschreibt eine Zelle in einer Zeile.
JSON-Darstellung | |
---|---|
{ "text": string } |
Felder | |
---|---|
text |
Textinhalt der Zelle. |
StaticMediaPrompt
Enthält Informationen zum Medium, z. B. Name, Beschreibung, URL usw. 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 Mediensteuerungstypen, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, wird die Anfrage an 3p gesendet, wenn ein bestimmtes Medienereignis eintritt. Wenn die Richtlinie nicht konfiguriert ist, muss 3p dennoch die beiden Standardsteuerungstypen FINISHED und FAILED verarbeiten. |
mediaObjects[] |
Liste der Medienobjekte. |
repeatMode |
Wiederholungsmodus für die Liste der Medienobjekte. |
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 ( |
Felder | |
---|---|
name |
Name dieses Medienobjekts. |
description |
Beschreibung dieses Medienobjekts. |
url |
Die URL, die auf den Medieninhalt verweist |
image |
Bild, das mit der Medienkarte angezeigt werden soll. |
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, z. B. das Cover des Albums |
|
icon |
Ein kleines Bildsymbol rechts neben dem Titel. Die Größe wird auf 36 x 36 dp reduziert. |
RepeatMode
Die Typen des Wiederholungsmodus für eine Liste von Medienobjekten.
Enums | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Entspricht AUS. |
OFF |
Mediensitzung am Ende des letzten Medienobjekts beenden |
ALL |
Wechselt zum Anfang des ersten Medienobjekts, wenn das Ende des letzten Medienobjekts erreicht ist. |
StaticListPrompt
Eine Karte, auf der eine Liste mit Optionen präsentiert wird.
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 Eingabeschlüssels im verknüpften Typ übereinstimmt. Wenn ein Element angetippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben. |
title |
Erforderlich. Titel des Artikels. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Gruppe von Elementen eindeutig sein. |
description |
Optional. Text des Elements. |
image |
Optional. Bild des Artikels. |
StaticCollectionPrompt
Eine Karte, auf der eine Sammlung von Optionen präsentiert wird.
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 Eingabeschlüssels im verknüpften Typ übereinstimmt. Wenn ein Element angetippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben. |
title |
Erforderlich. Titel des Artikels. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Gruppe von Elementen eindeutig sein. |
description |
Optional. Text des Elements. |
image |
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 ( |
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, der unter der Beschreibung angezeigt wird. Einzelne, mit Auslassungspunkten abgeschnittene Textzeile. |
image |
Bild für das Sammlungselement. |
openUriAction |
Erforderlich. URI, der geöffnet werden soll, wenn das Element ausgewählt ist. |
Vorschlag
Stellt einen Vorschlags-Chip dar, ein UI-Element, das dem Nutzer der Einfachheit halber angezeigt wird.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Erforderlich. Der Text, der im Vorschlags-Chip angezeigt wird. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss unter den Vorschlags-Chips eindeutig sein. Maximal 25 Zeichen |
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 |
Erforderlich. URL der zu ladenden Webansicht. |
data[] |
Optional. JSON-Daten, die als Ereignis an die Webseite des immersiven Erlebnisses übergeben werden. Wenn das Feld |
suppressMic |
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 |
Optional. Bei |
enableFullScreen |
Optional. Wenn |
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 ( |
Felder | |
---|---|
onEnter |
Handler, der beim Übergang zu dieser Szene aufgerufen wird. |
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 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[] |
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[] |
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 |
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 ( |
Felder | |
---|---|
intent |
Erforderlich. Intent, der das Ereignis auslöst. |
transitionToScene |
Optional. Zielszene, zu dem 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 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 ( |
Felder | |
---|---|
condition |
Erforderlich. Filterbedingung für das Auslösen dieses Ereignisses. Wenn die Bedingung als „true“ ausgewertet wird, wird die 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 |
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 ( |
Felder | |
---|---|
name |
Erforderlich. Name des Slots. |
type |
Erforderlich. Deklariert den Datentyp dieses Slots. |
required |
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 |
Optional. Registriert Aufforderungen für verschiedene Phasen der Slot-Füllung. |
commitBehavior |
Optional. Commit-Verhalten in Verbindung mit der Anzeigenfläche. |
config |
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 { "@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 diese Anzeigenfläche. |
PromptSettings
Ein zentraler Ort, an dem Slot-Prompts definiert werden.
JSON-Darstellung | |
---|---|
{ "initialPrompt": { object ( |
Felder | |
---|---|
initialPrompt |
Fragt den Slotwert selbst ab. Beispiel: „Welche Größe wollten Sie?“ |
noMatchPrompt1 |
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 |
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 |
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 |
Aufforderung, die gegeben wird, wenn der Nutzer nicht zum ersten Mal eine Eingabe macht. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“ |
noInputPrompt2 |
Aufforderung zu geben, wenn der Nutzer zum zweiten Mal keine Eingabe macht. Beispiel: „Tut mir leid, das habe ich nicht verstanden.“ |
noInputFinalPrompt |
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 |
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 |
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: |
constant |
Optional. Konstanter Standardwert für die Anzeigenfläche. Wird nur verwendet, wenn ein Wert für diese Anzeigenfläche nicht über |
DataFiles
Wrapper für wiederholte Datendatei. Wiederkehrende Felder können in einem oneof nicht vorhanden sein.
JSON-Darstellung | |
---|---|
{
"dataFiles": [
{
object ( |
Felder | |
---|---|
dataFiles[] |
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 |
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 mit Cloud Functions-Funktionen. Für die Nutzlastgröße gilt eine strikte Beschränkung von 10 MB. Ein base64-codierter String. |