- Zapis JSON
- ConfigFiles
- ConfigFile
- Plik manifestu
- Działania
- CustomAction
- Zaangażowanie
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Ustawienia
- Kategoria
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Moduł obsługi
- HttpsEndpoint
- InlineCloudFunction
- Zamiar
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Typ
- SynonymType
- MatchType
- Jednostka
- EntityDisplay
- RegularExpressionType
- Jednostka
- FreeTextType
- EntitySet
- Jednostka
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Selektor
- SurfaceCapabilities
- Zdolność
- StaticPromptResponse
- StaticSimplePrompt
- Wersja
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Sugestia
- StaticCanvasPrompt
- Scena
- IntentEvent
- ConditionalEvent
- Gniazdo
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Paczka z listą plików.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy file_type . Jednocześnie do serwera można wysyłać tylko jeden typ plików: pliki konfiguracyjne lub pliki danych. file_type może mieć tylko jedną z tych wartości: |
||
configFiles |
Lista plików konfiguracyjnych. Obejmuje to plik manifestu, ustawienia, pakiety zasobów modelu interakcji i nie tylko. |
|
dataFiles |
Lista plików danych. Obejmuje to obraz, plik audio i kod źródłowy funkcji w Cloud Functions. |
ConfigFiles
Paczka z powtarzającymi się plikami konfiguracyjnymi. Pola powtarzane nie mogą występować w jednym z.
Zapis JSON | |
---|---|
{
"configFiles": [
{
object ( |
Pola | |
---|---|
configFiles[] |
Wiele plików konfiguracyjnych. |
ConfigFile
Reprezentuje jeden plik zawierający uporządkowane dane. Deweloperzy mogą zdefiniować większość swojego projektu za pomocą uporządkowanych konfiguracji, w tym Actions (Działania), Settings (Ustawienia) i Fulfillment (Realizacja).
Zapis JSON | |
---|---|
{ "filePath": string, // Union field |
Pola | ||
---|---|---|
filePath |
Względna ścieżka pliku konfiguracyjnego z katalogu głównego projektu w strukturze plików SDK. Każdy z poniższych typów plików ma dozwoloną ścieżkę pliku. Przykład: settings/settings.yaml |
|
Pole sumy file . Każdy typ pliku konfiguracyjnego powinien mieć odpowiednie pole w jednym z. file może mieć tylko jedną z tych wartości: |
||
manifest |
Jeden plik manifestu. Dozwolona ścieżka pliku: |
|
actions |
Plik z pojedynczym działaniem ze wszystkimi zdefiniowanymi działaniami. Dozwolone ścieżki plików: |
|
settings |
Konfiguracja pojedynczych ustawień, która obejmuje ustawienia, których nie można zlokalizować, oraz domyślne ustawienia języka projektu (jeśli zostały określone). W przypadku pliku zastąpienia ustawień regionalnych zostanie wypełnione tylko pole localizedSettings. Dozwolone ścieżki plików: |
|
webhook |
Definicja pojedynczego webhooka. Dozwolona ścieżka pliku: |
|
intent |
Definicja pojedynczej intencji. Dozwolone ścieżki plików: |
|
type |
Definicja jednego typu. Dozwolone ścieżki plików: |
|
entitySet |
Definicja pojedynczego zestawu encji. Dozwolone ścieżki plików: |
|
globalIntentEvent |
Definicja pojedynczego globalnego zdarzenia intencji. Dozwolone ścieżki plików: |
|
scene |
Definicja pojedynczej sceny. Dozwolone ścieżki plików: |
|
staticPrompt |
Definicja pojedynczego prompta statycznego. Dozwolone ścieżki plików: |
|
accountLinkingSecret |
Metadane odpowiadające tajnym kluczowi klienta używanym podczas łączenia kont. Dozwolona ścieżka pliku: |
|
resourceBundle |
Jeden pakiet zasobów, który jest mapą z ciągu znaków na ciąg lub listę ciągów. Pakiety zasobów mogą służyć do lokalizowania ciągów znaków w promptach statycznych. Dozwolone ścieżki plików: |
Plik manifestu
Zawiera informacje przeznaczone do transportu nie są związane z konkretnym projektem i można je przenosić między projektami.
Zapis JSON | |
---|---|
{ "version": string } |
Pola | |
---|---|
version |
Wersja formatu pliku. Bieżąca wersja formatu pliku to 1.0. Przykład: „1.0” |
Działania
Reprezentuje listę działań zdefiniowanych w projekcie.
Zapis JSON | |
---|---|
{
"custom": {
string: {
object ( |
Pola | |
---|---|
custom |
Zmapuj z intencji na działania niestandardowe, aby skonfigurować wywoływanie w projekcie. Intencje wywołania mogą obejmować intencje systemowe lub intencje niestandardowe zdefiniowane w sekcji „custom/intents/” pakietu SDK. Wszystkie zdefiniowane tutaj intencje (intencje systemowe i niestandardowe intencje) muszą mieć odpowiedni plik intencji w katalogu „custom/global/” pakietu SDK. Obiekt zawierający listę par |
CustomAction
Szczegóły dotyczące działania niestandardowego.
Zapis JSON | |
---|---|
{
"engagement": {
object ( |
Pola | |
---|---|
engagement |
Mechanizmy angażowania powiązane z działaniem, które pomagają użytkownikom w zasubskrybowaniu powiadomień push i codziennych aktualności. Pamiętaj, że nazwa intencji podana w konfiguracji przedziału aktualizacji dziennych/powiadomień push musi odpowiadać intencji odpowiadającej temu działaniu, aby użytkownicy końcowi subskrybowali te aktualizacje. |
Zaangażowanie
Definiuje mechanizmy zaangażowania powiązane z tym działaniem. Dzięki temu użytkownicy mogą subskrybować powiadomienia push i codzienną aktualizację.
Zapis JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
Pola | |
---|---|
title |
Tytuł zaangażowania, który zostanie wysłany do użytkowników z prośbą o zgodę na otrzymywanie aktualizacji. Prośba wysyłana do użytkowników w przypadku codziennych aktualizacji będzie wyglądać tak: „O której godzinie mam wysyłać codzienne {title}” W przypadku powiadomień push będzie to wyglądać tak: „Czy mogę wysyłać powiadomienia push dotyczące tytułu {title}”? To pole można zlokalizować. |
pushNotification |
Ustawienia powiadomień push obsługiwane przez to zaangażowanie. |
actionLink |
Konfiguracja linku dla działania, która określa, czy linki udostępniania są włączone dla tej czynności, a jeśli tak, zawiera łatwą w obsłudze nazwę wyświetlaną linku. Interfejs ActionLink został wycofany. Zamiast tego użyj AssistantLink. |
assistantLink |
Konfiguracja linku dla działania, która określa, czy linki udostępniania są włączone dla tej czynności, a jeśli tak, zawiera łatwą w obsłudze nazwę wyświetlaną linku. |
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ługiwanych przez to zaangażowanie.
ActionLink
Wskazuje, czy udostępnianie linków jest włączone w przypadku tej czynności i powiązanych ustawień. Linki do działań służą do precyzyjnego łączenia użytkownika z konkretnym działaniem. Interfejs ActionLink został wycofany. Zamiast tego użyj AssistantLink.
Zapis JSON | |
---|---|
{ "title": string } |
Pola | |
---|---|
title |
Przyjazny dla użytkownika tytuł wyświetlany linku. |
AssistantLink
Wskazuje, czy udostępnianie linków jest włączone w przypadku tej czynności i powiązanych ustawień. Linki Asystenta służą do precyzyjnego linku do konkretnego działania użytkownika.
Zapis JSON | |
---|---|
{ "title": string } |
Pola | |
---|---|
title |
Przyjazny dla użytkownika tytuł wyświetlany linku. |
Ustawienia
Reprezentuje ustawienia projektu w Actions, które nie są związane z lokalizacją. Następny tag: 22
Zapis JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Pola | |
---|---|
projectId |
Identyfikator projektu Actions. |
defaultLocale |
Lokalizacja domyślna w projekcie. W przypadku wszystkich plików oprócz pliku |
enabledRegions[] |
Reprezentuje regiony, w których użytkownicy mogą wywoływać Twoje działania. Jest ona określana na podstawie lokalizacji obecności użytkownika. Nie można ustawić, jeśli ustawiono |
disabledRegions[] |
Reprezentuje regiony, w których Twoje akcje są zablokowane na podstawie lokalizacji użytkownika. Nie można ustawić, jeśli ustawiono |
category |
Kategoria tego projektu w Actions. |
usesTransactionsApi |
Określa, czy akcje mogą korzystać z transakcji (np. 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 |
Czy akcje mogą dokonywać transakcji za towary cyfrowe. |
usesInteractiveCanvas |
Określa, czy akcje mają korzystać z interaktywnego obszaru roboczego. |
usesHomeStorage |
Określa, czy akcje korzystają z funkcji miejsca na dane w domu. |
designedForFamily |
Określa, czy treści w Akcjach są przeznaczone dla całej rodziny. |
containsAlcoholOrTobaccoContent |
Czy akcje zawierają treści związane z alkoholem lub tytoniem. |
keepsMicOpen |
Określa, czy akcje mogą pozostawiać włączony mikrofon bez wyraźnego pytania podczas rozmowy. |
surfaceRequirements |
Wymagania dotyczące powierzchni, które musi obsługiwać platforma kliencka, aby możliwe było wywoływanie działań w tym projekcie. |
testingInstructions |
Swobodne instrukcje testowania dla weryfikatora działań (np. instrukcje łączenia kont). |
localizedSettings |
Zlokalizowane ustawienia dla domyślnego języka projektu. Każdy dodatkowy język powinien mieć własny plik ustawień w osobnym katalogu. |
accountLinking |
Zezwalaj użytkownikom na tworzenie i łączenie kont za pomocą Logowania przez Google lub Twojej własnej usługi OAuth. |
selectedAndroidApps[] |
Aplikacje na Androida, które mają dostęp do zakupów w Google Play podczas transakcji. Wybieramy je z aplikacji na Androida połączonych z projektem działań, które mają na celu potwierdzenie własności marki i udostępnienie dodatkowych funkcji. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/console/brand-verification. |
Kategoria
Wybór kategorii w projekcie Actions.
Wartości w polu enum | |
---|---|
CATEGORY_UNSPECIFIED |
Nieznany / nieokreślony. |
BUSINESS_AND_FINANCE |
Kategoria Biznes i Finanse. |
EDUCATION_AND_REFERENCE |
Kategoria Edukacja i źródła. |
FOOD_AND_DRINK |
Kategoria Jedzenie i napoje. |
GAMES_AND_TRIVIA |
Kategoria Gry i ciekawostki. |
HEALTH_AND_FITNESS |
Kategoria Zdrowie i fitness. |
KIDS_AND_FAMILY |
Dzieci i rodzina. |
LIFESTYLE |
Kategoria stylu ż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 |
Humor i ciekawostki. |
PRODUCTIVITY |
Kategoria produktywności. |
SHOPPING |
Zakupy Google. |
SOCIAL |
Kategoria społecznościowa. |
SPORTS |
Kategoria sportowa. |
TRAVEL_AND_TRANSPORTATION |
Kategoria 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 kliencka, aby możliwe było wywoływanie działań w projekcie.
Zapis JSON | |
---|---|
{
"minimumRequirements": [
{
object ( |
Pola | |
---|---|
minimumRequirements[] |
Minimalny zestaw uprawnień potrzebnych do wywoływania akcji w projekcie. Jeśli na powierzchni zabraknie któregoś z tych elementów, działanie nie zostanie wywołane. |
CapabilityRequirement
Reprezentuje wymaganie dotyczące dostępności danej funkcji.
Zapis JSON | |
---|---|
{
"capability": enum ( |
Pola | |
---|---|
capability |
Typ możliwości. |
SurfaceCapability
Możliwy zestaw funkcji platformy.
Wartości w polu enum | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Nieznany / nieokreślony. |
AUDIO_OUTPUT |
Urządzenie obsługuje wyjście audio. |
SCREEN_OUTPUT |
Surface obsługuje ekran/wizualizację. |
MEDIA_RESPONSE_AUDIO |
Surface obsługuje dźwięk w odpowiedzi na żądania multimediów. |
WEB_BROWSER |
Surface obsługuje przeglądarki internetowe. |
ACCOUNT_LINKING |
Surface obsługuje łączenie kont. |
INTERACTIVE_CANVAS |
Platforma obsługuje interaktywną płótno. |
HOME_STORAGE |
Surface obsługuje pamięć domową. |
LocalizedSettings
Reprezentuje ustawienia projektu w Actions, które są specyficzne dla języka użytkownika. W tym przypadku użytkownik oznacza użytkownika, który wywołuje Twoje akcje. 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 ( |
Pola | |
---|---|
displayName |
Wymagane. Domyślna wyświetlana nazwa tego projektu w Actions (jeśli tłumaczenie nie jest dostępne) |
pronunciation |
Wymagane. Wymowa wyświetlanej nazwy w celu wywołania jej w kontekście głosu (wypowiedzi). |
shortDescription |
Wymagane. Domyślny krótki opis projektu Actions (jeśli tłumaczenie nie jest dostępne). Obowiązuje limit 80 znaków. |
fullDescription |
Wymagane. Domyślny długi opis projektu Actions (jeśli tłumaczenie nie jest dostępne). Obowiązuje limit 4000 znaków. |
smallLogoImage |
Wymagane. Mały kwadratowy obraz o wymiarach 192 x 192 piksele. Należy go podać jako odwołanie do odpowiedniego obrazu w katalogu |
largeBannerImage |
Opcjonalnie: Duży obraz poziomy, 1920 x 1080 pikseli. Należy go podać jako odwołanie do odpowiedniego obrazu w katalogu |
developerName |
Wymagane. Nazwa dewelopera wyświetlana użytkownikom. |
developerEmail |
Wymagane. Kontaktowy adres e-mail dewelopera. |
termsOfServiceUrl |
Opcjonalnie: Adres URL warunków korzystania z usługi. |
voice |
Wymagane. Rodzaj głosu Asystenta Google, który użytkownicy słyszą podczas interakcji z Twoimi akcjami. Obsługiwane wartości to „male_1”, „male_2”, „female_1” i „female_2”. |
voiceLocale |
Opcjonalnie: Język określonego głosu. Jeśli go nie podasz, będzie używany język Asystenta użytkownika. Jeśli zostanie określony, język główny głosu musi być taki sam jak język określony w LocalizedSettings. |
privacyPolicyUrl |
Wymagane. Adres URL polityki prywatności. |
sampleInvocations[] |
Opcjonalnie: Przykładowe wyrażenia wywołania wyświetlane w opisie projektu w Actions w katalogu Asystenta. Dzięki temu użytkownicy nauczą się z niego korzystać. |
themeCustomization |
Opcjonalnie: Dostosowywanie motywu na potrzeby wizualnych komponentów akcji. |
ThemeCustomization
Style zastosowane do kart wyświetlanych użytkownikom
Zapis JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Pola | |
---|---|
backgroundColor |
Kolor tła kart. Działa jako kreacja zastępcza, jeśli interfejs |
primaryColor |
Główny kolor motywu działania będzie używany do ustawiania koloru tekstu tytułu i koloru tła działania na kartach Actions on Google. Przykład użycia: #FAFAFA |
fontFamily |
Rodzina czcionek, która będzie używana w tytułach kart. Obsługiwane czcionki: - Sans Serif - Sans Serif Medium - Sans Serif Pogrubienie - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Średni - Serif - Serif Pogrubienie - Monospace - Kursywa - Małe litery Sans Serif |
imageCornerStyle |
Styl obramowania obrazu na pierwszym planie kart. Możesz go np. zastosować do obrazu na pierwszym planie karty podstawowej lub karty karuzeli. |
landscapeBackgroundImage |
Tryb poziomy (co najmniej 1920 x 1200 pikseli). Należy go podać jako odwołanie do odpowiedniego obrazu w katalogu |
portraitBackgroundImage |
Tryb portretowy (co najmniej 1200 x 1920 pikseli). Należy go określić jako odwołanie do odpowiedniego obrazu w katalogu |
ImageCornerStyle
Opisuje sposób renderowania obramowania obrazów.
Wartości w polu enum | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
Nieokreślony / nieokreślony. |
CURVED |
Zaokrąglony róg obrazu. |
ANGLED |
Prostokątny róg obrazu. |
AccountLinking
Łączenie kont umożliwia Google zachęcanie użytkownika do logowania się w usługach internetowych w aplikacji.
W przypadku połączeń Logowanie przez Google i OAuth i Logowanie przez Google Google generuje identyfikator klienta identyfikujący Twoją aplikację („Identyfikator klienta wystawiony przez Google dla Twoich działań” w interfejsie konsoli). To pole jest tylko do odczytu i można je sprawdzić na stronie Łączenie kont w interfejsie konsoli. Więcej informacji: https://developers.google.com/assistant/identity/google-sign-in
Uwaga: w przypadku wszystkich typów ustawień łączenia kont (z wyjątkiem funkcji Logowanie przez Google) musisz podać nazwę użytkownika i hasło do konta testowego na stronie Settings.testing_instructions, aby zespół sprawdzający sprawdził aplikację (nie będą one widoczne dla użytkowników).
Zapis JSON | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Pola | |
---|---|
enableAccountCreation |
Wymagane. Jeśli |
linkingType |
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 |
Opcjonalnie: Wskazuje typ uwierzytelniania dla typu połączenia OAUTH. |
appClientId |
Opcjonalnie: Identyfikator klienta wystawiony przez Twoją aplikację dla Google. Jest to identyfikator klienta OAuth2 identyfikujący Google w Twojej usłudze. Ustaw tylko w przypadku korzystania z OAuth. |
authorizationUrl |
Opcjonalnie: Punkt końcowy strony internetowej logowania, który obsługuje kod OAuth2 lub niejawne przepływy. Adres URL musi używać protokołu HTTPS. Ustaw tylko w przypadku korzystania z OAuth. |
tokenUrl |
Opcjonalnie: Punkt końcowy OAuth2 na potrzeby wymiany tokenów. Adres URL musi używać protokołu HTTPS. To ustawienie nie jest ustawione, jeśli jako typu połączenia używasz protokołu OAuth z uwierzytelnieniem IMPLICIT. Ustaw tylko w przypadku korzystania z OAuth. |
scopes[] |
Opcjonalnie: Lista uprawnień, które użytkownik musi przyznać, aby korzystać z Twojej usługi. Ustaw tylko w przypadku korzystania z OAuth. Jeśli określasz to pole, podaj Warunki korzystania z usługi w informacjach o katalogu w sekcji LocalizedSettings.terms_of_service_url. |
learnMoreUrl |
Opcjonalnie: Strona internetowa w Twojej usłudze opisująca uprawnienia, które użytkownik udziela Google. Ustaw tylko w przypadku korzystania z OAuth i Logowania przez Google. Jeśli określasz to pole, podaj Warunki korzystania z usługi w informacjach o katalogu w sekcji LocalizedSettings.terms_of_service_url. |
useBasicAuthHeader |
Opcjonalnie: Jeśli ma wartość prawda, Google będzie przesyłać identyfikator klienta i klucz tajny przez nagłówek podstawowego uwierzytelniania HTTP. W przeciwnym razie Google używa identyfikatora klienta i tajnego klucza w treści posta. Ustaw tylko w przypadku korzystania z OAuth. Jeśli określasz to pole, podaj Warunki korzystania z usługi w informacjach o katalogu w sekcji LocalizedSettings.terms_of_service_url. |
LinkingType
Typ połączenia kont, które ma zostać wykonane.
Wartości w polu enum | |
---|---|
LINKING_TYPE_UNSPECIFIED |
Nie określono. |
GOOGLE_SIGN_IN |
Typ połączenia z Logowaniem przez Google. Jeśli korzystasz z tego typu połączenia, nie musisz ustawiać poniżej ż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 do zachęcania użytkownika do zalogowania 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 |
Uwierzytelnienie kodu pośredniego. Wymaga tylko podania adresu URL uwierzytelniania. |
Webhook
Metadane różnych typów webhooków. Jeśli używasz klucza 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 ( |
Pola | ||
---|---|---|
handlers[] |
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 |
Niestandardowy punkt końcowy HTTPS webhooka. |
|
inlineCloudFunction |
Metadane funkcji w Cloud Functions wdrożonego z kodu w folderze webhooków. |
Moduł obsługi
Deklaruje nazwę modułu obsługi webhooka. 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 |
Wymagane. Nazwa modułu obsługi. Musi być unikalna wśród wszystkich modułów obsługi w projekcie Actions. Możesz sprawdzić nazwę tego modułu obsługi, aby wywołać właściwą funkcję w kodzie źródłowym realizacji. |
HttpsEndpoint
Punkt końcowy REST, który informuje, gdy nie używasz edytora wbudowanego.
Zapis JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Pola | |
---|---|
baseUrl |
Podstawowy adres URL HTTPS 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 wskazówkami dotyczącymi stylu na stronie https://cloud.google.com/apis/design/custom_methods)). Na przykład podstawowy adres URL „https://gactions.service.com/api” otrzyma żądania z adresem URL „https://gactions.service.com/api:{method}”. |
httpHeaders |
Mapa parametrów HTTP, które mają być uwzględnione w żądaniu POST. Obiekt zawierający listę par |
endpointApiVersion |
Wersja protokołu używanego przez punkt końcowy. Jest to protokół wspólny dla wszystkich typów realizacji zamówień, a nie tylko dla typu realizacji Google. |
InlineCloudFunction
Przechowuje metadane wbudowanej funkcji w Cloud Functions wdrożonej z folderu webhooków.
Zapis JSON | |
---|---|
{ "executeFunction": string } |
Pola | |
---|---|
executeFunction |
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. Głosowe wyrażenia są dopasowywane do intencji użytkownika za pomocą opracowanego przez Google systemu rozumienia języka naturalnego (NLU). Dopasowanie intencji może wywoływać zdarzenia w projekcie rozmowy w celu postępów w rozmowie użytkownika. Nazwa intencji jest podana w nazwie pliku.
Zapis JSON | |
---|---|
{
"parameters": [
{
object ( |
Pola | |
---|---|
parameters[] |
Lista parametrów w wyrażeniach na potrzeby trenowania. Aby można było używać ich w wyrażeniu na potrzeby trenowania, musisz tutaj zdefiniować wszystkie parametry. |
trainingPhrases[] |
Wyrażenia na potrzeby trenowania pozwalają NLU Google automatycznie dopasować intencje do danych wejściowych użytkownika. Im więcej unikalnych wyrażeń podasz, tym większa szansa na dopasowanie intencji. Poniżej znajduje się format części wyrażenia na potrzeby trenowania, która jest oznaczona adnotacjami. Pamiętaj, że pole |
IntentParameter
Definicja parametru, którego można używać w wyrażeniach na potrzeby trenowania.
Zapis JSON | |
---|---|
{ "name": string, // Union field |
Pola | ||
---|---|---|
name |
Wymagane. Unikalna nazwa parametru intencji. Można go używać w warunkach i odpowiedziach, aby odwołać się do parametrów intencji wyodrębnionych przez NLU z parametrem $intent.params.[nazwa].rozstrzygnięty |
|
Pole sumy parameter_type . Typ parametru intencji. parameter_type może mieć tylko jedną z tych wartości: |
||
type |
Opcjonalnie: Deklaruje typ danych tego parametru. Nie należy go ustawiać w przypadku intencji wbudowanych. |
|
entitySetReferences |
Opcjonalnie: Odniesienia do zbiorów dozwolonych encji dla tego parametru intencji. Tej formuły można użyć tylko w przypadku parametrów intencji wbudowanej. Te odwołania wskazują na zestawy encji w elemencie „custom/entitySets” katalogu. |
ClassReference
Odwołanie do klasy, które służy do deklarowania typu pola lub zwracanej wartości. Wyliczenia są również typem klasy, do których można się odwoływać za pomocą klasy ClassReference.
Zapis JSON | |
---|---|
{ "name": string, "list": boolean } |
Pola | |
---|---|
name |
Wymagane. Nazwa wbudowanego lub niestandardowego typu parametru. Przykłady: |
list |
Opcjonalnie: Wskazuje, czy typ danych reprezentuje listę wartości. |
EntitySetReferences
Odniesienia do zestawu encji dla parametru intencji.
Zapis JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Pola | |
---|---|
entitySetReferences[] |
Wymagane. Odniesienia do zestawu encji dla parametru intencji. |
EntitySetReference
Odwołanie do zbioru dozwolonych encji dla tego parametru intencji.
Zapis JSON | |
---|---|
{ "entitySet": string } |
Pola | |
---|---|
entitySet |
Wymagane. Określa określony zbiór encji, które mają być uwzględniane 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 przypisywać do przedziałów w scenie lub parametrów wyrażeń używanych do trenowania intencji. W praktyce można je traktować jako wyliczenia. Uwaga: nazwa typu jest podana w nazwie pliku.
Zapis JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
Pola | ||
---|---|---|
exclusions[] |
Zestaw wyjątkowych słów lub wyrażeń, których nie należy dopasowywać według typu. Uwaga: jeśli słowo lub wyrażenie pasuje do typu, ale jest wymienione jako wykluczenie, nie zostanie zwrócone w wyniku wyodrębniania parametrów. To pole można zlokalizować. |
|
Pole sumy sub_type . Wybór podtypu w zależności od typu dopasowania, które ma zostać przeprowadzone. sub_type może mieć tylko jedną z tych wartości: |
||
synonym |
Typ synonimów, który jest zasadniczo wyliczeniem. |
|
regularExpression |
Typ wyrażenia regularnego, który umożliwia dopasowanie do wyrażenia regularnego. |
|
freeText |
Typ FreeText. |
SynonymType
Typ pasujący do tekstu według zestawu synonimów.
Zapis JSON | |
---|---|
{ "matchType": enum ( |
Pola | |
---|---|
matchType |
Opcjonalnie: Typ dopasowania synonimu. |
acceptUnknownValues |
Opcjonalnie: Gdy zasada ma wartość Prawda, dopasowuje nieznane słowa lub wyrażenia na podstawie otaczających je danych wejściowych i trenowania intencji, np. produktów, które można dodać do listy zakupów. |
entities |
Wymagane. Mapa nazwana elementów synonimów. Obiekt zawierający listę par |
MatchType
Typ dopasowania, którego będą używać wpisy tego typu. Dzięki temu wszystkie typy będą używać tej samej metody dopasowania, a dopasowywanie synonimów (tj. dopasowanie przybliżone i ścisłe) będzie możliwe. Jeśli wartość to UNSPECIFIED
, zostanie użyta domyślna 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 . Wyszukuje podobne i ścisłe dopasowania. |
Jednostka
Reprezentuje pole elementu synonimu, które zawiera szczegóły pojedynczego wpisu wewnątrz typu.
Zapis JSON | |
---|---|
{
"display": {
object ( |
Pola | |
---|---|
display |
Opcjonalnie: Wyświetlą się szczegóły elementu. |
synonyms[] |
Opcjonalnie: Lista synonimów elementu. To pole można zlokalizować. |
EntityDisplay
Elementy, które będą wyświetlane w obszarze roboczym po wyodrębnieniu z zapytania encji określonego typu. Dotyczy tylko aplikacji obsługujących kanwy. Tę wiadomość można zlokalizować.
Zapis JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
Pola | |
---|---|
iconTitle |
Opcjonalnie: Tytuł ikony. |
iconUrl |
Wymagane. Adres URL ikony. |
RegularExpressionType
Typ dopasowywany do tekstu przy użyciu wyrażeń regularnych. Tę wiadomość można zlokalizować.
Zapis JSON | |
---|---|
{
"entities": {
string: {
object ( |
Pola | |
---|---|
entities |
Wymagane. Mapa nazwanych jednostek, z których każdy zawiera ciągi tekstowe wyrażeń regularnych. Obiekt zawierający listę par |
Jednostka
Reprezentuje obiekt encji zawierający wyrażenie regularne używane do porównywania.
Zapis JSON | |
---|---|
{
"display": {
object ( |
Pola | |
---|---|
display |
Opcjonalnie: Elementy, które będą wyświetlane w obszarze roboczym po wyodrębnieniu encji z zapytania. Dotyczy tylko aplikacji obsługujących kanwy. |
regularExpressions[] |
Wymagane. Wykorzystują składnię wyrażenia regularnego RE2 (więcej informacji znajdziesz na stronie https://github.com/google/re2/wiki/Syntax). |
FreeTextType
Wpisz, który pasuje do dowolnego tekstu, jeśli kontekst otaczających słów jest zbliżony do podanych przykładów treningowych.
Zapis JSON | |
---|---|
{
"display": {
object ( |
Pola | |
---|---|
display |
Opcjonalnie: Elementy, które będą wyświetlane w obszarze roboczym po wyodrębnieniu encji z zapytania. Dotyczy tylko aplikacji obsługujących kanwy. |
EntitySet
Zbiory encji opisują wstępnie zdefiniowany zbiór encji, z których mogą pochodzić wartości parametrów wbudowanych intencji. Do zbiorów encji można się odwoływać z interfejsu entitySet we wbudowanych parametrach intencji.
Zapis JSON | |
---|---|
{
"entities": [
{
object ( |
Pola | |
---|---|
entities[] |
Wymagane. Lista jednostek obsługiwanych przez ten zestaw encji. |
Jednostka
Encja, z której może pochodzić wartość wbudowanego parametru intencji.
Zapis JSON | |
---|---|
{ "id": string } |
Pola | |
---|---|
id |
Wymagane. Identyfikator elementu. Listę parametrów wbudowanych i obsługiwanych przez nie znajdziesz na stronie https://developers.google.com/assistant/conversational/build/built-in-intents |
GlobalIntentEvent
Definiuje globalny moduł obsługi intencji. Zdarzenia intencji globalnej są ograniczone do całego projektu Actions i mogą zostać zastąpione przez moduły obsługi intencji w danej scenie. Nazwy intencji muszą być unikalne w obrębie projektu Actions.
Intencje globalne można dopasować w dowolnym momencie sesji, co pozwala użytkownikom na dostęp do typowych procesów, takich jak „uzyskaj pomoc” lub „wróć na stronę główną”. Za ich pomocą można też tworzyć precyzyjne linki do konkretnych przepływów podczas wywoływania akcji.
Pamiętaj, że nazwa intencji jest podana w nazwie pliku.
Zapis JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Pola | |
---|---|
transitionToScene |
Opcjonalnie: Scena docelowa, do której powinna przejść rozmowa. Stan bieżącej sceny zostaje zniszczony podczas przejścia. |
handler |
Opcjonalnie: Moduł obsługi zdarzeń, który jest aktywowany po spełnieniu intencji. Powinien zostać uruchomiony przed przejściem do sceny docelowej. Ta opcja jest przydatna do generowania promptów w odpowiedzi na zdarzenia. |
EventHandler
Definiuje moduł obsługi do wykonania po zdarzeniu. Przykładami zdarzeń w scenie są zdarzenia związane z intencjami i warunkami.
Zapis JSON | |
---|---|
{ "webhookHandler": string, // Union field |
Pola | ||
---|---|---|
webhookHandler |
Nazwa modułu obsługi webhooka do wywołania. |
|
Pole sumy prompt . Prompty mogą być wstawiane w treści lub mogą się przywoływać w treści. prompt może mieć tylko jedną z tych wartości: |
||
staticPrompt |
Wbudowany prompt statyczny. Może zawierać odwołania do zasobów w postaci ciągów znaków w pakietach. |
|
staticPromptName |
Nazwa statycznego promptu, który ma zostać wywołany. |
StaticPrompt
Reprezentuje listę kandydatów do promptów. Jeden z nich zostanie wybrany jako prompt, który będzie wyświetlany w odpowiedzi użytkownikowi. Tę wiadomość można zlokalizować.
Zapis JSON | |
---|---|
{
"candidates": [
{
object ( |
Pola | |
---|---|
candidates[] |
Lista promptów kandydujących, które mają zostać wysłane do klienta. Każdy prompt ma selektor, który określa, kiedy można go użyć. Zostanie wysłany pierwszy selektor pasujący do żądania, a pozostałe zostaną zignorowane. |
StaticPromptCandidate
Reprezentuje kandydata statycznego promptu.
Zapis JSON | |
---|---|
{ "selector": { object ( |
Pola | |
---|---|
selector |
Opcjonalnie: Kryteria, czy ten prompt pasuje do żądania. Jeśli selektor jest pusty, prośba zawsze będzie wywoływana. |
promptResponse |
Odpowiedź na prompt powiązana z selektorem. |
Selektor
Określa kryteria dopasowania promptu do żądania.
Zapis JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Pola | |
---|---|
surfaceCapabilities |
Zbiór wymaganych możliwości powierzchni. |
SurfaceCapabilities
Reprezentuje platformę, na której użytkownik wysyła żądanie do działania.
Zapis JSON | |
---|---|
{
"capabilities": [
enum ( |
Pola | |
---|---|
capabilities[] |
Wymagane. Możliwości platformy wysyłającej żądanie do akcji. |
Możliwości
Funkcje obsługiwane przez platformę urządzenia w momencie żądania.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Nieokreślona możliwość 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ć rozszerzone odpowiedzi, takie jak karty, listy i tabele. |
LONG_FORM_AUDIO |
Urządzenie może odtwarzać długie multimedia audio, takie jak muzyka i podcasty. |
INTERACTIVE_CANVAS |
Urządzenie może wyświetlać odpowiedź interaktywnego obszaru roboczego. |
WEB_LINK |
Urządzenie może używać linków internetowych w odpowiedziach rozszerzonych, aby otwierać przeglądarkę. |
HOME_STORAGE |
Urządzenie może obsługiwać zapisywanie i pobieranie miejsca na dane w domu. |
StaticPromptResponse
Reprezentuje uporządkowane odpowiedzi, które mają być wysyłane do użytkownika, na przykład tekst, mowę, karty, dane w obszarze roboczym, elementy z sugestią itp.
Zapis JSON | |
---|---|
{ "firstSimple": { object ( |
Pola | |
---|---|
firstSimple |
Opcjonalnie: Pierwsza odpowiedź głosowa i tekstowa. |
content |
Opcjonalnie: Treści takie jak karta, lista lub multimedia do wyświetlenia użytkownikowi. |
lastSimple |
Opcjonalnie: Ostatnia odpowiedź głosowa i tekstowa. |
suggestions[] |
Opcjonalnie: Sugestie do wyświetlenia użytkownikowi, które zawsze będą pojawiać się na końcu odpowiedzi. Jeśli pole |
link |
Opcjonalnie: Dodatkowy element z sugestią, który może prowadzić do powiązanej aplikacji lub witryny. Element zostanie wyrenderowany z tytułem „Otwórz |
override |
Opcjonalnie: Tryb sposobu łączenia tych wiadomości z wiadomościami zdefiniowanymi wcześniej. Aplikacja |
canvas |
Odpowiedź używana w przypadku interaktywnego obszaru roboczego. |
StaticSimplePrompt
Reprezentuje prosty prompt, który należy wysłać użytkownikowi.
Zapis JSON | |
---|---|
{
"variants": [
{
object ( |
Pola | |
---|---|
variants[] |
Lista możliwych wariantów. |
Wariant
Reprezentuje wariant, który jest częścią prostego promptu.
Zapis JSON | |
---|---|
{ "speech": string, "text": string } |
Pola | |
---|---|
speech |
Opcjonalnie: Reprezentuje mowę, która ma zostać wypowiedziana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Domyślnie mowa jest dołączana do mowy poprzedniego promptu prostego. Jeśli pole |
text |
Opcjonalnie: Tekst do wyświetlenia w dymku czatu. Jeśli wartość nie zostanie podana, będzie używane renderowanie powyższego pola mowy. Limit wynosi 640 znaków. Domyślnie tekst jest dołączany do tekstu poprzedniego prostego promptu. Jeśli pole |
StaticContentPrompt
Obiekt zastępczy części „treść” prompta statycznego.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy content . Prompt może zawierać tylko jeden typ treści. content może mieć tylko jedną z tych wartości: |
||
card |
karta podstawowa. |
|
image |
Obraz. |
|
table |
Karta tabeli. |
|
media |
Odpowiedź wskazująca zbiór multimediów do odtworzenia. |
|
list |
Karta zawierająca listę opcji do wyboru. |
|
collection |
Karta z listą opcji do wyboru. |
|
collectionBrowse |
Karta przedstawiająca zbiór stron internetowych do otwarcia. |
StaticCardPrompt
Podstawowa karta do wyświetlania pewnych informacji, np. obrazu i/lub tekstu.
Zapis JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Pola | |
---|---|
title |
Opcjonalnie: Ogólny tytuł karty. |
subtitle |
Opcjonalnie: Podtytuł karty. |
text |
Wymagane. Tekst karty. Potrzebny jest ten tekst, o ile nie ma zdjęcia. Obsługuje ograniczony zestaw składni formatowania Markdown na potrzeby formatowania. |
image |
Opcjonalnie: Baner powitalny karty. Wysokość jest stała na 192 dp. |
imageFill |
Opcjonalnie: Sposób wypełniania tła obrazu. |
button |
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 |
Wymagane. Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). Na przykład: |
alt |
Wymagane. Opis tekstowy obrazu, który ma być używany na potrzeby ułatwień dostępu, np. przez czytniki ekranu. |
height |
Opcjonalnie: Wysokość obrazu w pikselach. |
width |
Opcjonalnie: Szerokość obrazu w pikselach. |
ImageFill
Możliwe opcje wyświetlania obrazu, które wpływają na sposób jego wyświetlania. Tej opcji należy używać, gdy współczynnik proporcji obrazu nie pasuje do współczynnika proporcji kontenera obrazu.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Nieokreślona wartość ImageFill. |
GRAY |
Wypełnij luki między obrazem a kontenerem obrazu za pomocą szarych pasów. |
WHITE |
Wypełnij luki między obrazem a kontenerem obrazów białymi pasami. |
CROPPED |
Obraz jest skalowany w taki sposób, że jego szerokość i wysokość są zgodne lub przekraczają wymiary kontenera. Może to spowodować przycięcie górnej i dolnej części obrazu, jeśli wysokość skalowanego obrazu jest większa niż wysokość kontenera, lub przycięcie obrazu (lewego i prawego), jeśli szerokość obrazu jest większa niż szerokość kontenera. Ten tryb działa podobnie do „trybu powiększenia”. na telewizorze szerokoekranowym podczas odtwarzania filmu w formacie 4:3. |
StaticLinkPrompt
Definiuje link, który będzie wyświetlany jako element z sugestią i może być otwierany przez użytkownika.
Zapis JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Pola | |
---|---|
name |
Nazwa linku |
open |
Określa, co się stanie, gdy użytkownik otworzy link. |
OpenUrl
Określa, co się stanie, gdy użytkownik otworzy link.
Zapis JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Pola | |
---|---|
url |
Pole adresu URL, którym może być dowolny z tych elementów: – adresy URL http/https służące do otwierania aplikacji powiązanej z aplikacją lub strony internetowej |
hint |
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 |
Nie określono |
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 za pomocą atrybutu <link rel="amphtml"> . |
StaticTablePrompt
Karta tabeli zawierająca tabelę z tekstem.
Zapis JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Pola | |
---|---|
title |
Opcjonalnie: Ogólny tytuł tabeli. Ta opcja jest wymagana, jeśli ustawiono podtytuł. |
subtitle |
Opcjonalnie: Podtytuł tabeli. |
image |
Opcjonalnie: Obraz powiązany z tabelą. |
columns[] |
Opcjonalnie: Nagłówki i wyrównanie kolumn. |
rows[] |
Opcjonalnie: Dane wiersza tabeli. Pierwsze 3 wiersze na pewno się wyświetlą, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które wiersze będą wyświetlane dla danej platformy. Na platformach obsługujących funkcję |
button |
Opcjonalnie: Przycisk. |
TableColumn
Opisuje kolumnę w tabeli.
Zapis JSON | |
---|---|
{
"header": string,
"align": enum ( |
Pola | |
---|---|
header |
Tekst nagłówka kolumny. |
align |
Wyrównanie w poziomie kolumny z treściami. Jeśli nie określono inaczej, treść zostanie wyrównana do krawędzi początkowej. |
HorizontalAlignment
Wyrównanie treści w komórce.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Wyrównanie w poziomie nieokreślone. |
LEADING |
Górna krawędź komórki. Jest to 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 ( |
Pola | |
---|---|
cells[] |
Komórki w tym wierszu. Pierwsze 3 komórki są wyświetlane, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które komórki zostaną wyświetlone na danej powierzchni. |
divider |
Wskazuje, czy po każdym wierszu powinien być separator. |
TableCell
Opisuje komórkę w wierszu.
Zapis JSON | |
---|---|
{ "text": string } |
Pola | |
---|---|
text |
Zawartość tekstowa komórki. |
StaticMediaPrompt
Zawiera informacje o multimediach, takie jak nazwa, opis, URL itp. Następny identyfikator: 11
Zapis JSON | |
---|---|
{ "mediaType": enum ( |
Pola | |
---|---|
mediaType |
Typ multimediów w tej odpowiedzi. |
startOffset |
Odsunięcie pierwszego obiektu multimedialnego. Czas trwania w sekundach z maksymalnie dziewięcioma cyframi po przecinku, zakończony znakiem „ |
optionalMediaControls[] |
Opcjonalne typy elementów sterujących multimediami, które obsługuje ta sesja odpowiedzi na multimedia. Jeśli jest ustawione, żądanie jest przekazywane do firm zewnętrznych, gdy wystąpi określone zdarzenie multimedialne. Jeśli nie jest ustawiona, firma zewnętrzna musi nadal obsługiwać 2 domyślne typy ustawień: ZAKOŃCZONO i NIEPOWODZENIE. |
mediaObjects[] |
Lista obiektów multimedialnych. |
repeatMode |
Tryb powtarzania w przypadku listy obiektów multimediów. |
MediaType
Typ multimediów w tej odpowiedzi.
Wartości w polu enum | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
UNSPECIFIED wartości |
AUDIO |
Plik audio. |
MEDIA_STATUS_ACK |
Odpowiedź na potwierdzenie otrzymania raportu o stanie mediów. |
OptionalMediaControls
Typy elementów sterujących multimediami, które odpowiedź multimediów może być opcjonalnie obsługiwana
Wartości w polu enum | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Nieokreślona wartość |
PAUSED |
Zdarzenie wstrzymane. Wywoływane, gdy użytkownik wstrzyma multimedia. |
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 ( |
Pola | |
---|---|
name |
Nazwa tego obiektu multimedialnego. |
description |
Opis tego obiektu multimedialnego. |
url |
Adres URL wskazujący treści multimedialne. |
image |
Obraz wyświetlany z kartą multimediów. |
MediaImage
Obraz do wyświetlenia w MediaPrompt.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy image . Dozwolony jest tylko jeden typ obiektu MediaImage. image może mieć tylko jedną z tych wartości: |
||
large |
Duże zdjęcie, np. okładka albumu itp. |
|
icon |
Mała ikona obrazu wyświetlana po prawej stronie tytułu. Został zmniejszony do rozmiaru 36 x 36 dp. |
RepeatMode
Typy trybu powtarzania w przypadku listy obiektów multimedialnych.
Wartości w polu enum | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Odpowiednik ustawienia OFF. |
OFF |
Zakończ sesję multimediów na końcu ostatniego obiektu multimedialnego. |
ALL |
Utwórz pętlę 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 ( |
Pola | |
---|---|
title |
Opcjonalnie: Tytuł listy. |
subtitle |
Opcjonalnie: Podtytuł listy. |
items[] |
Wymagane. Pozycje listy. |
ListItem
element na liście.
Zapis JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Pola | |
---|---|
key |
Wymagane. Klucz NLU zgodny z nazwą klucza wpisu w powiązanym typie. Po kliknięciu elementu ten klucz zostanie wysłany z powrotem jako parametr wyboru opcji. |
title |
Wymagane. Tytuł produktu. Po kliknięciu tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w obrębie zestawu elementów. |
description |
Opcjonalnie: Tekst główny elementu. |
image |
Opcjonalnie: Obraz elementu. |
StaticCollectionPrompt
Karta, która przedstawia kolekcję opcji do wyboru.
Zapis JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Pola | |
---|---|
title |
Opcjonalnie: Tytuł kolekcji. |
subtitle |
Opcjonalnie: Podtytuł kolekcji. |
items[] |
Wymagane. Elementy kolekcji. |
imageFill |
Opcjonalnie: Typ opcji wyświetlania obrazu. |
CollectionItem
Element w kolekcji.
Zapis JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Pola | |
---|---|
key |
Wymagane. Klucz NLU zgodny z nazwą klucza wpisu w powiązanym typie Type. Po kliknięciu elementu ten klucz zostanie wysłany z powrotem jako parametr wyboru opcji. |
title |
Wymagane. Tytuł produktu. Po kliknięciu tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w obrębie zestawu elementów. |
description |
Opcjonalnie: Tekst główny elementu. |
image |
Opcjonalnie: Obraz elementu. |
StaticCollectionBrowsePrompt
Przedstawia zestaw dokumentów internetowych jako zbiór dużych elementów. Można je wybrać do uruchomienia powiązanego dokumentu internetowego w przeglądarce.
Zapis JSON | |
---|---|
{ "items": [ { object ( |
Pola | |
---|---|
items[] |
Elementy w kolekcji Przeglądaj. Rozmiar listy powinien mieścić się w zakresie [2, 10]. |
imageFill |
Opcja wyświetlania obrazów w kolekcji. |
CollectionBrowseItem
Element w kolekcji.
Zapis JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Pola | |
---|---|
title |
Wymagane. Tytuł elementu kolekcji. |
description |
Opis elementu kolekcji. |
footer |
Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty wielokropkiem. |
image |
Obraz elementu kolekcji. |
openUriAction |
Wymagane. Identyfikator URI do otworzenia po wybraniu elementu. |
Sugestia
Reprezentuje element z sugestią, czyli element interfejsu wyświetlany dla wygody użytkownika.
Zapis JSON | |
---|---|
{ "title": string } |
Pola | |
---|---|
title |
Wymagane. Tekst widoczny w elemencie z sugestią. Po kliknięciu ten tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w zestawie elementów z sugestią. Maks. 25 znaków |
StaticCanvasPrompt
Reprezentuje odpowiedź interaktywnego obszaru roboczego do wysłania użytkownikowi. Tej opcji można używać w połączeniu z polem firstSimple
w prośbie o rozmowę z użytkownikiem w uzupełnieniu do wyświetlenia interaktywnej odpowiedzi kanwy.
Zapis JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
Pola | |
---|---|
url |
Wymagane. Adres URL widoku internetowego do wczytania. |
data[] |
Opcjonalnie: Dane JSON przekazywane na stronę internetową środowiska immersyjnego jako zdarzenie. Jeśli pole |
suppressMic |
Opcjonalnie: Wartość prawda oznacza, że mikrofon nie włączy się do rejestrowania danych wejściowych po przedstawieniu użytkownikowi tej szczegółowej odpowiedzi. |
sendStateDataToCanvasApp |
Opcjonalnie: Jeśli |
enableFullScreen |
Opcjonalnie: Jeśli |
Sceneria
Scena to podstawowa jednostka kontroli podczas projektowania rozmowy. Można je łączyć w sieci z innymi scenami, generować prośby dla użytkownika i definiować przedziały. Nazwa sceny jest podana w nazwie pliku.
Zapis JSON | |
---|---|
{ "onEnter": { object ( |
Pola | |
---|---|
onEnter |
Moduł obsługi wywoływany przy przechodzeniu do tej sceny. |
intentEvents[] |
Lista zdarzeń, które są aktywowane na podstawie intencji. Te zdarzenia mogą zostać wywołane w dowolnym momencie po wywołaniu modułu obsługi on_load. Ważne – te zdarzenia definiują zbiór intencji ograniczonych do tej sceny i mają pierwszeństwo przed wszystkimi zdarzeniami zdefiniowanymi globalnie, które mają te same intencje lub te same wyrażenia wyzwalające. Nazwy intencji nie mogą się powtarzać w obrębie danej sceny. |
conditionalEvents[] |
Lista zdarzeń do aktywowania na podstawie instrukcji warunkowych. Są one oceniane po wypełnieniu formularza lub bezpośrednio po on_load, jeśli scena nie ma formularza (ocena przeprowadzana jest tylko raz). Zostanie uruchomione tylko pierwsze pasujące zdarzenie. |
slots[] |
Uporządkowana lista przedziałów. Każdy przedział określa typ danych, które będzie w nim przetwarzać, oraz konfigurację w celu dostosowania sposobu rozwiązania tego problemu (np. promptów). |
onSlotUpdated |
Moduł obsługi jest wywoływany w przypadku zmiany stanu przedziału, która nie jest spowodowana aktualizacjami w innym module obsługi. Umożliwia to unieważnienie przedziałów, unieważnienie sceny lub inne zmiany jej stanu. |
IntentEvent
Rejestruje zdarzenia, które są aktywowane na skutek dopasowania intencji.
Zapis JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Pola | |
---|---|
intent |
Wymagane. Intencja wyzwalająca zdarzenie. |
transitionToScene |
Opcjonalnie: Scena docelowa, do której powinna przejść rozmowa. Stan bieżącej sceny zostaje zniszczony podczas przejścia. |
handler |
Opcjonalnie: Moduł obsługi zdarzeń, który jest aktywowany po spełnieniu intencji. Powinien zostać uruchomiony przed przejściem do sceny docelowej. Ta opcja jest przydatna do generowania promptów w odpowiedzi na zdarzenia. |
ConditionalEvent
Rejestruje zdarzenia, które są aktywowane w wyniku spełnienia warunku.
Zapis JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Pola | |
---|---|
condition |
Wymagane. Warunek filtra, który ma zostać wywołany przez to zdarzenie. Jeśli warunek zostanie sprawdzony jako „prawda”, aktywowany zostanie powiązany element |
transitionToScene |
Opcjonalnie: Scena docelowa, do której powinna przejść rozmowa, gdy powiązany warunek zostanie oceniony jako „prawda”. Stan bieżącej sceny zostaje zniszczony podczas przejścia. |
handler |
Opcjonalnie: Moduł obsługi zdarzeń, który jest aktywowany, gdy powiązany warunek jest sprawdzany jako |
Boks
Konfiguracja przedziału. Przedziały to pojedyncze jednostki danych, które można wypełniać za pomocą języka naturalnego (np. parametrów intencji), parametrów sesji i innych źródeł.
Zapis JSON | |
---|---|
{ "name": string, "type": { object ( |
Pola | |
---|---|
name |
Wymagane. Nazwa boksu. |
type |
Wymagane. Deklaruje typ danych tego przedziału. |
required |
Opcjonalnie: Wskazuje, czy przed przejściem dalej trzeba wypełnić boks. Niewypełnione wymagane przedziały powodują wyświetlenie prośby, którą można dostosować. |
promptSettings |
Opcjonalnie: Rejestruje prompty na różne etapy wypełniania przedziałów. |
commitBehavior |
Opcjonalnie: Działanie zatwierdzenia powiązane z przedziałem. |
config |
Opcjonalnie: Dodatkowa konfiguracja powiązana z przedziałem służącym do jego wypełniania. Format konfiguracji zależy od typu przedziału. Odwołania do zasobów do parametru użytkownika lub sesji można dodać do tej konfiguracji. Ta konfiguracja jest potrzebna do wypełniania przedziałów związanych z transakcjami i zaangażowaniem użytkowników. Przykład: w przypadku przedziału typu actions.type.CompletePurchaseValue ta konfiguracja proponuje zamówienie towaru cyfrowego z odwołaniem do parametru sesji 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 |
Opcjonalnie: Konfiguracja wypełniania domyślnej wartości dla tego przedziału. |
PromptSettings
Pojedyncze miejsce, w którym definiuje się prompty dotyczące przedziałów.
Zapis JSON | |
---|---|
{ "initialPrompt": { object ( |
Pola | |
---|---|
initialPrompt |
Pytaj o samą wartość przedziału. Przykład: „Jaki rozmiar chcesz uzyskać?”. |
noMatchPrompt1 |
Pytaj, gdy dane wejściowe użytkownika po raz pierwszy nie pasują do oczekiwanego typu wartości w boksie. Przykład: „Nie rozumiem”. |
noMatchPrompt2 |
Pytaj, gdy po raz drugi dane wejściowe użytkownika nie pasują do oczekiwanego typu wartości w boksie. Przykład: „Nie rozumiem”. |
noMatchFinalPrompt |
Pytaj, gdy dane wejściowe użytkownika nie pasują do oczekiwanego typu wartości dla boksu po raz ostatni. Przykład: „Nie rozumiem”. |
noInputPrompt1 |
Pytaj, gdy użytkownik po raz pierwszy nie wpisze danych wejściowych. Przykład: „Nie rozumiem”. |
noInputPrompt2 |
Prompt, gdy użytkownik po raz drugi nie poda danych wejściowych. Przykład: „Nie rozumiem”. |
noInputFinalPrompt |
Prompt, gdy użytkownik ostatnio nie podał danych wejściowych. Przykład: „Nie rozumiem”. |
CommitBehavior
Komunikat opisujący zachowanie zatwierdzenia związane z boksem po jego wypełnieniu.
Zapis JSON | |
---|---|
{ "writeSessionParam": string } |
Pola | |
---|---|
writeSessionParam |
Parametr sesji służący do zapisywania wartości przedziału po jego wypełnieniu. Pamiętaj, że ścieżki zagnieżdżone nie są obecnie obsługiwane. „$$” służy do zapisywania wartości przedziału w parametrze sesji o tej samej nazwie co boks. Na przykład: writeSessionParam = "owoc" odpowiada „$session.params.fruit”. WriteSessionParam = "bilet" odpowiada „$session.params.ticket”. |
DefaultValue
Konfiguracja wypełniania domyślnej wartości dla tego przedziału.
Zapis JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
Pola | |
---|---|
sessionParam |
Opcjonalnie: Parametr sesji używany do inicjowania wartości przedziału, jeśli nie zawiera ona pustej wartości. Typ wartości musi pasować do typu boksu. Pamiętaj, że ścieżki zagnieżdżone nie są obecnie obsługiwane. Na przykład: |
constant |
Opcjonalnie: Stała wartość domyślna boksu. Będzie ona używana tylko wtedy, gdy wartość dla tego przedziału nie została wypełniona w polu |
DataFiles
Pakowanie dla powtórzonych plików danych. Pola powtarzane nie mogą występować w jednym z.
Zapis JSON | |
---|---|
{
"dataFiles": [
{
object ( |
Pola | |
---|---|
dataFiles[] |
Wiele plików danych. |
DataFile
Reprezentuje jeden plik zawierający nieuporządkowane dane. Mogą to być na przykład pliki graficzne, pliki audio oraz kod źródłowy funkcji w Cloud Functions.
Zapis JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Pola | |
---|---|
filePath |
Ścieżka względna pliku danych z katalogu głównego projektu w strukturze plików SDK. Dozwolone ścieżki plików: – Obrazy: |
contentType |
Wymagane. Typ treści zasobu. Przykład: |
payload |
Zawartość pliku danych. Mogą to być na przykład nieprzetworzone bajty obrazów, pliki audio lub format ZIP funkcji w Cloud Functions. Obowiązuje rygorystyczny limit 10 MB rozmiaru ładunku. Ciąg zakodowany w formacie base64. |