Files

Otoka listy plików.

Zapis JSON
{

  // Union field file_type can be only one of the following:
  "configFiles": {
    object (ConfigFiles)
  },
  "dataFiles": {
    object (DataFiles)
  }
  // End of list of possible types for union field file_type.
}
Pola
Pole sumy file_type. Jednocześnie na serwer można wysyłać tylko jeden typ plików – pliki konfiguracji lub dane. file_type może mieć tylko jedną z tych wartości:
configFiles

object (ConfigFiles)

Lista plików konfiguracji. Dotyczy to pliku manifestu, ustawień, pakietów zasobów modelu interakcji i innych informacji.

dataFiles

object (DataFiles)

Lista plików danych. Obejmuje to obraz, plik audio i kod źródłowy funkcji w Cloud Functions.

ConfigFiles

Otoka powtórzonych plików konfiguracyjnych. Pole powtarzane nie może znajdować się w jednym z tych elementów.

Zapis JSON
{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}
Pola
configFiles[]

object (ConfigFile)

Wiele plików konfiguracji.

ConfigFile

Reprezentuje pojedynczy plik zawierający uporządkowane dane. Deweloperzy mogą definiować większość swojego projektu za pomocą uporządkowanych konfiguracji, które obejmują Działania, Ustawienia i Realizację.

