- Zapis JSON
- ConfigFiles
- ConfigFile
- Plik manifestu
- Czynności
- CustomAction
- Zaangażowanie
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Ustawienia
- Kategoria
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Moduł obsługi
- HttpsEndpoint
- InlineCloudFunction
- Intencja
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Typ
- SynonymType (Typ Synonimy)
- MatchType
- Encja
- EntityDisplay
- RegularExpressionType
- Encja
- FreeTextType.
- EntitySet
- Encja
- GlobalIntentEvent
- EventHandler
- StaticPrompt:
- StaticPromptCandidate
- Selektor
- SurfaceCapabilities
- Możliwości
- 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 (Ustawienia promptów)
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Otoka listy plików.
Zapis JSON | |
---|---|
{ // Union field |
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 |
Lista plików konfiguracji. Dotyczy to pliku manifestu, ustawień, pakietów zasobów modelu interakcji i innych informacji. |
|
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 ( |
Pola | |
---|---|
configFiles[] |
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 |
Pola | ||
---|---|---|
filePath |
Ś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 |
Jeden plik manifestu. Dozwolona ścieżka pliku: |
|
actions |
Pojedynczy plik działań ze wszystkimi zdefiniowanymi działaniami. Dozwolone ścieżki do plików: |
|
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: |
|
webhook |
Definicja pojedynczego webhooka. Dozwolona ścieżka pliku: |
|
intent |
Definicja pojedynczej intencji. Dozwolone ścieżki do plików: |
|
type |
Definicja pojedynczego typu. Dozwolone ścieżki do plików: |
|
entitySet |
Definicja zestawu pojedynczej encji. Dozwolone ścieżki do plików: |
|
globalIntentEvent |
Definicja pojedynczego globalnego zdarzenia intencji. Dozwolone ścieżki do plików: |
|
scene |
Definicja pojedynczej sceny. Dozwolone ścieżki do plików: |
|
staticPrompt |
Definicja pojedynczej statycznej promptu. Dozwolone ścieżki do plików: |
|
accountLinkingSecret |
Metadane odpowiadające tajnego klucza klienta używanego do łączenia kont. Dozwolona ścieżka pliku: |
|
resourceBundle |
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: |
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 |
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 ( |
Pola | |
---|---|
custom |
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 |
CustomAction
Szczegółowe informacje o działaniu niestandardowym.
Zapis JSON | |
---|---|
{
"engagement": {
object ( |
Pola | |
---|---|
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 ( |
Pola | |
---|---|
title |
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 |
Ustawienia powiadomień push obsługiwane przez to zaangażowanie. |
actionLink |
Konfiguracja linku dla działania, która określa, czy udostępnianie linków jest dla niego włączone, a jeśli tak, zawiera przyjazną dla użytkownika wyświetlaną nazwę linku. Interfejs ActionLink został wycofany. Zamiast tego użyj AssistantLink. |
assistantLink |
Konfiguracja linku dla działania, która określa, czy udostępnianie linków jest dla niego włączone, a jeśli tak, zawiera przyjazną dla użytkownika wyświetlaną nazwę 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ługiwane przez to zaangażowanie.
ActionLink
Wskazuje, czy udostępnianie linków jest włączone dla tego działania i odpowiadających im ustawień. Linki do działań służą do tworzenia precyzyjnych linków do konkretnych działań. Interfejs ActionLink został wycofany. Zamiast tego użyj AssistantLink.
Zapis JSON | |
---|---|
{ "title": string } |
Pola | |
---|---|
title |
Łatwy w użyciu tytuł linku. |
AssistantLink
Wskazuje, czy udostępnianie linków jest włączone dla tego działania i odpowiadających im ustawień. Linki Asystenta służą do tworzenia precyzyjnych linków do konkretnych działań.
Zapis JSON | |
---|---|
{ "title": string } |
Pola | |
---|---|
title |
Łatwy w użyciu tytuł linku. |
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 ( |
Pola | |
---|---|
projectId |
Identyfikator projektu Actions. |
defaultLocale |
Język domyślny w projekcie. W przypadku wszystkich plików z wyjątkiem |
enabledRegions[] |
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[] |
Reprezentuje regiony, w których Twoje akcje są zablokowane, na podstawie lokalizacji obecności użytkownika. Nie można ustawić wartości |
category |
Kategoria tego projektu w Actions. |
usesTransactionsApi |
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 |
Czy Akcja może dokonywać transakcji dotyczących produktów cyfrowych. |
usesInteractiveCanvas |
Określa, czy Działania używają interaktywnego obszaru roboczego. |
usesHomeStorage |
Określa, czy Działania korzystają z funkcji przechowywania danych w domu. |
designedForFamily |
Czy treści akcji są przeznaczone dla całej rodziny. |
containsAlcoholOrTobaccoContent |
Czy Akcja zawiera treści związane z alkoholem lub tytoniem. |
keepsMicOpen |
Określa, czy Działania mogą pozostawiać włączony mikrofon bez wyraźnego pytania o to podczas rozmowy. |
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 |
Instrukcje testowania swobodnego dla weryfikatora Actions (np. instrukcje łączenia kont). |
localizedSettings |
Zlokalizowane ustawienia 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 z wykorzystaniem logowania przez Google lub własnej usługi OAuth. |
selectedAndroidApps[] |
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 ( |
Pola | |
---|---|
minimumRequirements[] |
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 ( |
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 |
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 ( |
Pola | |
---|---|
displayName |
To pole jest wymagane. Domyślna wyświetlana nazwa tego projektu w Actions (jeśli nie ma dostępnego tłumaczenia) |
pronunciation |
To pole jest wymagane. Wymowa wyświetlanej nazwy wywołującej ją w kontekście głosu (wypowiedzi). |
shortDescription |
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 |
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 |
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 |
largeBannerImage |
Opcjonalnie. Duży obraz poziomy o wymiarach 1920 x 1080 pikseli. Powinien on być określony w odniesieniu do odpowiedniego obrazu w katalogu |
developerName |
To pole jest wymagane. Nazwa dewelopera, która będzie wyświetlana użytkownikom. |
developerEmail |
To pole jest wymagane. Kontaktowy adres e-mail dewelopera. |
termsOfServiceUrl |
Opcjonalnie. Adres URL warunków korzystania z usługi. |
voice |
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 |
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 |
To pole jest wymagane. Adres URL polityki prywatności. |
sampleInvocations[] |
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 |
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 ( |
Pola | |
---|---|
backgroundColor |
Kolor tła kart. Działa jako zastępcza, jeśli właściwość |
primaryColor |
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 |
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 |
Styl obramowania obrazu na pierwszym planie kart. Możesz go np. zastosować na obrazie na pierwszym planie karty podstawowej lub karty karuzeli. |
landscapeBackgroundImage |
Tryb poziomy (co najmniej 1920 x 1200 pikseli). Powinien on być określony w odniesieniu do odpowiedniego obrazu w katalogu |
portraitBackgroundImage |
Tryb portretowy (co najmniej 1200 x 1920 pikseli). Powinien on być określony w odniesieniu do odpowiedniego obrazu w katalogu |
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 ( |
Pola | |
---|---|
enableAccountCreation |
To pole jest wymagane. Jeśli |
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 |
Opcjonalnie. Wskazuje typ uwierzytelniania dla metody OAUTH linkType. |
appClientId |
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 |
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 |
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[] |
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 |
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 |
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 ( |
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 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 |
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 |
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 |
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ń, 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 |
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 ( |
Pola | |
---|---|
parameters[] |
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[] |
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 |
IntentParameter
Definicja parametru, którego można używać w wyrażeniach na potrzeby trenowania.
Zapis JSON | |
---|---|
{ "name": string, // Union field |
Pola | ||
---|---|---|
name |
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 |
Opcjonalnie. Deklaruje typ danych tego parametru. Nie należy go ustawiać dla intencji wbudowanych. |
|
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 |
To pole jest wymagane. Nazwa wbudowanego typu lub niestandardowego typu parametru. Przykłady: |
list |
Opcjonalnie. Wskazuje, czy typ danych przedstawia listę wartości. |
EntitySetReferences
Odwołania do zestawu encji dla parametru intencji.
Zapis JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Pola | |
---|---|
entitySetReferences[] |
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 |
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 |
Pola | ||
---|---|---|
exclusions[] |
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 |
Typ synonimów, który jest zasadniczo wyliczeniem. |
|
regularExpression |
Typ wyrażenia regularnego; umożliwia dopasowanie wyrażeń regularnych. |
|
freeText |
Typ FreeText. |
SynonymType
Typ, który pasuje do tekstu za pomocą zestawu synonimów.
Zapis JSON | |
---|---|
{ "matchType": enum ( |
Pola | |
---|---|
matchType |
Opcjonalnie. Typ dopasowania dla synonimu. |
acceptUnknownValues |
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 |
To pole jest wymagane. Nazwana mapa z synonimami. Obiekt zawierający listę par |
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 ( |
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 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 |
Opcjonalnie. Tytuł ikony. |
iconUrl |
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 ( |
Pola | |
---|---|
entities |
To pole jest wymagane. Nazwana mapa jednostek, z których każdy zawiera ciągi regularne. Obiekt zawierający listę par |
Element
Reprezentuje obiekt jednostki zawierający wyrażenie regularne używane do porównania.
Zapis JSON | |
---|---|
{
"display": {
object ( |
Pola | |
---|---|
display |
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[] |
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 ( |
Pola | |
---|---|
display |
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 ( |
Pola | |
---|---|
entities[] |
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 |
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 ( |
Pola | |
---|---|
transitionToScene |
Opcjonalnie. Scena docelowa, do której ma przejść rozmowa. Obecny stan sceny zostaje zniszczony podczas przejścia. |
handler |
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 |
Pola | ||
---|---|---|
webhookHandler |
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 |
Wbudowany statyczny prompt. Może zawierać odwołania do zasobów w postaci ciągów znaków w pakietach. |
|
staticPromptName |
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 ( |
Pola | |
---|---|
candidates[] |
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 ( |
Pola | |
---|---|
selector |
Opcjonalnie. Kryteria zgodności tego promptu z żądaniem. Jeśli selektor jest pusty, ten komunikat będzie zawsze wywoływany. |
promptResponse |
Odpowiedź przesłana z selektorem. |
Selektor
Określa kryteria dopasowania promptu do żądania.
Zapis JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Pola | |
---|---|
surfaceCapabilities |
Zestaw wymaganych funkcji platformy. |
SurfaceCapabilities
Reprezentuje platformę, za pomocą której użytkownik wysyła żądanie do akcji.
Zapis JSON | |
---|---|
{
"capabilities": [
enum ( |
Pola | |
---|---|
capabilities[] |
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. |
WEB_LINK |
Urządzenie może używać linków internetowych w odpowiedziach z elementami rozszerzonymi do otwierania przeglądarki. |
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 ( |
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 pojawiają się na końcu odpowiedzi. Jeśli pole |
link |
Opcjonalnie. Dodatkowy element sugestii, który może prowadzić do powiązanej aplikacji lub strony. Element zostanie wyrenderowany z tytułem „Otwórz |
override |
Opcjonalnie. Tryb łączenia tych wiadomości z wcześniej zdefiniowanymi wiadomościami. |
canvas |
Odpowiedź używana w przypadku interaktywnego obszaru roboczego. |
StaticSimplePrompt
Reprezentuje prosty komunikat do wysłania do użytkownika.
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ć 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 |
text |
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 |
StaticContentPrompt
Obiekt zastępczy stanowiący część treści elementu StaticPrompt.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy content . Prompt może zawierać tylko jeden rodzaj treści. content może mieć tylko jedną z tych wartości: |
||
card |
Kartę podstawową. |
|
image |
Obraz. |
|
table |
Karta z tabelą. |
|
media |
Odpowiedź wskazująca zestaw multimediów do odtworzenia. |
|
list |
Karta zawierająca listę opcji do wyboru. |
|
collection |
Karta zawierająca listę opcji do wyboru. |
|
collectionBrowse |
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 ( |
Pola | |
---|---|
title |
Opcjonalnie. Ogólny tytuł karty. |
subtitle |
Opcjonalnie. Podtytuł karty. |
text |
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 |
Opcjonalnie. Baner powitalny karty. Wysokość jest stała i wynosi 192 dp. |
imageFill |
Opcjonalnie. Sposób wypełnienia 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 |
To pole jest wymagane. Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). np. |
alt |
To pole jest 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 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 ( |
Pola | |
---|---|
name |
Nazwa linku |
open |
Określa zachowanie, gdy użytkownik otwiera link. |
OpenUrl
Określa zachowanie, gdy użytkownik otwiera link.
Zapis JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Pola | |
---|---|
url |
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 |
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 ( |
Pola | |
---|---|
title |
Opcjonalnie. Ogólny tytuł tabeli. Musi być ustawiony, jeśli podtytuł jest ustawiony. |
subtitle |
Opcjonalnie. Podtytuł tabeli. |
image |
Opcjonalnie. Obraz powiązany z tabelą. |
columns[] |
Opcjonalnie. Nagłówki i wyrównanie kolumn. |
rows[] |
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ę |
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 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 ( |
Pola | |
---|---|
cells[] |
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 |
Wskazuje, czy po każdym wierszu powinien znajdować się separator. |
TableCell
Opisuje komórkę w wierszu.
Zapis JSON | |
---|---|
{ "text": string } |
Pola | |
---|---|
text |
Zawartość komórki. |
StaticMediaPrompt
Zawiera informacje o multimediach, takie jak nazwa, opis, adres URL itp. Następny identyfikator: 11
Zapis JSON | |
---|---|
{ "mediaType": enum ( |
Pola | |
---|---|
mediaType |
Typ multimediów tej odpowiedzi. |
startOffset |
Opóźnienie rozpoczęcia pierwszego obiektu multimedialnego. Czas trwania w sekundach zawierający maksymalnie 9 cyfr po przecinku zakończony znakiem „ |
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[] |
Lista obiektów multimedialnych. |
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 ( |
Pola | |
---|---|
name |
Nazwa tego obiektu multimedialnego. |
description |
Opis tego obiektu multimedialnego. |
url |
Adres URL wskazujący treści multimedialne. |
image |
Obraz wyświetlany na karcie multimediów. |
MediaImage
Obraz do wyświetlenia w elemencie MediaPrompt.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy image . Dozwolony jest tylko jeden typ elementu MediaImage. image może mieć tylko jedną z tych wartości: |
||
large |
Duży obraz, np. okładka albumu itp. |
|
icon |
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 ( |
Pola | |
---|---|
title |
Opcjonalnie. Tytuł listy. |
subtitle |
Opcjonalnie. Podtytuł listy. |
items[] |
To pole jest wymagane. Elementy listy. |
ListItem
Element na liście.
Zapis JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Pola | |
---|---|
key |
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 |
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 |
Opcjonalnie. Tekst główny elementu. |
image |
Opcjonalnie. Obraz elementu. |
StaticCollectionPrompt
Karta prezentująca zbiór opcji do wyboru.
Zapis JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Pola | |
---|---|
title |
Opcjonalnie. Tytuł kolekcji. |
subtitle |
Opcjonalnie. Podtytuł kolekcji. |
items[] |
To pole jest wymagane. Elementy z kolekcji. |
imageFill |
Opcjonalnie. Typ opcji wyświetlania obrazu. |
CollectionItem
Element w kolekcji.
Zapis JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Pola | |
---|---|
key |
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 |
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 |
Opcjonalnie. Tekst główny elementu. |
image |
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 ( |
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 |
To pole jest wymagane. Tytuł elementu kolekcji. |
description |
Opis elementu kolekcji. |
footer |
Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty za pomocą wielokropka. |
image |
Zdjęcie elementu kolekcji. |
openUriAction |
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 |
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 |
To pole jest wymagane. Adres URL widoku internetowego do wczytania. |
data[] |
Opcjonalnie. Dane JSON, które mają być przekazywane do strony internetowej trybu interaktywnego w formie zdarzenia. Jeśli pole |
suppressMic |
Opcjonalnie. Wartość prawda oznacza, że po pokazaniu użytkownikowi tej immersyjnej odpowiedzi mikrofon się nie uruchamia, aby rejestrować sygnał. |
sendStateDataToCanvasApp |
Opcjonalnie. Jeśli jest ustawiona wartość |
enableFullScreen |
Opcjonalnie. Jeśli |
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 ( |
Pola | |
---|---|
onEnter |
Moduł obsługi do wywołania przy przechodzeniu do tej sceny. |
intentEvents[] |
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[] |
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[] |
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 |
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 ( |
Pola | |
---|---|
intent |
To pole jest wymagane. Intencja aktywująca zdarzenie. |
transitionToScene |
Opcjonalnie. Scena docelowa, do której ma przejść rozmowa. Obecny stan sceny zostaje zniszczony podczas przejścia. |
handler |
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 ( |
Pola | |
---|---|
condition |
To pole jest wymagane. Filtruj warunek uruchamiania tego zdarzenia. Jeśli warunek zostanie spełniony, wywołany jest powiązany z nim element |
transitionToScene |
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 |
Opcjonalnie. Moduł obsługi zdarzeń, który jest wyzwalany, gdy powiązany warunek zostanie oceniony jako |
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 ( |
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa boksu. |
type |
To pole jest wymagane. Deklaruje typ danych tego boksu. |
required |
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 |
Opcjonalnie. Rejestruje komunikaty dotyczące różnych etapów wypełniania przedziałów. |
commitBehavior |
Opcjonalnie. Zachowanie zatwierdzenia związane z przedziałem. |
config |
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 { "@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 wartości domyślnej tego przedziału. |
PromptSettings
Pojedyncze miejsce, w którym definiuje się prompty dotyczące przedziałów.
Zapis JSON | |
---|---|
{ "initialPrompt": { object ( |
Pola | |
---|---|
initialPrompt |
Pytaj o wartość boksu. Przykład: „Jaki rozmiar chcesz wybrać?”. |
noMatchPrompt1 |
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 |
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 |
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 |
Monit do podania, gdy użytkownik nie wprowadzi danych po raz pierwszy. Przykład: „Nie rozumiem”. |
noInputPrompt2 |
Monit o przyznanie, gdy użytkownik nie wprowadzi danych po raz drugi. Przykład: „Nie rozumiem”. |
noInputFinalPrompt |
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 |
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 |
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: |
constant |
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ą |
DataFiles
Otoka powtórzonego pliku danych. Pole powtarzane nie może znajdować się w jednym z tych elementów.
Zapis JSON | |
---|---|
{
"dataFiles": [
{
object ( |
Pola | |
---|---|
dataFiles[] |
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 |
Ścieżka względna pliku danych z katalogu głównego projektu w strukturze pliku SDK. Dozwolone ścieżki do plików: – obrazy: |
contentType |
To pole jest wymagane. Typ treści tego zasobu. Przykład: |
payload |
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. |