Zapis JSON
{
  "filePath": string,

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

string

Ścieżka względna pliku konfiguracyjnego z katalogu głównego projektu w strukturze pliku SDK. Każdy z poniższych typów plików ma dozwoloną ścieżkę pliku. Na przykład: settings/settings.yaml

Pole sumy file. Każdy typ pliku konfiguracyjnego powinien mieć odpowiadające mu pole w elemencie oneof. file może mieć tylko jedną z tych wartości:
manifest

object (Manifest)

Jeden plik manifestu. Dozwolona ścieżka pliku: manifest.yaml

actions

object (Actions)

Pojedynczy plik działań ze wszystkimi zdefiniowanymi działaniami. Dozwolone ścieżki do plików: actions/{language}?/actions.yaml

settings

object (Settings)

Pojedyncza konfiguracja ustawień, która zawiera ustawienia i ustawienia domyślnego języka projektu (jeśli został określony). W przypadku pliku zastępowania ustawień regionalnych wypełnione będzie tylko pole localizedSettings. Dozwolone ścieżki do plików: settings/{language}?/settings.yaml Pamiętaj, że w żądaniach przepływu zapisu musi znajdować się niezlokalizowany plik ustawień settings/settings.yaml.

webhook

object (Webhook)

Definicja pojedynczego webhooka. Dozwolona ścieżka pliku: webhooks/{WebhookName}.yaml

intent

object (Intent)

Definicja pojedynczej intencji. Dozwolone ścieżki do plików: custom/intents/{language}?/{IntentName}.yaml

type

object (Type)

Definicja pojedynczego typu. Dozwolone ścieżki do plików: custom/types/{language}?/{TypeName}.yaml

entitySet

object (EntitySet)

Definicja zestawu pojedynczej encji. Dozwolone ścieżki do plików: custom/entitySets/{language}?/{EntitySetName}.yaml

globalIntentEvent

object (GlobalIntentEvent)

Definicja pojedynczego globalnego zdarzenia intencji. Dozwolone ścieżki do plików: custom/global/{GlobalIntentEventName}.yaml nazwa pliku (GlobalIntentEventName) powinna być nazwą intencji, której odpowiada to globalne zdarzenie intencji.

scene

object (Scene)

Definicja pojedynczej sceny. Dozwolone ścieżki do plików: custom/scenes/{SceneName}.yaml

staticPrompt

object (StaticPrompt)

Definicja pojedynczej statycznej promptu. Dozwolone ścieżki do plików: custom/prompts/{language}?/{StaticPromptName}.yaml

accountLinkingSecret

object (AccountLinkingSecret)

Metadane odpowiadające tajnego klucza klienta używanego do łączenia kont. Dozwolona ścieżka pliku: settings/accountLinkingSecret.yaml

resourceBundle

object (Struct format)

Pojedynczy pakiet zasobów, który stanowi mapowanie ciągu znaków na ciąg lub listę ciągów znaków. Pakiety zasobów mogą być używane do lokalizowania ciągów tekstowych w promptach statycznych. Dozwolone ścieżki do plików: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

Plik manifestu

Zawiera informacje, które są „przenośne”, czyli nie dotyczą konkretnego projektu i można je przenosić między projektami.

Zapis JSON
{
  "version": string
}
Pola
version

string

Wersja formatu pliku. Obecna wersja formatu pliku to 1.0. Przykład: „1.0”

Działania

Reprezentuje listę działań zdefiniowanych w projekcie.

Zapis JSON
{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}
Pola
custom

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

Zmapuj z intencji na działania niestandardowe, aby skonfigurować wywoływanie w projekcie. Intencje wywołania mogą być intencjami systemowymi lub niestandardowymi zdefiniowanymi w pakiecie „custom/intents/”. Wszystkie intencje zdefiniowane w tym miejscu (intencje systemowe i intencje niestandardowe) muszą mieć odpowiedni plik intencji w pakiecie „custom/global/”.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomAction

Szczegółowe informacje o działaniu niestandardowym.

Zapis JSON
{
  "engagement": {
    object (Engagement)
  }
}
Pola
engagement

object (Engagement)

Mechanizmy zaangażowania powiązane z działaniem, które pomagają użytkownikom zasubskrybować powiadomienia push i codzienne aktualności. Pamiętaj, że nazwa intencji określona w konfiguracji przedziału czasu na codzienne aktualizacje i powiadomienia push musi odpowiadać intencji odpowiadającej temu działaniu, aby użytkownicy mogli subskrybować te aktualizacje.

Zaangażowanie

Określa mechanizmy zaangażowania powiązane z tym działaniem. Dzięki temu użytkownicy będą mogli zasubskrybować powiadomienia push i codzienne aktualności.

Zapis JSON
{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}
Pola
title

string

Tytuł zaangażowania, który będzie wysyłany do użytkowników z prośbą o zgodę na otrzymywanie aktualizacji. Komunikat wysyłany do użytkowników z informacjami o codziennych aktualizacjach będzie wyglądał tak: „O której godzinie chcesz wysyłać codzienne powiadomienia {title}”, a w przypadku powiadomień push – „Czy wysyłam powiadomienia push na temat: {title}?”. To pole można zlokalizować.

pushNotification

object (PushNotification)

Ustawienia powiadomień push obsługiwane przez to zaangażowanie.

dailyUpdate

object (DailyUpdate)

Ustawienia codziennej aktualizacji obsługiwane przez to zaangażowanie.

PushNotification

Określa ustawienia powiadomień push obsługiwane przez to zaangażowanie.

DailyUpdate

Określa ustawienia codziennych aktualizacji obsługiwane przez to zaangażowanie.

Ustawienia

Reprezentuje ustawienia projektu Actions, które nie są powiązane z językiem. Następny tag: 22

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

string

Identyfikator projektu Actions.

defaultLocale

string

Język domyślny w projekcie. W przypadku wszystkich plików z wyjątkiem resources/, które nie zawierają języka w ścieżce, zlokalizowane dane są przypisywane do elementu defaultLocale. W przypadku plików z atrybutem resources/ brak ustawień regionalnych oznacza, że zasób jest dostępny we wszystkich językach.

enabledRegions[]

string

Reprezentuje regiony, w których użytkownicy mogą wywoływać Twoje działania, na podstawie lokalizacji obecności użytkownika. Nie można ustawić wartości disabledRegions, jeśli jest skonfigurowana. Jeśli nie określono zarówno enabledRegions, jak i disabledRegions, użytkownicy mogą wywoływać akcje we wszystkich regionach. Każdy region jest reprezentowany za pomocą kanonicznej nazwy celów geograficznych AdWords. Zobacz https://developers.google.com/adwords/api/docs/appendix/geotargeting. Przykłady: - „Niemcy” - „Ghana” - „Grecja”, - „Grenada”, „Wielka Brytania”, - „Stany Zjednoczone”, „Dalekie Wyspy Mniejsze Stanów Zjednoczonych” - „Urugwaj”

disabledRegions[]

string

Reprezentuje regiony, w których Twoje akcje są zablokowane, na podstawie lokalizacji obecności użytkownika. Nie można ustawić wartości enabledRegions, jeśli jest skonfigurowana. Każdy region jest reprezentowany za pomocą kanonicznej nazwy celów geograficznych AdWords. Zobacz https://developers.google.com/adwords/api/docs/appendix/geotargeting. Przykłady: - „Niemcy” - „Ghana” - „Grecja”, - „Grenada”, „Wielka Brytania”, - „Stany Zjednoczone”, „Dalekie Wyspy Mniejsze Stanów Zjednoczonych” - „Urugwaj”

category

enum (Category)

Kategoria tego projektu w Actions.

usesTransactionsApi

boolean

Czy Działania mogą korzystać z transakcji (na przykład dokonywania rezerwacji, przyjmowania zamówień itp.). Jeśli ma wartość false (fałsz), próby użycia interfejsów API transakcji kończą się niepowodzeniem.

usesDigitalPurchaseApi

boolean

Czy Akcja może dokonywać transakcji dotyczących produktów cyfrowych.

usesInteractiveCanvas

boolean

Określa, czy Działania używają interaktywnego obszaru roboczego.

usesHomeStorage

boolean

Określa, czy Działania korzystają z funkcji przechowywania danych w domu.

designedForFamily

boolean

Czy treści akcji są przeznaczone dla całej rodziny.

containsAlcoholOrTobaccoContent

boolean

Czy Akcja zawiera treści związane z alkoholem lub tytoniem.

keepsMicOpen

boolean

Określa, czy Działania mogą pozostawiać włączony mikrofon bez wyraźnego pytania o to podczas rozmowy.

surfaceRequirements

object (SurfaceRequirements)

Wymagania dotyczące powierzchni, które musi obsługiwać platforma klienta, aby można było wywoływać działania w tym projekcie.

testingInstructions

string

Instrukcje testowania swobodnego dla weryfikatora Actions (np. instrukcje łączenia kont).

localizedSettings

object (LocalizedSettings)

Zlokalizowane ustawienia domyślnego języka projektu. Każdy dodatkowy język powinien mieć własny plik ustawień w osobnym katalogu.

accountLinking

object (AccountLinking)

Zezwalaj użytkownikom na tworzenie i łączenie kont z wykorzystaniem logowania przez Google lub własnej usługi OAuth.

selectedAndroidApps[]

string

Aplikacje na Androida wybrane do uzyskiwania dostępu do transakcji zakupu w Google Play. Są to aplikacje na Androida połączone z projektem Actions, aby potwierdzić własność marki i włączyć dodatkowe funkcje. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/console/brand-verification.

Kategoria

Wybór kategorii projektu Actions.

Wartości w polu enum
CATEGORY_UNSPECIFIED Nieznany / nieokreślony.
BUSINESS_AND_FINANCE Biznes i finanse.
EDUCATION_AND_REFERENCE Kategoria Edukacja i źródła wiedzy.
FOOD_AND_DRINK Kategoria Jedzenie i napoje.
GAMES_AND_TRIVIA Kategoria Gry i Quizy.
HEALTH_AND_FITNESS Zdrowie i fitness.
KIDS_AND_FAMILY w kategorii Dzieci i rodzina.
LIFESTYLE Kategoria Styl życia.
LOCAL Kategoria lokalna.
MOVIES_AND_TV Kategoria Filmy i TV.
MUSIC_AND_AUDIO Kategoria Muzyka i Dźwięk.
NEWS Kategoria wiadomości,
NOVELTY_AND_HUMOR Kategoria Nowości i humor.
PRODUCTIVITY Kategoria produktywności.
SHOPPING Kategoria zakupów.
SOCIAL Kategoria społeczna.
SPORTS Kategoria sportowa.
TRAVEL_AND_TRANSPORTATION w kategorii Podróże i transport.
UTILITIES Kategoria narzędzi.
WEATHER Kategoria Pogoda.
HOME_CONTROL Kategoria Sterowanie domem.

SurfaceRequirements

Zawiera zestaw wymagań, które musi obsługiwać platforma klienta, aby można było wywoływać działania w projekcie.

Zapis JSON
{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}
Pola
minimumRequirements[]

object (CapabilityRequirement)

Minimalny zestaw funkcji wymaganych do wywoływania akcji w projekcie. Jeśli brakuje któregoś z tych elementów, Działanie nie zostanie wywołane.

CapabilityRequirement

Reprezentuje wymagania dotyczące dostępności danej możliwości.

Zapis JSON
{
  "capability": enum (SurfaceCapability)
}
Pola
capability

enum (SurfaceCapability)

Typ możliwości.

SurfaceCapability

Możliwy zestaw funkcji platformy.

Wartości w polu enum
SURFACE_CAPABILITY_UNSPECIFIED Nieznany / nieokreślony.
AUDIO_OUTPUT Surface obsługuje wyjście audio.
SCREEN_OUTPUT Surface obsługuje dane wyjściowe ekranowe/wizualne.
MEDIA_RESPONSE_AUDIO Surface obsługuje odpowiedzi audio w odpowiedzi na żądania multimediów.
WEB_BROWSER Surface obsługuje przeglądarki.
ACCOUNT_LINKING Surface obsługuje łączenie kont.
INTERACTIVE_CANVAS Surface obsługuje interaktywne obiekty Canvas.
HOME_STORAGE Surface obsługuje pamięć domową.

LocalizedSettings

Reprezentuje ustawienia projektu Actions specyficzne dla języka użytkownika. W tym przypadku użytkownik oznacza użytkownika, który wywołał akcję. Tę wiadomość można zlokalizować.

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

string

To pole jest wymagane. Domyślna wyświetlana nazwa tego projektu w Actions (jeśli nie ma dostępnego tłumaczenia)

pronunciation

string

To pole jest wymagane. Wymowa wyświetlanej nazwy wywołującej ją w kontekście głosu (wypowiedzi).

shortDescription

string

To pole jest wymagane. Domyślny krótki opis projektu w Actions (jeśli nie ma dostępnego tłumaczenia). Obowiązuje limit 80 znaków.

fullDescription

string

To pole jest wymagane. Domyślny długi opis projektu w Actions (jeśli nie ma dostępnego tłumaczenia). Obowiązuje limit 4000 znaków.

smallLogoImage

string

To pole jest wymagane. Mały kwadratowy obraz o wymiarach 192 x 192 piksele. Powinien on być określony w odniesieniu do odpowiedniego obrazu w katalogu resources/images/. Na przykład $resources.images.foo (bez rozszerzenia) w przypadku obrazu w resources/images/foo.jpg podczas pracy nad projektem pobranym z Konsoli można użyć pobranego adresu URL zarządzanego przez Google. Adresy URL ze źródeł zewnętrznych są niedozwolone.

largeBannerImage

string

Opcjonalnie. Duży obraz poziomy o wymiarach 1920 x 1080 pikseli. Powinien on być określony w odniesieniu do odpowiedniego obrazu w katalogu resources/images/. Na przykład $resources.images.foo (bez rozszerzenia) w przypadku obrazu w resources/images/foo.jpg podczas pracy nad projektem pobranym z Konsoli można użyć pobranego adresu URL zarządzanego przez Google. Adresy URL ze źródeł zewnętrznych są niedozwolone.

developerName

string

To pole jest wymagane. Nazwa dewelopera, która będzie wyświetlana użytkownikom.

developerEmail

string

To pole jest wymagane. Kontaktowy adres e-mail dewelopera.

termsOfServiceUrl

string

Opcjonalnie. Adres URL warunków korzystania z usługi.

voice

string

To pole jest wymagane. Rodzaj głosu Asystenta Google, który użytkownicy słyszą podczas interakcji z Twoimi akcjami. Obsługiwane wartości to „mężczyzna_1”, „mężczyzna_2”, „kobieta_1” i „kobieta_2”.

voiceLocale

string

Opcjonalnie. Język określonego głosu. Jeśli go nie podasz, używany będzie język Asystenta użytkownika. Jeśli zostanie określony, język głosu musi mieć ten sam język główny co region określony w Ustawieniach lokalizacji.

privacyPolicyUrl

string

To pole jest wymagane. Adres URL polityki prywatności.

sampleInvocations[]

string

Opcjonalnie. Przykładowe wyrażenia wywołania wyświetlane w opisie projektu Actions w katalogu Asystenta. Dzięki temu użytkownicy dowiedzą się, jak z niej korzystać.

themeCustomization

object (ThemeCustomization)

Opcjonalnie. Dostosowywanie motywu do komponentów wizualnych Twoich akcji.

ThemeCustomization

Style zastosowane do kart wyświetlanych użytkownikom

Zapis JSON
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
Pola
backgroundColor

string

Kolor tła kart. Działa jako zastępcza, jeśli właściwość background_image nie została udostępniona przez dewelopera lub background_image nie pasuje do niektórych platform. Przykład użycia: #FAFAFA

primaryColor

string

Główny kolor motywu działania będzie używany do ustawienia koloru tekstu tytułu i koloru tła elementu działania na kartach Działań w Google. Przykład użycia: #FAFAFA

fontFamily

string

Rodzina czcionek, która będzie używana w tytułach kart. Obsługiwane czcionki: – Sans Serif – Sans Serif Średni – Sans Serif Bold – Sans Serif Black – Sans Serif Condensed – Sans Serif Condensed (średnia) – Serif – Serif pogrubiony – monospace – Kursywa – Sans Serif małe litery

imageCornerStyle

enum (ImageCornerStyle)

Styl obramowania obrazu na pierwszym planie kart. Możesz go np. zastosować na obrazie na pierwszym planie karty podstawowej lub karty karuzeli.

landscapeBackgroundImage

string

Tryb poziomy (co najmniej 1920 x 1200 pikseli). Powinien on być określony w odniesieniu do odpowiedniego obrazu w katalogu resources/images/. Przykład: $resources.images.foo (bez rozszerzenia) dla obrazu w resources/images/foo.jpg podczas pracy nad projektem pobranym z konsoli można wykorzystać zarządzany przez Google adres URL.

portraitBackgroundImage

string

Tryb portretowy (co najmniej 1200 x 1920 pikseli). Powinien on być określony w odniesieniu do odpowiedniego obrazu w katalogu resources/images/. Przykład: $resources.images.foo (bez rozszerzenia) dla obrazu w resources/images/foo.jpg podczas pracy nad projektem pobranym z konsoli można wykorzystać zarządzany przez Google adres URL.

ImageCornerStyle

Określa sposób renderowania obramowania obrazów.

Wartości w polu enum
IMAGE_CORNER_STYLE_UNSPECIFIED Nie zdefiniowano / nie określono.
CURVED Zaokrąglony róg obrazu.
ANGLED Prostokątny róg obrazu.

AccountLinking

AccountLinking pozwala Google pokierować użytkownika, aby zalogował się w usługach internetowych w aplikacji.

W przypadku połączeń typu Logowanie przez Google, Protokół OAuth i Logowanie przez Google generujemy identyfikator klienta identyfikujący Twoją aplikację („Identyfikator klienta wydany przez Google w ramach Działań” w interfejsie konsoli). To pole jest tylko do odczytu i można je sprawdzić na stronie Łączenie kont w interfejsie konsoli. Zobacz: https://developers.google.com/assistant/identity/google-sign-in

Uwaga: w przypadku wszystkich typów ustawień łączenia kont (z wyjątkiem Logowania przez Google) musisz w sekcji Settings.testing_instructions podać nazwę użytkownika i hasło do konta testowego, aby zespół sprawdzający mógł sprawdzić aplikację (nie będą one widoczne dla użytkowników).

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

boolean

To pole jest wymagane. Jeśli true, użytkownicy mogą rejestrować nowe konta za pomocą głosu. Jeśli wybierzesz false, tworzenie kont będzie możliwe tylko w Twojej witrynie. Wybierz tę opcję, jeśli chcesz wyświetlać warunki korzystania z usługi lub uzyskiwać zgodę użytkowników podczas rejestracji. LinkType nie może mieć wartości GOOGLE_SIGN_IN, gdy ma wartość false. LinkType nie może mieć wartości OAUTH, gdy ta wartość ma wartość true.

linkingType

enum (LinkingType)

To pole jest wymagane. Typ połączenia, którego chcesz użyć. Więcej informacji o typach połączeń znajdziesz na stronie https://developers.google.com/assistant/identity.

authGrantType

enum (AuthGrantType)

Opcjonalnie. Wskazuje typ uwierzytelniania dla metody OAUTH linkType.

appClientId

string

Opcjonalnie. Identyfikator klienta wydany przez Twoją aplikację dla Google. To identyfikator klienta OAuth2, który identyfikuje Google w Twojej usłudze. Ustawiany tylko podczas korzystania z OAuth.

authorizationUrl

string

Opcjonalnie. Punkt końcowy strony internetowej logowania, która obsługuje kod OAuth2 lub przepływy niejawne. Adres URL musi używać protokołu HTTPS. Ustawiany tylko podczas korzystania z OAuth.

tokenUrl

string

Opcjonalnie. Punkt końcowy OAuth2 na potrzeby wymiany tokenów. Adres URL musi używać protokołu HTTPS. Tej wartości nie ustawia się, gdy jako typ połączenia używany jest tylko protokół OAuth z przyznaniem IMPLICIT. Ustawiany tylko podczas korzystania z OAuth.

scopes[]

string

Opcjonalnie. Lista uprawnień, na które użytkownik musi wyrazić zgodę, aby korzystać z Twojej usługi. Ustawiany tylko podczas korzystania z OAuth. W przypadku zaznaczenia tego pola w sekcji LocalizedSettings.terms_of_service_url podaj Warunki korzystania z usługi w informacjach o katalogu.

learnMoreUrl

string

Opcjonalnie. To strona internetowa Twojej usługi, na której opisano uprawnienia, które użytkownik przyznaje Google. Ustaw tylko w przypadku korzystania z protokołu OAuth i logowania przez Google. W przypadku zaznaczenia tego pola w sekcji LocalizedSettings.terms_of_service_url podaj Warunki korzystania z usługi w informacjach o katalogu.

useBasicAuthHeader

boolean

Opcjonalnie. Jeśli ma wartość true (prawda), zezwól Google na przesyłanie identyfikatora klienta i obiektu tajnego za pomocą nagłówka uwierzytelniania podstawowego HTTP. W przeciwnym razie Google używa identyfikatora klienta i tajnego klucza w treści posta. Ustawiany tylko podczas korzystania z OAuth. W przypadku zaznaczenia tego pola w sekcji LocalizedSettings.terms_of_service_url podaj Warunki korzystania z usługi w informacjach o katalogu.

LinkingType

Typ łączenia kont, które chcesz wykonać.

Wartości w polu enum
LINKING_TYPE_UNSPECIFIED Nie określono.
GOOGLE_SIGN_IN Typ połączenia Logowanie przez Google. Jeśli używasz tego typu połączenia, poniżej nie trzeba ustawiać żadnych pól związanych z protokołem OAuth.
OAUTH_AND_GOOGLE_SIGN_IN Typ połączenia OAuth i Logowania przez Google.
OAUTH Typ połączenia OAuth.

AuthGrantType

Typ uwierzytelnienia OAuth2, którego Google używa, aby wskazać użytkownikowi, jak powinien zalogować się w usłudze internetowej Twojej aplikacji.

Wartości w polu enum
AUTH_GRANT_TYPE_UNSPECIFIED Nie określono.
AUTH_CODE Przyznanie kodu autoryzacji. Wymaga podania zarówno adresu URL uwierzytelniania, jak i adresu URL tokena dostępu.
IMPLICIT Przyznanie kodu niejawnego. Wymaga jedynie podania adresu URL uwierzytelniania.

Webhook

Metadane dla różnych typów webhooków. Jeśli używasz inlineCloudFunction, Twój kod źródłowy musi znajdować się w katalogu o tej samej nazwie co wartość klucza executeFunction. Na przykład wartość my_webhook klucza executeFunction miałaby taką strukturę kodu: – /webhooks/my_webhook.yaml/webhooks/my_webhook/index.js/webhooks/my_webhook/package.json

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

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

object (Handler)

Lista modułów obsługi tego webhooka.

Pole sumy webhook_type. Obsługiwany jest tylko jeden typ webhooka. webhook_type może mieć tylko jedną z tych wartości:
httpsEndpoint

object (HttpsEndpoint)

Niestandardowy punkt końcowy HTTPS webhooka.

inlineCloudFunction

object (InlineCloudFunction)

Metadane dla funkcji w Cloud Functions wdrożonej z kodu w folderze webhooków.

Moduł obsługi

Deklaruje nazwę modułu obsługi webhoook. Webhook może mieć zarejestrowanych wiele modułów obsługi. Te moduły obsługi można wywoływać z różnych miejsc w projekcie Actions.

Zapis JSON
{
  "name": string
}
Pola
name

string

To pole jest wymagane. Nazwa modułu obsługi. Musi być niepowtarzalna wśród wszystkich modułów obsługi w projekcie Actions. Możesz sprawdzić nazwę tego modułu obsługi, aby wywołać odpowiednią funkcję w kodzie źródłowym realizacji.

HttpsEndpoint

Punkt końcowy REST do powiadamiania, jeśli nie używasz edytora wbudowanego.

Zapis JSON
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
Pola
baseUrl

string

Podstawowy adres URL HTTPS dla punktu końcowego realizacji (HTTP nie jest obsługiwany). Nazwy modułów obsługi są dodawane do podstawowej ścieżki adresu URL po dwukropku (zgodnie ze stylem podanym na stronie https://cloud.google.com/apis/design/custom_methods)). Na przykład podstawowy adres URL „https://gactions.service.com/api” będzie otrzymywał żądania z adresem URL „https://gactions.service.com/api:{method}”.

httpHeaders

map (key: string, value: string)

Mapa parametrów HTTP, które mają być uwzględnione w żądaniu POST.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

endpointApiVersion

integer

Wersja protokołu używanego przez punkt końcowy. Jest to protokół wspólny dla wszystkich typów realizacji zamówień, który nie jest związany z typem realizacji Google.

InlineCloudFunction

Zawiera metadane wbudowanej funkcji w Cloud Functions wdrożonej z folderu webhooków.

Zapis JSON
{
  "executeFunction": string
}
Pola
executeFunction

string

Nazwa punktu wejścia funkcji w Cloud Functions. Wartość w tym polu powinna odpowiadać nazwie metody wyeksportowanej z kodu źródłowego.

Podobne zamiary

Intencje mapują otwarte dane wejściowe użytkownika na uporządkowane obiekty. Wypowiedzi mówione są dopasowywane do intencji za pomocą funkcji rozumienia języka naturalnego (NLU) Google. Dopasowania intencji mogą aktywować zdarzenia w strukturze rozmowy i postępować w niej. Nazwa intencji jest podana w nazwie pliku.

Zapis JSON
{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}
Pola
parameters[]

object (IntentParameter)

Lista parametrów w wyrażeniach na potrzeby trenowania. W tym miejscu muszą być zdefiniowane wszystkie parametry, które można wykorzystać w wyrażeniem na potrzeby trenowania.

trainingPhrases[]

string

Wyrażenia na potrzeby trenowania pozwalają systemowi NLU Google automatycznie dopasowywać intencje do danych wejściowych użytkownika. Im więcej niepowtarzalnych wyrażeń podasz, tym większa szansa, że intencja zostanie dopasowana. Poniżej znajduje się format części trenowania z adnotacjami. Pamiętaj, że pole auto jest opcjonalne. Jeśli pole auto nie jest określone, domyślne działanie jest równoważne z auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true oznacza, że do części części została automatycznie dodana adnotacja przez NLU. auto = false oznacza, że dana część została oznaczona adnotacją przez użytkownika. Jest to ustawienie domyślne, jeśli wartość auto nie została określona. Przykład: „Zarezerwuj lot z ($source 'San Francisco' auto=false) do ($dest 'Vancouver')”.

IntentParameter

Definicja parametru, którego można używać w wyrażeniach na potrzeby trenowania.

Zapis JSON
{
  "name": string,

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

string

To pole jest wymagane. Niepowtarzalna nazwa parametru intencji. Można jej używać w warunkach i w odpowiedziach do odwoływania się do parametrów intencji wyodrębnionych przez NLU za pomocą metody $intent.params.[name].resolved

Pole sumy parameter_type. Typ parametru intencji. parameter_type może mieć tylko jedną z tych wartości:
type

object (ClassReference)

Opcjonalnie. Deklaruje typ danych tego parametru. Nie należy go ustawiać dla intencji wbudowanych.

entitySetReferences

object (EntitySetReferences)

Opcjonalnie. Odniesienia do zbiorów dozwolonych encji dla tego parametru intencji. Dotyczy tylko parametrów intencji wbudowanej. Te odwołania wskazują zestawy encji w katalogu „custom/entitySets”.

ClassReference

Odwołanie do klasy służące do deklarowania typu pola lub zwracanej wartości. Wartości w polu Enum są również typem klasy, do którego można się odwoływać za pomocą elementu ClassReference.

Zapis JSON
{
  "name": string,
  "list": boolean
}
Pola
name

string

To pole jest wymagane. Nazwa wbudowanego typu lub niestandardowego typu parametru. Przykłady: PizzaToppings, actions.type.Number

list

boolean

Opcjonalnie. Wskazuje, czy typ danych przedstawia listę wartości.

EntitySetReferences

Odwołania do zestawu encji dla parametru intencji.

Zapis JSON
{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}
Pola
entitySetReferences[]

object (EntitySetReference)

To pole jest wymagane. Odwołania do zestawu encji dla parametru intencji.

EntitySetReference

Odwołanie do zbioru dozwolonych encji dla tego parametru intencji.

Zapis JSON
{
  "entitySet": string
}
Pola
entitySet

string

To pole jest wymagane. Określa zbiór elementów, które mają być brane pod uwagę w przypadku danego parametru. Odpowiednia definicja zestawu encji powinna znajdować się w katalogu custom/entitySets/.

Typ

Deklaracja typu niestandardowego w przeciwieństwie do typów wbudowanych. Typy można przypisać do przedziałów w scenie lub parametrów wyrażeń treningowych intencji. Typy można właściwie traktować jako wyliczenia. Uwaga: nazwa typu jest podana w nazwie pliku.

Zapis JSON
{
  "exclusions": [
    string
  ],

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

string

Zestaw wyjątkowych słów/wyrażeń, których nie należy dopasowywać według typu. Uwaga: jeśli słowo/wyrażenie pasuje do typu, ale znajduje się na liście wykluczeń, nie zostanie uwzględnione w wyniku wyodrębniania parametru. To pole można zlokalizować.

Pole sumy sub_type. Wybór podtypu na podstawie typu dopasowania, które chcesz wykonać. sub_type może mieć tylko jedną z tych wartości:
synonym

object (SynonymType)

Typ synonimów, który jest zasadniczo wyliczeniem.

regularExpression

object (RegularExpressionType)

Typ wyrażenia regularnego; umożliwia dopasowanie wyrażeń regularnych.

freeText

object (FreeTextType)

Typ FreeText.

SynonymType

Typ, który pasuje do tekstu za pomocą zestawu synonimów.

Zapis JSON
{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Pola
matchType

enum (MatchType)

Opcjonalnie. Typ dopasowania dla synonimu.

acceptUnknownValues

boolean

Opcjonalnie. Gdy zasada ma wartość Prawda, dopasowanie jest dopasowywane do nieznanych słów i wyrażeń na podstawie otaczających go danych wejściowych i zamiaru, np. produktów, które można dodać do listy zakupów.

entities

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

To pole jest wymagane. Nazwana mapa z synonimami.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

MatchType

Typ dopasowania, którego będą używać wpisy tego typu. Dzięki temu wszystkie typy będą korzystać z tej samej metody dopasowania i umożliwi to zróżnicowanie dopasowania dla synonimów (tj. przybliżone lub ścisłe). Jeśli wartość to UNSPECIFIED, domyślnie przyjmuje się EXACT_MATCH.

Wartości w polu enum
UNSPECIFIED Domyślna wartość to EXACT_MATCH.
EXACT_MATCH Szuka dokładnego dopasowania synonimu lub nazwy.
FUZZY_MATCH Mniej niż EXACT_MATCH. Szuka dopasowań ścisłych oraz podobnych.

Element

Reprezentuje pole jednostki synonimu, które zawiera szczegóły pojedynczej pozycji w ramach typu.

Zapis JSON
{
  "display": {
    object (EntityDisplay)
  },
  "synonyms": [
    string
  ]
}
Pola
display

object (EntityDisplay)

Opcjonalnie. Wyświetlą się szczegóły elementu.

synonyms[]

string

Opcjonalnie. Lista synonimów elementu. To pole można zlokalizować.

EntityDisplay

Elementy, które będą wyświetlane w obszarze roboczym po wyodrębnieniu elementu określonego typu z zapytania. Dotyczy tylko aplikacji obsługujących Canvas. Tę wiadomość można zlokalizować.

Zapis JSON
{
  "iconTitle": string,
  "iconUrl": string
}
Pola
iconTitle

string

Opcjonalnie. Tytuł ikony.

iconUrl

string

To pole jest wymagane. Adres URL ikony.

RegularExpressionType

Typ, który pasuje do tekstu za pomocą wyrażeń regularnych. Tę wiadomość można zlokalizować.

Zapis JSON
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Pola
entities

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

To pole jest wymagane. Nazwana mapa jednostek, z których każdy zawiera ciągi regularne.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Element

Reprezentuje obiekt jednostki zawierający wyrażenie regularne używane do porównania.

Zapis JSON
{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}
Pola
display

object (EntityDisplay)

Opcjonalnie. Elementy, które będą wyświetlane w obszarze roboczym po wyodrębnieniu elementu z zapytania. Dotyczy tylko aplikacji obsługujących Canvas.

regularExpressions[]

string

To pole jest wymagane. Korzysta ze składni wyrażeń regularnych RE2 (więcej informacji znajdziesz na stronie https://github.com/google/re2/wiki/Syntax).

FreeTextType

Wpisz tekst, który pasuje do dowolnego tekstu, jeśli kontekst słów jest zbliżony do podanych przykładów treningowych.

Zapis JSON
{
  "display": {
    object (EntityDisplay)
  }
}
Pola
display

object (EntityDisplay)

Opcjonalnie. Elementy, które będą wyświetlane w obszarze roboczym po wyodrębnieniu elementu z zapytania. Dotyczy tylko aplikacji obsługujących Canvas.

EntitySet

Zestawy encji opisują wstępnie zdefiniowany zbiór encji, z których mogą pochodzić wartości wbudowanych parametrów intencji. Do zbiorów encji można się odwoływać z zestawu encji w wbudowanych parametrach intencji.

Zapis JSON
{
  "entities": [
    {
      object (Entity)
    }
  ]
}
Pola
entities[]

object (Entity)

To pole jest wymagane. Lista encji obsługiwanych przez ten zestaw encji.

Element

Encja, z której może pochodzić wartość wbudowanego parametru intencji.

Zapis JSON
{
  "id": string
}
Pola
id

string

To pole jest wymagane. Identyfikator elementu. Listę parametrów wbudowanych i ich obsługiwanych elementów znajdziesz na stronie https://developers.google.com/assistant/conversational/build/built-in-intents.

GlobalIntentEvent

Definiuje moduł obsługi intencji globalnej. Globalne zdarzenia intencji są ograniczone do całego projektu Actions i mogą być zastępowane przez moduły obsługi intencji w scenie. Nazwy intencji muszą być unikalne w obrębie projektu w Actions.

Intencje globalne można dopasować w dowolnym momencie podczas sesji, co pozwoli użytkownikom uzyskać dostęp do typowych procesów, takich jak „uzyskaj pomoc” czy „wróć do domu”. Można ich też używać do tworzenia precyzyjnych linków do określonych przepływów podczas wywoływania akcji.

Uwaga: nazwa intencji jest podana w nazwie pliku.

Zapis JSON
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Pola
transitionToScene

string

Opcjonalnie. Scena docelowa, do której ma przejść rozmowa. Obecny stan sceny zostaje zniszczony podczas przejścia.

handler

object (EventHandler)

Opcjonalnie. Moduł obsługi zdarzeń wyzwalany po dopasowaniu intencji. Należy wykonać przed przejściem do sceny docelowej. Ta opcja jest przydatna do generowania promptów w odpowiedzi na zdarzenia.

EventHandler

Określa moduł obsługi, który ma zostać wykonany po zdarzeniu. Przykładami zdarzeń są zdarzenia w scenie oparte na zamiarach i warunkach.

Zapis JSON
{
  "webhookHandler": string,

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

string

Nazwa modułu obsługi webhooka, który ma zostać wywołany.

Pole sumy prompt. Prompty mogą być wbudowane lub zawierać odwołania do nazw. prompt może mieć tylko jedną z tych wartości:
staticPrompt

object (StaticPrompt)

Wbudowany statyczny prompt. Może zawierać odwołania do zasobów w postaci ciągów znaków w pakietach.

staticPromptName

string

Nazwa statycznego promptu do wywołania.

StaticPrompt

Reprezentuje listę sugerowanych promptów, z których jeden zostanie wybrany jako prompt wyświetlany w odpowiedzi użytkownikowi. Tę wiadomość można zlokalizować.

Zapis JSON
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Pola
candidates[]

object (StaticPromptCandidate)

Lista sugerowanych próśb, które mają zostać wysłane do klienta. Każdy prompt ma selektor, który określa, kiedy można go użyć. Pierwszy selektor, który pasuje do żądania, zostanie wysłany, a pozostałe będą ignorowane.

StaticPromptCandidate

Reprezentuje statyczną propozycję promptu.

Zapis JSON
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Pola
selector

object (Selector)

Opcjonalnie. Kryteria zgodności tego promptu z żądaniem. Jeśli selektor jest pusty, ten komunikat będzie zawsze wywoływany.

promptResponse

object (StaticPromptResponse)

Odpowiedź przesłana z selektorem.

Selektor

Określa kryteria dopasowania promptu do żądania.

Zapis JSON
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Pola
surfaceCapabilities

object (SurfaceCapabilities)

Zestaw wymaganych funkcji platformy.

SurfaceCapabilities

Reprezentuje platformę, za pomocą której użytkownik wysyła żądanie do akcji.

Zapis JSON
{
  "capabilities": [
    enum (Capability)
  ]
}
Pola
capabilities[]

enum (Capability)

To pole jest wymagane. Możliwości platformy wysyłającej żądanie do akcji.

Funkcja

Możliwości obsługiwane przez platformę urządzenia w momencie żądania.

Wartości w polu enum
UNSPECIFIED Nieokreślona możliwość użycia powierzchni.
SPEECH Urządzenie może komunikować się z użytkownikiem za pomocą zamiany tekstu na mowę lub SSML.
RICH_RESPONSE Urządzenie może wyświetlać odpowiedzi z elementami rozszerzonymi, takie jak karty, listy i tabele.
LONG_FORM_AUDIO Urządzenie może odtwarzać długie multimedia, takie jak muzyka i podcasty.
INTERACTIVE_CANVAS Urządzenie może wyświetlić interaktywną odpowiedź na żądanie obiektu canvas.
HOME_STORAGE Urządzenie może obsługiwać zapisywanie i pobieranie miejsca na dane w domu.

StaticPromptResponse

Reprezentuje ustrukturyzowane odpowiedzi wysyłane do użytkownika, na przykład tekst, mowę, karty, dane obiektu canvas, elementy z sugestią itp.

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

object (StaticSimplePrompt)

Opcjonalnie. Pierwsza odpowiedź głosowa i tekstowa.

content

object (StaticContentPrompt)

Opcjonalnie. Treści takie jak karta, lista lub multimedia do wyświetlenia użytkownikowi.

lastSimple

object (StaticSimplePrompt)

Opcjonalnie. Ostatnia odpowiedź głosowa i tekstowa.

suggestions[]

object (Suggestion)

Opcjonalnie. Sugestie do wyświetlenia użytkownikowi, które zawsze pojawiają się na końcu odpowiedzi. Jeśli pole append w prompcie zawierającym treść ma wartość true, tytuły zdefiniowane w tym polu zostaną dodane do tytułów zdefiniowanych we wszystkich wcześniej zdefiniowanych sugestiach, a powielone wartości zostaną usunięte.

override

boolean

Opcjonalnie. Tryb łączenia tych wiadomości z wcześniej zdefiniowanymi wiadomościami. true usunie wszystkie wcześniej zdefiniowane wiadomości (pierwszą i ostatnią prostą, treść, link do sugestii oraz obszar roboczy) oraz doda wiadomości zdefiniowane w tym promptie. false doda wiadomości zdefiniowane w tym promptie do wiadomości zdefiniowanych w poprzednich odpowiedziach. Ustawienie w tym polu wartości false umożliwi też dołączanie do niektórych pól w prostych promptach, promptach Sugestie i wierszu Canvas (część promptu Treść). Wiadomości Treść i linki są zawsze zastępowane, jeśli zostaną zdefiniowane w prompcie. Wartość domyślna to false.

canvas

object (StaticCanvasPrompt)

Odpowiedź używana w przypadku interaktywnego obszaru roboczego.

StaticSimplePrompt

Reprezentuje prosty komunikat do wysłania do użytkownika.

Zapis JSON
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Pola
variants[]

object (Variant)

Lista możliwych wariantów.

Wariant

Reprezentuje wariant, który jest częścią prostego promptu.

Zapis JSON
{
  "speech": string,
  "text": string
}
Pola
speech

string

Opcjonalnie. Reprezentuje mowę, która ma zostać odczytana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Domyślnie zamiana tekstu na mowę jest dodawana do poprzedniego prostego promptu. Jeśli pole override w wierszu zawierającym prompt ma wartość true, mowa zdefiniowana w tym polu zastąpi treść poprzedniego prostego promptu.

text

string

Opcjonalnie. Tekst do wyświetlenia w dymku czatu. Jeśli pole nie zostanie podane, wyświetlane będzie renderowanie powyższego pola mowy w trybie displayowym. Limit wynosi 640 znaków. Domyślnie tekst zostanie dołączony do tekstu poprzedniego prostego promptu. Jeśli pole override w wierszu zawierającym prompt ma wartość true, tekst zdefiniowany w tym polu zastąpi tekst poprzedniego prostego promptu.

StaticContentPrompt

Obiekt zastępczy stanowiący część treści elementu StaticPrompt.

Zapis JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}
Pola
Pole sumy content. Prompt może zawierać tylko jeden rodzaj treści. content może mieć tylko jedną z tych wartości:
card

object (StaticCardPrompt)

Kartę podstawową.

image

object (StaticImagePrompt)

Obraz.

table

object (StaticTablePrompt)

Karta z tabelą.

media

object (StaticMediaPrompt)

Odpowiedź wskazująca zestaw multimediów do odtworzenia.

list

object (StaticListPrompt)

Karta zawierająca listę opcji do wyboru.

collection

object (StaticCollectionPrompt)

Karta zawierająca listę opcji do wyboru.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Karta prezentująca zbiór stron internetowych do otwarcia.

StaticCardPrompt

Podstawowa karta, na której można wyświetlać określone informacje, np. obraz lub tekst.

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

string

Opcjonalnie. Ogólny tytuł karty.

subtitle

string

Opcjonalnie. Podtytuł karty.

text

string

To pole jest wymagane. Tekst główny karty, który jest potrzebny, o ile nie ma obrazu. Obsługuje ograniczony zestaw składni znaków Markdown na potrzeby formatowania.

image

object (StaticImagePrompt)

Opcjonalnie. Baner powitalny karty. Wysokość jest stała i wynosi 192 dp.

imageFill

enum (ImageFill)

Opcjonalnie. Sposób wypełnienia tła obrazu.

button

object (StaticLinkPrompt)

Opcjonalnie. Klikalny przycisk wyświetlany na karcie.

StaticImagePrompt

Obraz wyświetlany na karcie.

Zapis JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Pola
url

string

To pole jest wymagane. Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). np. https://www.agentx.com/logo.png.

alt

string

To pole jest wymagane. Opis tekstowy obrazu, który ma być używany na potrzeby ułatwień dostępu, np. przez czytniki ekranu.

height

integer

Opcjonalnie. Wysokość obrazu w pikselach.

width

integer

Opcjonalnie. Szerokość obrazu w pikselach.

ImageFill

Możliwe opcje wyświetlania obrazu, które wpływają na jego prezentację. Należy jej używać, gdy współczynnik proporcji obrazu nie jest zgodny ze współczynnikiem proporcji kontenera obrazów.

Wartości w polu enum
UNSPECIFIED Element ImageFill nieokreślony.
GRAY Wypełnij luki między obrazem a kontenerem obrazów za pomocą szarych pasków.
WHITE Wypełnij luki między obrazem a kontenerem obrazu za pomocą białych pasków.
CROPPED Obraz jest skalowany tak, aby jego szerokość i wysokość pasowały do wymiarów kontenera lub go przekraczały. Może to spowodować przycięcie górnej i dolnej części obrazu, jeśli jego wysokość jest większa niż wysokość kontenera. Jeśli natomiast szerokość przeskalowanego obrazu jest większa niż szerokość kontenera, obraz zostanie przycięty. Przypomina to „tryb powiększenia” na telewizorze panoramicznym podczas odtwarzania filmu w formacie 4:3.

StaticLinkPrompt

Definiuje link, który będzie wyświetlany jako element sugestii i może zostać otwarty przez użytkownika.

Zapis JSON
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
Pola
name

string

Nazwa linku

open

object (OpenUrl)

Określa zachowanie, gdy użytkownik otwiera link.

OpenUrl

Określa zachowanie, gdy użytkownik otwiera link.

Zapis JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
Pola
url

string

Pole adresu URL, które może być dowolnym z tych elementów: – Adres URL http/https umożliwiający otwarcie aplikacji lub strony internetowej

hint

enum (UrlHint)

Wskazuje wskazówkę dotyczącą typu adresu URL.

UrlHint

Różne typy wskazówek dotyczących adresów URL.

Wartości w polu enum
HINT_UNSPECIFIED Brak informacji
AMP Adres URL, który prowadzi bezpośrednio do treści AMP lub do kanonicznego adresu URL odwołującego się do treści AMP w elemencie <link rel="amphtml">.

StaticTablePrompt

Karta, która służy do wyświetlania tabeli tekstowej.

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

string

Opcjonalnie. Ogólny tytuł tabeli. Musi być ustawiony, jeśli podtytuł jest ustawiony.

subtitle

string

Opcjonalnie. Podtytuł tabeli.

image

object (StaticImagePrompt)

Opcjonalnie. Obraz powiązany z tabelą.

columns[]

object (TableColumn)

Opcjonalnie. Nagłówki i wyrównanie kolumn.

rows[]

object (TableRow)

Opcjonalnie. Dane w wierszach tabeli. Pierwsze 3 wiersze na pewno zostaną wyświetlone, ale inne mogą zostać wycięte na niektórych platformach. Przeprowadź test za pomocą symulatora, aby zobaczyć, które wiersze będą wyświetlane na danej powierzchni. Na platformach obsługujących funkcję WEB_BROWSER możesz przekierować użytkownika na stronę internetową z dodatkowymi danymi.

button

object (StaticLinkPrompt)

Opcjonalnie. Przycisk.

TableColumn

Opisuje kolumnę w tabeli.

Zapis JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Pola
header

string

Tekst nagłówka kolumny.

align

enum (HorizontalAlignment)

Wyrównanie w poziomie kolumny z treściami. Jeśli wartość nie zostanie określona, treść zostanie wyrównana do krawędzi wiodącej.

HorizontalAlignment

Wyrównanie treści w komórce.

Wartości w polu enum
UNSPECIFIED Wyrównanie poziome nieokreślone.
LEADING Przednia krawędź komórki. To jest ustawienie domyślne.
CENTER Treść jest wyrównana do środka kolumny.
TRAILING Treść jest wyrównana do końcowej krawędzi kolumny.

TableRow

Opisuje wiersz w tabeli.

Zapis JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Pola
cells[]

object (TableCell)

Komórki w tym wierszu. Pierwsze 3 komórki na pewno zostaną wyświetlone, ale inne mogą zostać wycięte na niektórych powierzchniach. Użyj symulatora, aby sprawdzić, które komórki są wyświetlane na danej powierzchni.

divider

boolean

Wskazuje, czy po każdym wierszu powinien znajdować się separator.

TableCell

Opisuje komórkę w wierszu.

Zapis JSON
{
  "text": string
}
Pola
text

string

Zawartość komórki.

StaticMediaPrompt

Zawiera informacje o multimediach, takie jak nazwa, opis, adres URL itp. Następny identyfikator: 11

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

enum (MediaType)

Typ multimediów tej odpowiedzi.

startOffset

string (Duration format)

Opóźnienie rozpoczęcia pierwszego obiektu multimedialnego.

Czas trwania w sekundach zawierający maksymalnie 9 cyfr po przecinku zakończony znakiem „s”. Przykład: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Opcjonalne typy sterowania multimediami, które może obsługiwać ta sesja odpowiedzi na multimedia. Jeśli zasada jest skonfigurowana, po wystąpieniu określonego zdarzenia multimedialnego żądania będą wysyłane do 3p. Jeśli zasada nie jest skonfigurowana, 3p nadal musi obsługiwać 2 domyślne typy elementów sterujących: FINISHED i FAILED.

mediaObjects[]

object (MediaObject)

Lista obiektów multimedialnych.

repeatMode

enum (RepeatMode)

Tryb powtarzania dla listy obiektów multimedialnych.

MediaType

Typ multimediów tej odpowiedzi.

Wartości w polu enum
MEDIA_TYPE_UNSPECIFIED NIEOKREŚLONA wartość
AUDIO Plik audio.
MEDIA_STATUS_ACK Odpowiedź na potwierdzenie raportu o stanie mediów.

OptionalMediaControls

Typy elementów sterujących multimediami, które może być obsługiwana opcjonalnie

Wartości w polu enum
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Nieokreślona wartość
PAUSED Zdarzenie wstrzymane. Wywoływane, gdy użytkownik wstrzymuje odtwarzanie multimediów.
STOPPED Wydarzenie zostało zatrzymane. Wywoływane, gdy użytkownik zakończy sesję 3P podczas odtwarzania multimediów.

MediaObject

Reprezentuje jeden obiekt multimedialny.

Zapis JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Pola
name

string

Nazwa tego obiektu multimedialnego.

description

string

Opis tego obiektu multimedialnego.

url

string

Adres URL wskazujący treści multimedialne.

image

object (MediaImage)

Obraz wyświetlany na karcie multimediów.

MediaImage

Obraz do wyświetlenia w elemencie MediaPrompt.

Zapis JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
Pola
Pole sumy image. Dozwolony jest tylko jeden typ elementu MediaImage. image może mieć tylko jedną z tych wartości:
large

object (StaticImagePrompt)

Duży obraz, np. okładka albumu itp.

icon

object (StaticImagePrompt)

Mała ikona obrazu wyświetlana po prawej stronie tytułu. Rozmiar zostanie zmieniony na 36 x 36 dp.

RepeatMode

Typy trybów powtarzania w przypadku listy obiektów multimedialnych.

Wartości w polu enum
REPEAT_MODE_UNSPECIFIED Odpowiednik WYŁ.
OFF Zakończ sesję multimediów na końcu ostatniego obiektu multimedialnego.
ALL Odtwarzanie w pętli na początku pierwszego obiektu multimedialnego po osiągnięciu końca ostatniego obiektu multimedialnego.

StaticListPrompt

Karta zawierająca listę opcji do wyboru.

Zapis JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Pola
title

string

Opcjonalnie. Tytuł listy.

subtitle

string

Opcjonalnie. Podtytuł listy.

items[]

object (ListItem)

To pole jest wymagane. Elementy listy.

ListItem

Element na liście.

Zapis JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Pola
key

string

To pole jest wymagane. Klucz NLU pasujący do nazwy klucza dostępu w powiązanym typie. Po kliknięciu elementu ten klucz zostanie z powrotem opublikowany jako parametr opcji wyboru.

title

string

To pole jest wymagane. Tytuł produktu. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w obrębie zestawu elementów.

description

string

Opcjonalnie. Tekst główny elementu.

image

object (StaticImagePrompt)

Opcjonalnie. Obraz elementu.

StaticCollectionPrompt

Karta prezentująca zbiór opcji do wyboru.

Zapis JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Pola
title

string

Opcjonalnie. Tytuł kolekcji.

subtitle

string

Opcjonalnie. Podtytuł kolekcji.

items[]

object (CollectionItem)

To pole jest wymagane. Elementy z kolekcji.

imageFill

enum (ImageFill)

Opcjonalnie. Typ opcji wyświetlania obrazu.

CollectionItem

Element w kolekcji.

Zapis JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Pola
key

string

To pole jest wymagane. Klucz NLU zgodny z nazwą klucza dostępu w powiązanym typie. Po kliknięciu elementu ten klucz zostanie z powrotem opublikowany jako parametr opcji wyboru.

title

string

To pole jest wymagane. Tytuł produktu. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w obrębie zestawu elementów.

description

string

Opcjonalnie. Tekst główny elementu.

image

object (StaticImagePrompt)

Opcjonalnie. Obraz elementu.

StaticCollectionBrowsePrompt

Prezentuje zestaw dokumentów internetowych jako zbiór dużych elementów. Elementy można wybrać, aby uruchomić powiązany dokument internetowy w przeglądarce.

Zapis JSON
{
  "items": [
    {
      object (CollectionBrowseItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Pola
items[]

object (CollectionBrowseItem)

Elementy w kolekcji Przeglądaj. Rozmiar listy powinien mieścić się w zakresie [2, 10].

imageFill

enum (ImageFill)

Opcja wyświetlania obrazów w kolekcji.

CollectionBrowseItem

Element w kolekcji.

Zapis JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (StaticImagePrompt)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
Pola
title

string

To pole jest wymagane. Tytuł elementu kolekcji.

description

string

Opis elementu kolekcji.

footer

string

Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty za pomocą wielokropka.

image

object (StaticImagePrompt)

Zdjęcie elementu kolekcji.

openUriAction

object (OpenUrl)

To pole jest wymagane. Identyfikator URI do otwarcia w przypadku wybrania elementu.

Sugestia

Reprezentuje element z sugestią, czyli element interfejsu wyświetlany dla wygody użytkownika.

Zapis JSON
{
  "title": string
}
Pola
title

string

To pole jest wymagane. Tekst wyświetlany w elemencie sugestii. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w zestawie elementów sugestii. Maks. 25 znaków

StaticCanvasPrompt

Reprezentuje odpowiedź Interactive Canvas, która ma zostać wysłana do użytkownika. Tej opcji można użyć w połączeniu z polem firstSimple w komunikacie zawierającym prośbę o rozpoczęcie rozmowy z użytkownikiem, a nie tylko do wyświetlenia interaktywnej odpowiedzi canvas.

Zapis JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}
Pola
url

string

To pole jest wymagane. Adres URL widoku internetowego do wczytania.

data[]

value (Value format)

Opcjonalnie. Dane JSON, które mają być przekazywane do strony internetowej trybu interaktywnego w formie zdarzenia. Jeśli pole override w wierszu zawierającym prośbę zawiera wartość false, wartości danych zdefiniowane w tym promptie Canvas zostaną dodane po wartościach danych zdefiniowanych w poprzednich promptach Canvas.

suppressMic

boolean

Opcjonalnie. Wartość prawda oznacza, że po pokazaniu użytkownikowi tej immersyjnej odpowiedzi mikrofon się nie uruchamia, aby rejestrować sygnał.

sendStateDataToCanvasApp

boolean

Opcjonalnie. Jeśli jest ustawiona wartość true, metadane związane z rozmowami są dołączane, a następnie są odsyłane do aplikacji Canvas.

enableFullScreen

boolean

Opcjonalnie. Jeśli true aplikacja Canvas zajmuje pełny ekran i nie będzie miała nagłówka na górze. Na ekranie wczytywania będzie również widoczny komunikat z podaną nazwą akcji, nazwą dewelopera i instrukcjami jej zamykania. Wartość domyślna: false

Oświetlenie

Scena jest podstawową jednostką sterowania podczas projektowania rozmowy. Sceny można łączyć z innymi scenami, generować prompty dla użytkownika i definiować przedziały. Nazwa sceny jest podana w nazwie pliku.

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

object (EventHandler)

Moduł obsługi do wywołania przy przechodzeniu do tej sceny.

intentEvents[]

object (IntentEvent)

Lista zdarzeń wywoływanych na podstawie intencji. Te zdarzenia mogą być wywoływane w dowolnym momencie po wywołaniu modułu on_load. Ważne – te zdarzenia definiują zestaw intencji ograniczonych do tej sceny i mają pierwszeństwo przed wszystkimi zdarzeniami zdefiniowanymi globalnie, które mają te same intencje lub swoje wyrażenia wyzwalające. Nazwy intencji muszą być niepowtarzalne w obrębie sceny.

conditionalEvents[]

object (ConditionalEvent)

Lista zdarzeń do wywołania na podstawie instrukcji warunkowych. Są one oceniane po wypełnieniu formularza lub bezpośrednio po on_load, jeśli scena nie ma formularza (ocena jest przeprowadzana tylko raz). Uruchomione zostanie tylko pierwsze pasujące zdarzenie.

slots[]

object (Slot)

Uporządkowana lista przedziałów. Każdy przedział określa typ danych, które będzie rozpoznawany, oraz konfigurację w celu dostosowania sposobu obsługi tej rozdzielczości (np. prompty).

onSlotUpdated

object (EventHandler)

Moduł obsługi jest wywoływany, gdy zmiana stanu przedziału nie jest spowodowana aktualizacjami w innym module obsługi. Umożliwia to unieważnienie przedziałów, unieważnienie sceny lub inne zmiany stanu sceny.

IntentEvent

Rejestruje zdarzenia uruchamiane w wyniku dopasowania intencji.

Zapis JSON
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Pola
intent

string

To pole jest wymagane. Intencja aktywująca zdarzenie.

transitionToScene

string

Opcjonalnie. Scena docelowa, do której ma przejść rozmowa. Obecny stan sceny zostaje zniszczony podczas przejścia.

handler

object (EventHandler)

Opcjonalnie. Moduł obsługi zdarzeń wyzwalany po dopasowaniu intencji. Należy wykonać przed przejściem do sceny docelowej. Ta opcja jest przydatna do generowania promptów w odpowiedzi na zdarzenia.

ConditionalEvent

Rejestruje zdarzenia wywoływane w wyniku spełnienia warunku.

Zapis JSON
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Pola
condition

string

To pole jest wymagane. Filtruj warunek uruchamiania tego zdarzenia. Jeśli warunek zostanie spełniony, wywołany jest powiązany z nim element handler. Obsługiwane są następujące odwołania do zmiennych: $session – umożliwia odwoływanie się do danych w pamięci sesji. $user – do odwoływania się do danych zapisanych w pamięci użytkownika. Obsługiwane są te operatory logiczne (z przykładami): &&session.params.counter > 0 && session.params.counter < 100 ||session.params.foo == "John" || session.params.counter == "Adam" !!(session.params.counter == 5) Obsługiwane są te porównania: ==, !=, <, >, <=, >= Obsługiwane są następujące operatory listy i ciągi tekstowe (z przykładami): in - „Watermelon” w session.params.fruitList size - size(session.params.fruitList) > 2 substringsession.params.fullName.contains("John")

transitionToScene

string

Opcjonalnie. Scena docelowa, do której ma przejść wątek, gdy powiązany z nim warunek zostanie zweryfikowany jako „prawda”. Obecny stan sceny zostaje zniszczony podczas przejścia.

handler

object (EventHandler)

Opcjonalnie. Moduł obsługi zdarzeń, który jest wyzwalany, gdy powiązany warunek zostanie oceniony jako true. Należy wykonać przed przejściem do sceny docelowej. Ta opcja jest przydatna do generowania promptów w odpowiedzi na zdarzenia.

Boks

Konfiguracja przedziału. Przedziały to pojedyncze jednostki danych, które mogą być wypełniane przy użyciu języka naturalnego (np. parametrów intencji), parametrów sesji i innych źródeł.

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

string

To pole jest wymagane. Nazwa boksu.

type

object (ClassReference)

To pole jest wymagane. Deklaruje typ danych tego boksu.

required

boolean

Opcjonalnie. Wskazuje, czy boks musi zostać wypełniony przed przejściem dalej. W przypadku wymaganych przedziałów, które nie są wypełnione, użytkownik zobaczy komunikat, który można dostosować.

promptSettings

object (PromptSettings)

Opcjonalnie. Rejestruje komunikaty dotyczące różnych etapów wypełniania przedziałów.

commitBehavior

object (CommitBehavior)

Opcjonalnie. Zachowanie zatwierdzenia związane z przedziałem.

config

value (Value format)

Opcjonalnie. Dodatkowa konfiguracja powiązana z przedziałem, który jest używany do jego wypełnienia. Format konfiguracji zależy od typu przedziału. Do tej konfiguracji można dodać odniesienia do zasobów do użytkownika lub parametru sesji. Ta konfiguracja jest potrzebna do wypełniania przedziałów związanych z transakcjami i zaangażowaniem użytkowników.

Przykład: w przypadku boksu typu actions.type.CompleteBuyValue przedstawiona poniżej konfiguracja przedstawia zamówienie towaru cyfrowego z odniesieniem do parametru sesji userSelectedSkuId zdefiniowanego przez klienta:

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

defaultValue

object (DefaultValue)

Opcjonalnie. Konfiguracja wypełniania wartości domyślnej tego przedziału.

PromptSettings

Pojedyncze miejsce, w którym definiuje się prompty dotyczące przedziałów.

Zapis JSON
{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}
Pola
initialPrompt

object (EventHandler)

Pytaj o wartość boksu. Przykład: „Jaki rozmiar chcesz wybrać?”.

noMatchPrompt1

object (EventHandler)

Monit o przyznanie, gdy dane wejściowe użytkownika po raz pierwszy nie pasują do oczekiwanego typu wartości dla boksu. Przykład: „Nie rozumiem”.

noMatchPrompt2

object (EventHandler)

Monit o przyznanie, gdy dane wejściowe użytkownika nie pasują po raz drugi do oczekiwanego typu wartości w tym przedziale. Przykład: „Nie rozumiem”.

noMatchFinalPrompt

object (EventHandler)

Monit o przyznanie, gdy dane wejściowe użytkownika nie pasują po raz ostatni do oczekiwanego typu wartości w tym przedziale. Przykład: „Nie rozumiem”.

noInputPrompt1

object (EventHandler)

Monit do podania, gdy użytkownik nie wprowadzi danych po raz pierwszy. Przykład: „Nie rozumiem”.

noInputPrompt2

object (EventHandler)

Monit o przyznanie, gdy użytkownik nie wprowadzi danych po raz drugi. Przykład: „Nie rozumiem”.

noInputFinalPrompt

object (EventHandler)

Monit o przyznanie, gdy użytkownik po raz ostatni nie wpisał danych. Przykład: „Nie rozumiem”.

CommitBehavior

Komunikat opisujący zachowanie zatwierdzenia związane z przedziałem po jego wypełnieniu.

Zapis JSON
{
  "writeSessionParam": string
}
Pola
writeSessionParam

string

Parametr sesji do zapisywania wartości boksu po jej wypełnieniu. Pamiętaj, że zagnieżdżone ścieżki nie są obecnie obsługiwane. „$$” służy do zapisywania wartości boksu w parametrze sesji o tej samej nazwie co boks. Np.: writeSessionParam = "owoc" odpowiada parametrowi "$session.params.fruit". writeSessionParam = "ticket" odpowiada parametrowi "$session.params.ticket".

DefaultValue

Konfiguracja wypełniania wartości domyślnej tego przedziału.

Zapis JSON
{
  "sessionParam": string,
  "constant": value
}
Pola
sessionParam

string

Opcjonalnie. Parametr sesji używany do inicjowania wartości boksu, jeśli zawiera wartość, która nie jest pusta. Typ wartości musi być zgodny z typem boksu. Pamiętaj, że zagnieżdżone ścieżki nie są obecnie obsługiwane. Na przykład: sessionParam = "fruit" odpowiada wartości $session.params.fruit. sessionParam = "ticket" odpowiada wartości $session.params.ticket.

constant

value (Value format)

Opcjonalnie. Stała wartość domyślna przedziału. Będzie ona używana tylko wtedy, gdy wartość tego boksu nie została wypełniona za pomocą sessionParam. Typ tej wartości musi odpowiadać typowi boksu.

DataFiles

Otoka powtórzonego pliku danych. Pole powtarzane nie może znajdować się w jednym z tych elementów.

Zapis JSON
{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}
Pola
dataFiles[]

object (DataFile)

Wiele plików danych.

DataFile

Reprezentuje pojedynczy plik zawierający nieuporządkowane dane. Mogą to być na przykład pliki graficzne, pliki audio i kod źródłowy funkcji w Cloud Functions.

Zapis JSON
{
  "filePath": string,
  "contentType": string,
  "payload": string
}
Pola
filePath

string

Ścieżka względna pliku danych z katalogu głównego projektu w strukturze pliku SDK. Dozwolone ścieżki do plików: – obrazy: resources/images/{multiple directories}?/{ImageName}.{extension} – audio: resources/audio/{multiple directories}?/{AudioFileName}.{extension} – kod wbudowanej funkcji w Cloud Functions: webhooks/{WebhookName}.zip – dozwolone rozszerzenia: – obrazy: png, jpg, jpeg – dźwięk: mp3, mpeg – wbudowane funkcje Cloud Functions: zip

contentType

string

To pole jest wymagane. Typ treści tego zasobu. Przykład: text/html. Typ treści musi być zgodny ze specyfikacją (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). Funkcje w Cloud Functions muszą być w formacie ZIP, a typ treści to application/zip;zip_type=cloud_function. Parametr zip_type wskazuje, że kod ZIP jest przeznaczony do funkcji w Cloud Functions.

payload

string (bytes format)

Zawartość pliku danych. Mogą to być na przykład nieprzetworzone bajty obrazów, pliki audio lub pliki w formacie ZIP w Cloud Functions. Obowiązuje rygorystyczny limit 10 MB rozmiaru ładunku.

Ciąg zakodowany w formacie base64.