- JSON gösterimi
- ConfigFiles
- ConfigFile
- Manifest
- İşlemler
- CustomAction
- Etkileşim
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Ayarlar
- Kategori
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- İşleyici
- HttpsEndpoint
- InlineCloudFunction
- Amaç
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Tür
- SynonymType
- MatchType
- Varlık
- EntityDisplay
- RegularExpressionType
- Varlık
- FreeTextType
- EntitySet
- Varlık
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Seçici
- SurfaceCapabilities
- Kapasite
- StaticPromptResponse
- StaticSimplePrompt
- Varyant
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Öneri
- StaticCanvasPrompt
- Sahne
- IntentEvent
- ConditionalEvent
- Slot
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Dosya listesi için sarmalayıcı.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
Birleştirme alanı file_type . Sunucuya aynı anda yalnızca bir tür dosya (yapılandırma dosyaları veya veri dosyaları) gönderilebilir. file_type şunlardan yalnızca biri olabilir: |
||
configFiles |
Yapılandırma dosyalarının listesi. Manifest, ayarlar, etkileşim modeli kaynak paketleri ve daha fazlası buna dahildir. |
|
dataFiles |
Veri dosyalarının listesi. Buna resim, ses dosyası ve Cloud Functions işlevi kaynak kodu dahildir. |
ConfigFiles
Tekrarlanan yapılandırma dosyaları için sarmalayıcı. Yinelenen alanlar şunlardan birinde bulunamaz.
JSON gösterimi | |
---|---|
{
"configFiles": [
{
object ( |
Alanlar | |
---|---|
configFiles[] |
Birden çok yapılandırma dosyası. |
ConfigFile
Yapılandırılmış veri içeren tek bir dosyayı temsil eder. Geliştiriciler, Eylemler, Ayarlar, Sipariş Karşılama'yı içeren yapılandırılmış yapılandırmayı kullanarak projelerinin çoğunu tanımlayabilirler.
JSON gösterimi | |
---|---|
{ "filePath": string, // Union field |
Alanlar | ||
---|---|---|
filePath |
SDK dosya yapısındaki proje kökündeki yapılandırma dosyasının göreli yolu. Aşağıdaki her dosya türünün izin verilen bir dosya yolu vardır. Ör: settings/settings.yaml |
|
Birleştirme alanı file . Her yapılandırma dosyası türünün birinde karşılık gelen bir alan olmalıdır. file şunlardan yalnızca biri olabilir: |
||
manifest |
Tek manifest dosyası. İzin verilen dosya yolu: |
|
actions |
Tüm işlemlerin tanımlandığı tek işlemler dosyası. İzin verilen dosya yolları: |
|
settings |
Yerelleştirilmemiş ayarları ve projenin varsayılan yerel ayarının (belirtilmişse) ayarlarını içeren tekli ayar yapılandırması. Yerel ayar geçersiz kılma dosyası için yalnızca localizedSettings alanı doldurulur. İzin verilen dosya yolları: |
|
webhook |
Tek bir webhook tanımı. İzin verilen dosya yolu: |
|
intent |
Tek amaç tanımı. İzin verilen dosya yolları: |
|
type |
Tek tür tanımı. İzin verilen dosya yolları: |
|
entitySet |
Tek varlık grubu tanımı. İzin verilen dosya yolları: |
|
globalIntentEvent |
Tek genel amaç etkinliği tanımı. İzin verilen dosya yolları: |
|
scene |
Tek sahne tanımı. İzin verilen dosya yolları: |
|
staticPrompt |
Tek statik istem tanımı. İzin verilen dosya yolları: |
|
accountLinkingSecret |
Hesap bağlamada kullanılan istemci gizli anahtarına karşılık gelen meta veriler. İzin verilen dosya yolu: |
|
resourceBundle |
Bir dizeden bir dizeye veya dize listesine giden bir eşleme olan tek kaynak paketi. Statik istemlerdeki dizeleri yerelleştirmek için kaynak paketleri kullanılabilir. İzin verilen dosya yolları: |
Manifest
"Aktarılabilir" bilgiler içerir Yani belirli bir projeye özgü değildir ve projeler arasında taşınabilir.
JSON gösterimi | |
---|---|
{ "version": string } |
Alanlar | |
---|---|
version |
Dosya biçiminin sürümü. Geçerli dosya biçimi sürümü 1.0'dır Örnek: "1.0" |
İşlemler
Bir projede tanımlanan İşlemler listesini temsil eder.
JSON gösterimi | |
---|---|
{
"custom": {
string: {
object ( |
Alanlar | |
---|---|
custom |
Proje için çağrıyı yapılandırmak üzere niyetlerden özel İşlemlere eşleme. Çağrı amaçları, "özel/intents/" bölümünde tanımlanan sistem veya özel amaçlar olabilir paketinden yararlanın. Burada tanımlanan tüm amaçlar (sistem amaçları ve özel amaçlar) "özel/genel/" içinde karşılık gelen bir intent dosyasına sahip olmalıdır. paketinden yararlanın.
|
CustomAction
Özel işlemle ilgili ayrıntılar.
JSON gösterimi | |
---|---|
{
"engagement": {
object ( |
Alanlar | |
---|---|
engagement |
Son kullanıcıların push bildirimlerine ve günlük güncellemelere abone olmasına yardımcı olan işlemle ilişkili etkileşim mekanizmaları. Son kullanıcıların bu güncellemelere abone olabilmesi için günlük güncellemeler/push bildirimleri slotu yapılandırmasında belirtilen amaç adının, bu işleme karşılık gelen intentle eşleşmesi gerektiğini unutmayın. |
Etkileşim
Bu işlemle ilişkili etkileşim mekanizmalarını tanımlar. Bu, son kullanıcıların push bildirimlerine ve günlük güncellemelere abone olmasına olanak tanır.
JSON gösterimi | |
---|---|
{ "title": string, "pushNotification": { object ( |
Alanlar | |
---|---|
title |
Güncelleme almak için izin isteyen son kullanıcılara gönderilecek etkileşimin başlığı. Günlük güncellemeler için son kullanıcılara gönderilen istem, "Günlük {title} öğesini saat kaçta göndermemi istersin?" şeklinde görünür. ve push bildirimleri için ise "{title}" için push bildirimleri göndermem sorun olur mu gibi görünür. Bu alan yerelleştirilebilir. |
pushNotification |
Bu etkileşimin desteklediği push bildirimi ayarları. |
actionLink |
İşlem için bağlantı paylaşımının etkinleştirilip etkinleştirilmediğini belirleyen işlemin bağlantı yapılandırması. Bu ayar etkinse bağlantının kullanıcı dostu görünen adını içerir. ActionLink desteği sonlandırıldı. Bunun yerine AssistantLink'i kullanın. |
assistantLink |
İşlem için bağlantı paylaşımının etkinleştirilip etkinleştirilmediğini belirleyen işlemin bağlantı yapılandırması. Bu ayar etkinse bağlantının kullanıcı dostu görünen adını içerir. |
dailyUpdate |
Bu etkileşimin desteklediği günlük güncelleme ayarları. |
PushNotification
Bu etkileşimin desteklediği push bildirimi ayarlarını tanımlar.
DailyUpdate
Bu etkileşimin desteklediği günlük güncelleme ayarlarını tanımlar.
ActionLink
Bu işlem ve ilgili ayarlar için bağlantı paylaşımının etkinleştirilip etkinleştirilmediğini belirtir. İşlem bağlantıları, bir kullanıcıyla belirli bir işleme derin bağlantı oluşturmak için kullanılır. ActionLink desteği sonlandırıldı. Bunun yerine AssistantLink'i kullanın.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Bağlantının kullanıcı dostu görünen başlığı. |
AssistantLink
Bu işlem ve ilgili ayarlar için bağlantı paylaşımının etkinleştirilip etkinleştirilmediğini belirtir. Asistan bağlantıları, kullanıcıyla belirli bir işleme derin bağlantı oluşturmak için kullanılır.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Bağlantının kullanıcı dostu görünen başlığı. |
Ayarlar
Bir Actions projesinin yerel ayara özel olmayan ayarlarını temsil eder. Sonraki etiket: 22
JSON gösterimi | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Alanlar | |
---|---|
projectId |
İşlemler proje kimliği. |
defaultLocale |
Proje için varsayılan yerel ayardır. Yolda yerel ayar olmayan |
enabledRegions[] |
Kullanıcıların, bulunduğu konuma göre işlemlerinizi çağırabileceği bölgeleri temsil eder. |
disabledRegions[] |
Kullanıcının bulunduğu konuma göre Actions'ınızın engellendiği bölgeleri temsil eder. |
category |
Bu Actions projesinin kategorisi. |
usesTransactionsApi |
İşlemler'in işlemleri kullanıp kullanamayacağı (örneğin, rezervasyon yapma, sipariş alma vb.). False (yanlış) değerindeyse Transaction API'lerini kullanma girişimleri başarısız olur. |
usesDigitalPurchaseApi |
İşlemler'in dijital ürünlerle ilgili işlemleri gerçekleştirip gerçekleştiremeyeceği. |
usesInteractiveCanvas |
İşlemlerin Etkileşimli Tuval kullanıp kullanmadığı. |
usesHomeStorage |
Actions'ın ev depolama alanı özelliğini kullanıp kullanmadığı. |
designedForFamily |
Actions içeriğinin aileler için tasarlanıp tasarlanmadığı. |
containsAlcoholOrTobaccoContent |
İşlemlerin alkol veya tütünle ilgili içerik içerip içermediği. |
keepsMicOpen |
İşlemlerin görüşme sırasında açık bir istem olmadan mikrofonu açık bırakıp bırakamayacağı. |
surfaceRequirements |
Bu projede İşlemler çağırmak için istemci yüzeyinin desteklemesi gereken yüzey gereksinimleri. |
testingInstructions |
Actions incelemecisi için serbest biçimli test talimatları (örneğin, hesap bağlama talimatları). |
localizedSettings |
Projenin varsayılan yerel ayarı için yerelleştirilmiş ayarlar. Her ek yerel ayarın kendi dizininde kendi ayarlar dosyası olmalıdır. |
accountLinking |
Kullanıcıların Google ile Oturum Açma ve/veya kendi OAuth hizmetiniz aracılığıyla hesap oluşturmasına ya da bağlamasına izin verin. |
selectedAndroidApps[] |
Google Play satın alma işlemlerine erişmek üzere seçilen Android uygulamaları. Bu, marka sahipliğini doğrulamak ve ek özellikleri etkinleştirmek için işlem projesine bağlı Android uygulamalarından bir seçimdir. Daha fazla bilgi için https://developers.google.com/assistant/console/brand-verification adresine bakın. |
Kategori
Actions projesi için kategori seçimleri.
Sıralamalar | |
---|---|
CATEGORY_UNSPECIFIED |
Bilinmiyor / Belirtilmedi. |
BUSINESS_AND_FINANCE |
İşletme ve Finans kategorisi. |
EDUCATION_AND_REFERENCE |
Eğitim ve Referans kategorisi. |
FOOD_AND_DRINK |
Yiyecek ve İçecek kategorisi. |
GAMES_AND_TRIVIA |
Oyun ve Bilgi Yarışması kategorisi. |
HEALTH_AND_FITNESS |
Sağlık ve Fitness kategorisi. |
KIDS_AND_FAMILY |
Çocuk ve Aile kategorisi. |
LIFESTYLE |
Yaşam tarzı kategorisi. |
LOCAL |
Yerel kategori. |
MOVIES_AND_TV |
Filmler ve TV kategorisi. |
MUSIC_AND_AUDIO |
Müzik ve Ses kategorisi. |
NEWS |
Haber kategorisi, |
NOVELTY_AND_HUMOR |
Yenilik ve Mizah kategorisi. |
PRODUCTIVITY |
Üretkenlik kategorisi. |
SHOPPING |
Alışveriş kategorisi. |
SOCIAL |
Sosyal medya kategorisi. |
SPORTS |
Spor kategorisi. |
TRAVEL_AND_TRANSPORTATION |
Seyahat ve Ulaşım kategorisi. |
UTILITIES |
Yardımcı programlar kategorisi. |
WEATHER |
Hava durumu kategorisi. |
HOME_CONTROL |
Ev Kontrolü kategorisi. |
SurfaceRequirements
İstemci yüzeyinin projenizde Eylemleri çağırmak için desteklemesi gereken bir dizi gereksinim içerir.
JSON gösterimi | |
---|---|
{
"minimumRequirements": [
{
object ( |
Alanlar | |
---|---|
minimumRequirements[] |
Projenizdeki Eylemleri çağırmak için gereken minimum özellik grubu. Yüzeyde bunlardan herhangi biri eksikse işlem tetiklenmez. |
CapabilityRequirement
Belirli bir özelliğin kullanılabilirliğiyle ilgili şartı ifade eder.
JSON gösterimi | |
---|---|
{
"capability": enum ( |
Alanlar | |
---|---|
capability |
Yeteneğin türü. |
SurfaceCapability
Olası yüzey özellikleri.
Sıralamalar | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Bilinmiyor / Belirtilmedi. |
AUDIO_OUTPUT |
Surface ses çıkışını destekler. |
SCREEN_OUTPUT |
Surface ekran/görsel çıkışı destekler. |
MEDIA_RESPONSE_AUDIO |
Surface, medya yanıtı sesini destekler. |
WEB_BROWSER |
Surface web tarayıcılarını destekler. |
ACCOUNT_LINKING |
Surface hesap bağlamayı destekler. |
INTERACTIVE_CANVAS |
Surface, Etkileşimli Tuval'i destekler. |
HOME_STORAGE |
Surface, ev depolama alanını destekler. |
LocalizedSettings
Bir kullanıcının yerel ayarına özgü Actions projesinin ayarlarını temsil eder. Bu örnekte kullanıcı, İşlemlerinizi çağıran son kullanıcı anlamına gelir. Bu mesaj yerelleştirilebilir.
JSON gösterimi | |
---|---|
{
"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 ( |
Alanlar | |
---|---|
displayName |
Zorunlu. Bu Actions projesi için varsayılan görünen ad (çeviri yoksa) |
pronunciation |
Zorunlu. Görünen adın, sesli bağlamda çağrılacak telaffuzu. |
shortDescription |
Zorunlu. Actions projesi için varsayılan kısa açıklama (çeviri yoksa). 80 karakterle sınırlıdır. |
fullDescription |
Zorunlu. Actions projesi için varsayılan uzun açıklama (çeviri yoksa). 4.000 karakterle sınırlıdır. |
smallLogoImage |
Zorunlu. Küçük kare resim, 192 x 192 piksel. Bu, |
largeBannerImage |
İsteğe bağlı. 1920 x 1080 piksel büyük yatay resim. Bu, |
developerName |
Zorunlu. Kullanıcılara gösterilecek geliştiricinin adı. |
developerEmail |
Zorunlu. Geliştiricinin iletişim e-posta adresi. |
termsOfServiceUrl |
İsteğe bağlı. Hizmet şartları URL'si. |
voice |
Zorunlu. Kullanıcıların İşlemlerinizle etkileşimde bulunurken duyduğu Google Asistan ses türü. Desteklenen değerler: "male_1", "male_2", "female_1" ve "female_2". |
voiceLocale |
İsteğe bağlı. Belirtilen sesin yerel ayarı. Belirtilmezse kullanıcının Asistan yerel ayarına çözümlenir. Belirtilmişse ses yerel ayarı, LocalizedSettings'de belirtilen yerel ayarla aynı kök dile sahip olmalıdır. |
privacyPolicyUrl |
Zorunlu. Gizlilik politikası URL'si. |
sampleInvocations[] |
İsteğe bağlı. Asistan dizinindeki Actions projenizin açıklamasının bir parçası olarak gösterilen örnek çağrı ifadeleri. Bu, kullanıcıların uygulamayı nasıl kullanacaklarını öğrenmelerine yardımcı olacaktır. |
themeCustomization |
İsteğe bağlı. İşlemlerinizin görsel bileşenleri için tema özelleştirmeleri. |
ThemeCustomization
Kullanıcılara sunulan kartlara uygulanan stiller
JSON gösterimi | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Alanlar | |
---|---|
backgroundColor |
Kartların arka plan rengi. |
primaryColor |
İşlemin birincil tema rengi, başlığın metin rengini ve Actions on Google kartlarında işlem öğesinin arka plan rengini belirlemek için kullanılır. Örnek kullanım: #FAFAFA |
fontFamily |
Kartların başlığı için kullanılacak yazı tipi ailesi. Desteklenen yazı tipleri: - Sans Serif - Sans Serif Medium - Sans Serif Kalın - Sans Serif Siyah - Sans Serif Daraltılmış - Sans Serif Daraltılmış Orta - Serif - Serif Kalın - Tek Boşluklu - Steno - Sans Serif Smallcaps |
imageCornerStyle |
Kartların ön plan resminin kenarlık stili. Örneğin, temel bir kartın veya rulo resim kartının ön plan resmine uygulanabilir. |
landscapeBackgroundImage |
Yatay mod (minimum 1920x1200 piksel). Bu, |
portraitBackgroundImage |
Dikey mod (minimum 1200x1920 piksel). Bu, |
ImageCornerStyle
Resimlerin kenarlıklarının nasıl oluşturulması gerektiğini açıklar.
Sıralamalar | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
Tanımsız / Belirtilmemiş. |
CURVED |
Resim için yuvarlak köşe. |
ANGLED |
Resmin dikdörtgen köşesi. |
AccountLinking
Hesap Bağlama, Google'ın, uygulamanın web hizmetlerinde oturum açmaları için kullanıcıyı yönlendirmesine olanak tanır.
Google ile Oturum Açma ve OAuth + Google ile Oturum Açma bağlantı türleri için Google, Uygulamanızı Google'a tanımlayan bir istemci kimliği (Konsol kullanıcı arayüzündeki Google tarafından İşlemlerinize verilir) oluşturur. Bu alan salt okunurdur ve Console kullanıcı arayüzünün Hesap Bağlama sayfasına gidilerek kontrol edilebilir. https://developers.google.com/assistant/identity/google-sign-in adresini ziyaret edin.
Not: Tüm hesap bağlama ayarı türlerinde (Google ile Oturum Açma hariç), inceleme ekibinin uygulamayı incelemesi için Settings.testing_instructions'da bir test hesabının kullanıcı adı ve şifresini sağlamanız gerekir (bunlar kullanıcılar tarafından görülemez).
JSON gösterimi | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Alanlar | |
---|---|
enableAccountCreation |
Zorunlu. |
linkingType |
Zorunlu. Kullanılacak bağlantı türü. Bağlantı türleriyle ilgili daha ayrıntılı bilgi için https://developers.google.com/assistant/identity adresine bakın. |
authGrantType |
İsteğe bağlı. OAUTH linkingType için kimlik doğrulama türünü belirtir. |
appClientId |
İsteğe bağlı. Uygulamanız tarafından Google'a verilen istemci kimliği. Bu, Google'ı hizmetinize tanımlayan OAuth2 İstemci Kimliğidir. Yalnızca OAuth kullanılırken ayarlanır. |
authorizationUrl |
İsteğe bağlı. Oturum açma web sayfanız için, OAuth2 kodunu veya örtülü akışları destekleyen uç nokta. URL, HTTPS kullanmalıdır. Yalnızca OAuth kullanılırken ayarlanır. |
tokenUrl |
İsteğe bağlı. Jeton değişimi için OAuth2 uç noktası. URL, HTTPS kullanmalıdır. Bağlantı türü olarak yalnızca IMPLICIT izni ile OAuth kullanılırken bu ayar yapılmaz. Yalnızca OAuth kullanılırken ayarlanır. |
scopes[] |
İsteğe bağlı. Kullanıcının hizmetinizi kullanmak için onaylaması gereken izinlerin listesi. Yalnızca OAuth kullanılırken ayarlanır. Bu alanı belirtiyorsanız LocalizedSettings.terms_of_service_url bölümündeki dizin bilgilerinde bir Hizmet Şartları sağladığınızdan emin olun. |
learnMoreUrl |
İsteğe bağlı. Bu, hizmetinizde kullanıcının Google'a verdiği izinleri açıklayan web sayfasıdır. Yalnızca OAuth ve Google ile Oturum Açma kullanılıyorsa ayarlayın. Bu alanı belirtiyorsanız LocalizedSettings.terms_of_service_url bölümündeki dizin bilgilerinde bir Hizmet Şartları sağladığınızdan emin olun. |
useBasicAuthHeader |
İsteğe bağlı. True (doğru) ise Google'ın istemci kimliğini ve gizli anahtarı HTTP temel kimlik doğrulama başlığı üzerinden iletmesine izin verin. Aksi takdirde Google, istemci kimliğini ve gizli anahtarı yayın gövdesinde kullanır. Yalnızca OAuth kullanılırken ayarlanır. Bu alanı belirtiyorsanız LocalizedSettings.terms_of_service_url bölümündeki dizin bilgilerinde bir Hizmet Şartları sağladığınızdan emin olun. |
LinkingType
Gerçekleştirilecek Hesap Bağlama türü.
Sıralamalar | |
---|---|
LINKING_TYPE_UNSPECIFIED |
Belirtilmedi. |
GOOGLE_SIGN_IN |
Google ile Oturum Açma bağlantı türü. Bu bağlantı türü kullanılıyorsa aşağıda OAuth ile ilgili alanların ayarlanması gerekmez. |
OAUTH_AND_GOOGLE_SIGN_IN |
OAuth ve Google ile Oturum Açma bağlantı türü. |
OAUTH |
OAuth bağlantı türü. |
AuthGrantType
Google'ın, kullanıcıları uygulamanızın web hizmetinde oturum açmaları konusunda yönlendirmek için kullandığı OAuth2 izin türü.
Sıralamalar | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
Belirtilmedi. |
AUTH_CODE |
Yetkilendirme kodu verme. Hem kimlik doğrulama URL'sini hem de erişim jetonu URL'sini sağlamanızı gerektirir. |
IMPLICIT |
Örtülü kod izni. Yalnızca kimlik doğrulama URL'sini sağlamanız gerekir. |
Webhook
Farklı webhook türleri için meta veriler. inlineCloudFunction
kullanıyorsanız kaynak kodunuz, executeFunction
anahtarının değeriyle aynı ada sahip bir dizinde olmalıdır. Örneğin, executeFunction
anahtarı için my_webhook
değeri şuna benzer bir kod yapısına sahip olur: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
JSON gösterimi | |
---|---|
{ "handlers": [ { object ( |
Alanlar | ||
---|---|---|
handlers[] |
Bu webhook'un işleyicilerin listesi. |
|
Birleştirme alanı webhook_type . Yalnızca bir webhook türü desteklenir. webhook_type şunlardan yalnızca biri olabilir: |
||
httpsEndpoint |
Özel webhook HTTPS uç noktası. |
|
inlineCloudFunction |
Webhook'lar klasöründeki koddan dağıtılan Cloud Functions işlevinin meta verileri. |
İşleyici
Webhoook işleyicinin adını tanımlar. Bir webhook'a kayıtlı birden fazla işleyici olabilir. Bu işleyiciler, Actions projenizdeki birden fazla yerden çağrılabilir.
JSON gösterimi | |
---|---|
{ "name": string } |
Alanlar | |
---|---|
name |
Zorunlu. İşleyicinin adı. Actions projesindeki tüm işleyicilerde benzersiz olmalıdır. Sipariş karşılama kaynak kodunuzda doğru işlevi çağırmak için bu işleyicinin adını kontrol edebilirsiniz. |
HttpsEndpoint
Satır içi düzenleyiciyi kullanmıyorsanız bilgilendirilecek REST uç noktası.
JSON gösterimi | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Alanlar | |
---|---|
baseUrl |
Karşılama uç noktanız için HTTPS temel URL'si (HTTP desteklenmez). İşleyici adları, iki nokta üst üste işaretinden sonra temel URL yoluna eklenir (https://cloud.google.com/apis/design/custom_methods) adresindeki stil kılavuzu izlenerek). Örneğin, "https://gactions.service.com/api" temel URL'si "https://gactions.service.com/api:{method}" URL'sine sahip istekler alır. |
httpHeaders |
POST isteğine dahil edilecek HTTP parametrelerinin haritası.
|
endpointApiVersion |
Uç nokta tarafından kullanılan protokolün sürümü. Bu, tüm sipariş karşılama türleri tarafından paylaşılan ve Google sipariş karşılama türüne özel olmayan protokoldür. |
InlineCloudFunction
Webhook'lar klasöründen dağıtılan satır içi Cloud Functions işlevinin meta verilerini barındırır.
JSON gösterimi | |
---|---|
{ "executeFunction": string } |
Alanlar | |
---|---|
executeFunction |
Cloud Functions işlevi giriş noktasının adı. Bu alanın değeri, kaynak kodundan dışa aktarılan yöntemin adıyla eşleşmelidir. |
Amaç
Amaçlar, açık uçlu kullanıcı girişini yapılandırılmış nesnelerle eşler. Söylenen ifadeler, Google'ın Doğal Dil Anlama (NLU) özelliği ile niyetlerle eşleştirilir. Amaç eşleşmeleri, kullanıcının görüşmesini ilerletmek için sohbet tasarımınızdaki etkinlikleri tetikleyebilir. Amaç adı, dosyanın adında belirtilir.
JSON gösterimi | |
---|---|
{
"parameters": [
{
object ( |
Alanlar | |
---|---|
parameters[] |
Eğitim ifadelerindeki parametrelerin listesi. Eğitim ifadesinde kullanılmaları için tüm parametrelerin burada tanımlanması gerekir. |
trainingPhrases[] |
Eğitim ifadeleri, Google'ın NLU'sunun amaçları otomatik olarak kullanıcı girişiyle eşleştirmesine olanak tanır. Ne kadar çok benzersiz ifade sağlanırsa bu niyetin eşleşme olasılığı o kadar artar. Aşağıda, ek açıklamalı eğitim ifadesi bölümünün biçimi verilmiştir. |
IntentParameter
Eğitim ifadelerinin içinde kullanılabilecek parametrenin tanımı.
JSON gösterimi | |
---|---|
{ "name": string, // Union field |
Alanlar | ||
---|---|---|
name |
Zorunlu. Intent parametresinin benzersiz adı. $intent.params.[name].resolved ile NLU tarafından ayıklanan referans intent parametrelerine koşullar ve yanıtlarda kullanılabilir. |
|
Birleştirme alanı parameter_type . Amaç parametresinin türü. parameter_type şunlardan yalnızca biri olabilir: |
||
type |
İsteğe bağlı. Bu parametrenin veri türünü tanımlar. Yerleşik amaçlar için ayarlanmamalıdır. |
|
entitySetReferences |
İsteğe bağlı. Bu intent parametresi için izin verilen varlık gruplarına referanslar. Yalnızca yerleşik bir amacın parametreleri için geçerlidir. Bu referanslar, "custom/entitySets" içindeki varlık gruplarını işaret ediyor dizin. |
ClassReference
Alan veya döndürülen değerin türünü bildirmek için kullanılan sınıfa başvuru. Sıralamalar, ClassReference kullanılarak referans verilebilecek bir sınıf türüdür.
JSON gösterimi | |
---|---|
{ "name": string, "list": boolean } |
Alanlar | |
---|---|
name |
Zorunlu. Parametrenin yerleşik türünün veya özel türünün adı. Örnekler: |
list |
İsteğe bağlı. Veri türünün bir değer listesini temsil edip etmediğini belirtir. |
EntitySetReferences
Bir intent parametresi için öğe grubu referansları.
JSON gösterimi | |
---|---|
{
"entitySetReferences": [
{
object ( |
Alanlar | |
---|---|
entitySetReferences[] |
Zorunlu. Bir intent parametresi için öğe grubu referansları. |
EntitySetReference
Bu intent parametresi için izin verilen varlıklar grubuna referans.
JSON gösterimi | |
---|---|
{ "entitySet": string } |
Alanlar | |
---|---|
entitySet |
Zorunlu. Belirli bir parametre için dikkate alınacak özel öğe koleksiyonunu tanımlar. İlgili varlık grubu tanımı, custom/entitySets/ dizininde bulunmalıdır. |
Tür
Yerleşik türlerin aksine özel bir türün bildirimi. Türler, bir sahnedeki alanlara veya bir niyetin eğitim ifadelerinin parametrelerine atanabilir. Pratikte Türler, enum olarak düşünülebilir. Tür adının, dosya adında belirtildiğini unutmayın.
JSON gösterimi | |
---|---|
{ "exclusions": [ string ], // Union field |
Alanlar | ||
---|---|---|
exclusions[] |
Türle eşleştirilmemesi gereken istisnai kelime/kelime öbeği kümesi. Not: Kelime/kelime öbeği türle eşleşiyorsa ancak hariç tutma olarak listeleniyorsa parametre ayıklama sonucunda döndürülmez. Bu alan yerelleştirilebilir. |
|
Birleştirme alanı sub_type . Yapılacak eşleşmenin türüne göre alt tür seçimi. sub_type şunlardan yalnızca biri olabilir: |
||
synonym |
Temelde bir numaralandırma olan eş anlamlılar türü. |
|
regularExpression |
Normal ifade türü, normal ifade eşleşmesine olanak tanır. |
|
freeText |
FreeText türü. |
SynonymType
Metni eş anlamlılar grubuna göre eşleştiren yazın.
JSON gösterimi | |
---|---|
{ "matchType": enum ( |
Alanlar | |
---|---|
matchType |
İsteğe bağlı. Eş anlamlının eşleme türü. |
acceptUnknownValues |
İsteğe bağlı. Politika, Doğru değerine ayarlandığında bilinmeyen kelimeleri veya ifadeleri, çevredeki giriş ve amaç eğitimi verilerine (ör. alışveriş listesine eklenebilecek öğeler) göre eşleştirir. |
entities |
Zorunlu. Eş anlamlı varlıkların adlandırılmış haritası.
|
MatchType
Bu tür girişlerin kullanacağı eşleme türüdür. Bu, tüm türlerin aynı eşleme yöntemini kullanmasını sağlar ve eş anlamlı eşleme için eşlemenin çeşitliliğine (ör. belirsiz ve tam) izin verir. UNSPECIFIED
ise varsayılan olarak EXACT_MATCH
yapılır.
Sıralamalar | |
---|---|
UNSPECIFIED |
Varsayılan olarak EXACT_MATCH değerine ayarlanır. |
EXACT_MATCH |
Eş anlamlının veya adın tam olarak eşleştiğini arar. |
FUZZY_MATCH |
EXACT_MATCH varyantından daha geniş. Benzer eşleşmeleri ve tam eşleşmeleri arar. |
Varlık
Tür içindeki tek bir girişin ayrıntılarını içeren eş anlamlı varlık alanını temsil eder.
JSON gösterimi | |
---|---|
{
"display": {
object ( |
Alanlar | |
---|---|
display |
İsteğe bağlı. Varlık görüntüleme ayrıntıları. |
synonyms[] |
İsteğe bağlı. Varlığın eş anlamlılarının listesi. Bu alan yerelleştirilebilir. |
EntityDisplay
Sorgudan belirli bir türün varlığı çıkarıldığında tuvalde gösterilecek öğeler. Yalnızca tuval özellikli uygulamalar için geçerlidir. Bu mesaj yerelleştirilebilir.
JSON gösterimi | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
Alanlar | |
---|---|
iconTitle |
İsteğe bağlı. Simgenin başlığı. |
iconUrl |
Zorunlu. Simgenin URL'si. |
RegularExpressionType
Metni normal ifadelerle eşleştiren tür. Bu mesaj yerelleştirilebilir.
JSON gösterimi | |
---|---|
{
"entities": {
string: {
object ( |
Alanlar | |
---|---|
entities |
Zorunlu. Her biri normal ifade dizeleri içeren varlıkların adlandırılmış eşlemesi.
|
Varlık
Karşılaştırma için kullanılan normal ifadeyi içeren bir varlık nesnesini temsil eder.
JSON gösterimi | |
---|---|
{
"display": {
object ( |
Alanlar | |
---|---|
display |
İsteğe bağlı. Sorgudan bir varlık çıkarıldığında tuvalde gösterilecek öğeler. Yalnızca tuval özellikli uygulamalar için geçerlidir. |
regularExpressions[] |
Zorunlu. RE2 normal ifade söz dizimini kullanır (Daha fazla ayrıntı için https://github.com/google/re2/wiki/Syntax adresine bakın) |
FreeTextType
Çevreleyen kelimeler bağlamı sağlanan eğitim örneklerine yakınsa herhangi bir metinle eşleşen yazın.
JSON gösterimi | |
---|---|
{
"display": {
object ( |
Alanlar | |
---|---|
display |
İsteğe bağlı. Sorgudan bir varlık çıkarıldığında tuvalde gösterilecek öğeler. Yalnızca tuval özellikli uygulamalar için geçerlidir. |
EntitySet
Varlık grupları, yerleşik amaç parametrelerinin değerlerinin gelebileceği önceden tanımlanmış varlık grubunu açıklar. Varlık kümelerine, yerleşik intent parametrelerindeki AssetSet'ten referans verilebilir.
JSON gösterimi | |
---|---|
{
"entities": [
{
object ( |
Alanlar | |
---|---|
entities[] |
Zorunlu. Bu varlık grubunun desteklediği varlıkların listesi. |
Varlık
Yerleşik intent parametresi değerinin gelebileceği varlık.
JSON gösterimi | |
---|---|
{ "id": string } |
Alanlar | |
---|---|
id |
Zorunlu. Varlık kimliği. Yerleşik intent parametreleri ve bunların desteklenen varlıklarının listesi için https://developers.google.com/assistant/conversational/build/built-in-intents adresine bakın. |
GlobalIntentEvent
Genel amaç işleyiciyi tanımlar. Genel amaç etkinlikleri, Actions projesinin tamamını kapsar ve bir sahnedeki amaç işleyiciler tarafından geçersiz kılınabilir. Actions projesi içinde amaç adları benzersiz olmalıdır.
Genel amaçlar, oturum sırasında herhangi bir zamanda eşleştirilebilir ve böylece kullanıcıların "yardım alma" gibi ortak akışlara erişmesine olanak tanır. veya "ana sayfaya dön" gibi bilgiler oluşturabilirsiniz. Ayrıca, bir İşlemi çağırdıklarında kullanıcılarla belirli akışlara derin bağlantı oluşturmak için de kullanılabilirler.
Amaç adının dosya adında belirtildiğini unutmayın.
JSON gösterimi | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Alanlar | |
---|---|
transitionToScene |
İsteğe bağlı. Sohbetin atlanması gereken hedef sahne. Geçerli sahnenin durumu geçişte yok olur. |
handler |
İsteğe bağlı. Amaç eşleştiğinde tetiklenen etkinlik işleyici. Hedef sahneye geçişten önce yürütülmelidir. Etkinliklere yanıt olarak istem oluşturmak için kullanışlıdır. |
EventHandler
Bir etkinlikten sonra yürütülecek işleyiciyi tanımlar. Etkinliklere örnek olarak, bir sahnedeki amaç ve koşula dayalı etkinlikler gösterilebilir.
JSON gösterimi | |
---|---|
{ "webhookHandler": string, // Union field |
Alanlar | ||
---|---|---|
webhookHandler |
Çağrı yapılacak webhook işleyicisinin adı. |
|
Birleştirme alanı prompt . İstemler satır içine alınabilir veya ada göre referans verilebilir. prompt şunlardan yalnızca biri olabilir: |
||
staticPrompt |
Satır içi statik istem. Paketlerdeki dize kaynaklarına referanslar içerebilir. |
|
staticPromptName |
Çağrılacak statik istemin adı. |
StaticPrompt
İstem adaylarının listesini temsil eder. Bu istemlerden biri, kullanıcıya yanıtta gösterilecek istem olarak seçilir. Bu mesaj yerelleştirilebilir.
JSON gösterimi | |
---|---|
{
"candidates": [
{
object ( |
Alanlar | |
---|---|
candidates[] |
Müşteriye gönderilecek aday istemlerinin listesi. Her istemin ne zaman kullanılabileceğini belirleyen bir seçici vardır. Bir istekle eşleşen ilk seçici gönderilir ve geri kalanlar yoksayılır. |
StaticPromptCandidate
Statik bir istem adayını temsil eder.
JSON gösterimi | |
---|---|
{ "selector": { object ( |
Alanlar | |
---|---|
selector |
İsteğe bağlı. Bu istemin bir istekle eşleşip eşleşmediğine ilişkin ölçütler. Seçici boşsa bu istem her zaman tetiklenir. |
promptResponse |
Seçiciyle ilişkili istem yanıtı. |
Seçici
Bir istemin istekle eşleşip eşleşmediğine ilişkin ölçütleri tanımlar.
JSON gösterimi | |
---|---|
{
"surfaceCapabilities": {
object ( |
Alanlar | |
---|---|
surfaceCapabilities |
Gerekli yüzey özellikleri grubu. |
SurfaceCapabilities
Kullanıcının Action'a istekte bulunmak için kullandığı yüzeyi temsil eder.
JSON gösterimi | |
---|---|
{
"capabilities": [
enum ( |
Alanlar | |
---|---|
capabilities[] |
Zorunlu. Yüzeyin İşlem için istekte bulunan özellikleri. |
Kapasite
İstek sırasında cihaz yüzeyinin desteklediği özellikler.
Sıralamalar | |
---|---|
UNSPECIFIED |
Belirtilmemiş yüzey özelliği. |
SPEECH |
Cihaz, metin okuma veya SSML üzerinden kullanıcıyla konuşabilir. |
RICH_RESPONSE |
Cihaz; kartlar, listeler ve tablolar gibi zengin yanıtları görüntüleyebilir. |
LONG_FORM_AUDIO |
Cihaz, müzik ve podcast gibi uzun biçimli sesli medyaları oynatabilir. |
INTERACTIVE_CANVAS |
Cihazda etkileşimli bir tuval yanıtı gösterilebilir. |
WEB_LINK |
Cihaz, bir web tarayıcısını açmak için zengin yanıtlardaki web bağlantılarını kullanabilir. |
HOME_STORAGE |
Cihaz, ev depolama alanının kaydedilmesini ve getirilmesini destekleyebilir. |
StaticPromptResponse
Kullanıcıya gönderilecek yapılandırılmış yanıtları (ör. metin, konuşma, kart, tuval verileri, öneri çipi) temsil eder.
JSON gösterimi | |
---|---|
{ "firstSimple": { object ( |
Alanlar | |
---|---|
firstSimple |
İsteğe bağlı. İlk sesli ve yalnızca metin yanıt. |
content |
İsteğe bağlı. Kullanıcıya gösterilecek kart, liste veya medya gibi bir içerik. |
lastSimple |
İsteğe bağlı. Son sesli ve yalnızca metin yanıt. |
suggestions[] |
İsteğe bağlı. Kullanıcıya gösterilecek öneriler. Bunlar, her zaman yanıtın sonunda gösterilir. İçeren istemdeki |
link |
İsteğe bağlı. İlişkili uygulama veya siteye bağlantı verebilecek ek bir öneri çipi. Çip, "Aç |
override |
İsteğe bağlı. Bu iletilerin önceden tanımlanmış iletilerle birleştirilme şekli. |
canvas |
Etkileşimli tuval deneyimi için kullanılacak yanıt. |
StaticSimplePrompt
Kullanıcıya gönderilmesi için basit bir istemi temsil eder.
JSON gösterimi | |
---|---|
{
"variants": [
{
object ( |
Alanlar | |
---|---|
variants[] |
Olası varyantların listesi. |
Varyant
Basit istemin parçası olan bir varyantı temsil eder.
JSON gösterimi | |
---|---|
{ "speech": string, "text": string } |
Alanlar | |
---|---|
speech |
İsteğe bağlı. Kullanıcıya söylenecek konuşmayı temsil eder. SSML veya metin okuma olabilir. Varsayılan olarak, önceki Basit istemin konuşmasına konuşma eklenir. İçeren istemdeki |
text |
İsteğe bağlı. Sohbet balonunda gösterilecek metin. Belirtilmezse yukarıdaki konuşma alanının görüntülemesi kullanılır. Uzunluk sınırı 640 karakterdir. Metin, varsayılan olarak önceki Basit istem metnine eklenir. İçeren istemdeki |
StaticContentPrompt
StaticPrompt'un Content (İçerik) bölümü için yer tutucu.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
Birleştirme alanı content . Bir istemde yalnızca bir içerik türü bulunabilir. content şunlardan yalnızca biri olabilir: |
||
card |
Temel kart. |
|
image |
Bir resim. |
|
table |
Tablo kartı. |
|
media |
Oynatılacak bir grup medyayı gösteren yanıt. |
|
list |
Seçebileceğiniz seçeneklerin listesini sunan bir kart. |
|
collection |
Seçebileceğiniz seçeneklerin listesini sunan bir kart. |
|
collectionBrowse |
Açılacak bir web sayfası koleksiyonu sunan kart. |
StaticCardPrompt
Bazı bilgileri görüntülemek için kullanılan temel kart, ör. bir resim ve/veya metin.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Alanlar | |
---|---|
title |
İsteğe bağlı. Kartın genel başlığı. |
subtitle |
İsteğe bağlı. Kartın alt başlığı. |
text |
Zorunlu. Resim mevcut değilse kartın gövde metni. Biçimlendirme için sınırlı bir Markdown söz dizimi grubunu destekler. |
image |
İsteğe bağlı. Kart için hero resim. Yükseklik 192 dp olarak sabitlendi. |
imageFill |
İsteğe bağlı. Resim arka planının nasıl doldurulacağı. |
button |
İsteğe bağlı. Kartta gösterilecek tıklanabilir bir düğme. |
StaticImagePrompt
Kartta bir resim gösteriliyor.
JSON gösterimi | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Alanlar | |
---|---|
url |
Zorunlu. Resmin kaynak URL'si. Resimler JPG, PNG ve GIF (animasyonlu ve animasyonsuz) olabilir. Örneğin, |
alt |
Zorunlu. Erişilebilirlik için kullanılacak resmin metin açıklaması, ör. Ekran okuyucular. |
height |
İsteğe bağlı. Resmin piksel cinsinden yüksekliği. |
width |
İsteğe bağlı. Resmin piksel cinsinden genişliği. |
ImageFill
Resmin sunumunu etkileyecek olası resim görüntüleme seçenekleri. Bu, resmin en boy oranı, görüntü kapsayıcısının en boy oranıyla eşleşmediğinde kullanılmalıdır.
Sıralamalar | |
---|---|
UNSPECIFIED |
ImageFill belirtilmedi. |
GRAY |
Resim ile görüntü kapsayıcısı arasındaki boşlukları gri çubuklarla doldurun. |
WHITE |
Resim ile görüntü kapsayıcısı arasındaki boşlukları beyaz çubuklarla doldurun. |
CROPPED |
Resim, genişlik ve yüksekliğinin kapsayıcı boyutlarıyla eşleşecek veya bu boyutların üzerinde olacak şekilde ölçeklendirilir. Bu işlemde, ölçeklendirilmiş resim yüksekliği kapsayıcı yüksekliğinden fazlaysa resmin üst ve alt kısmı kırpılabilir. Ölçeklendirilmiş resim genişliği kapsayıcı genişliğinden fazlaysa resmin sol ve sağ kısmı kırpılabilir. Bu, "Yakınlaştırma Modu"na benzer TV'de YouTube TV'yi izlemeye devam edebilirsiniz. |
StaticLinkPrompt
Öneri çipi olarak gösterilecek ve kullanıcı tarafından açılabilecek bir bağlantıyı tanımlar.
JSON gösterimi | |
---|---|
{
"name": string,
"open": {
object ( |
Alanlar | |
---|---|
name |
Bağlantının adı |
open |
Kullanıcının bağlantıyı açtığı andaki davranışı tanımlar. |
OpenUrl
Kullanıcının bağlantıyı açtığı andaki davranışı tanımlar.
JSON gösterimi | |
---|---|
{
"url": string,
"hint": enum ( |
Alanlar | |
---|---|
url |
Şunlardan herhangi biri olabilecek URL alanı: - Uygulamaya bağlı bir uygulamayı veya web sayfasını açmak için http/https urls |
hint |
URL türüyle ilgili bir ipucunu gösterir. |
UrlHint
Farklı URL ipuçları türleri.
Sıralamalar | |
---|---|
HINT_UNSPECIFIED |
Belirtilmedi |
AMP |
Doğrudan AMP içeriğine veya <link rel="amphtml"> aracılığıyla AMP içeriğine başvuruda bulunan standart URL'ye yönlendiren URL. |
StaticTablePrompt
Bir metin tablosunu gösteren tablo kartı.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Alanlar | |
---|---|
title |
İsteğe bağlı. Tablonun genel başlığı. Altyazı ayarlanmışsa ayarlanmalıdır. |
subtitle |
İsteğe bağlı. Tablonun alt başlığı. |
image |
İsteğe bağlı. Tabloyla ilişkilendirilen resim. |
columns[] |
İsteğe bağlı. Başlıklar ve sütunların hizalaması. |
rows[] |
İsteğe bağlı. Tablonun satır verileri. İlk 3 satırın gösterileceği garanti edilir ancak diğerleri belirli yüzeylerde kesilebilir. Belirli bir yüzeyde hangi satırların gösterileceğini görmek için lütfen simülasyon aracıyla test edin. |
button |
İsteğe bağlı. Düğme. |
TableColumn
Tablodaki bir sütunu açıklar.
JSON gösterimi | |
---|---|
{
"header": string,
"align": enum ( |
Alanlar | |
---|---|
header |
Sütunun başlık metni. |
align |
İçerik sütunuyla yatay hizalama. Belirtilmemişse içerik ön kenarla hizalanır. |
HorizontalAlignment
Hücredeki içeriğin hizalaması.
Sıralamalar | |
---|---|
UNSPECIFIED |
Yatay Hizalama belirtilmemiş. |
LEADING |
Hücrenin ön kenarı. Bu, varsayılan ayardır. |
CENTER |
İçerik, sütunun ortasına hizalanır. |
TRAILING |
İçerik, sütunun son kenarıyla hizalanır. |
TableRow
Tablodaki bir satırı açıklar.
JSON gösterimi | |
---|---|
{
"cells": [
{
object ( |
Alanlar | |
---|---|
cells[] |
Bu satırdaki hücreler. İlk 3 hücrenin gösterileceği garanti edilir ancak diğerleri belirli yüzeylerde kesilebilir. Belirli bir yüzey için hangi hücrelerin gösterileceğini görmek üzere lütfen simülasyon aracıyla test yapın. |
divider |
Her satırdan sonra bir ayırıcı olması gerekip gerekmediğini belirtir. |
TableCell
Bir satırdaki bir hücreyi açıklar.
JSON gösterimi | |
---|---|
{ "text": string } |
Alanlar | |
---|---|
text |
Hücrenin metin içeriği. |
StaticMediaPrompt
Medya hakkında ad, açıklama, URL vb. bilgiler içerir. Sonraki kimlik: 11
JSON gösterimi | |
---|---|
{ "mediaType": enum ( |
Alanlar | |
---|---|
mediaType |
Bu yanıtın medya türü. |
startOffset |
İlk medya nesnesinin başlangıç ofseti. En fazla dokuz kesirli basamağa sahip, " |
optionalMediaControls[] |
Bu medya yanıtı oturumunun destekleyebileceği isteğe bağlı medya kontrolü türleri. Ayarlanırsa belirli bir medya etkinliği gerçekleştiğinde 3. tarafa istek gönderilir. Ayarlanmazsa 3p yine de TAMAMLANDI ve BAŞARISIZ olmak üzere iki varsayılan kontrol türünü işlemelidir. |
mediaObjects[] |
Medya nesnelerinin listesi. |
repeatMode |
Medya Nesneleri listesi için tekrar modu. |
MediaType
Bu yanıtın medya türü.
Sıralamalar | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
UNSPECIFIED (BELİRTİLMEMİŞ) değer |
AUDIO |
Ses dosyası. |
MEDIA_STATUS_ACK |
Medya durum raporunu onaylama yanıtı. |
OptionalMediaControls
Medya yanıtının isteğe bağlı olarak destekleyebileceği medya kontrol türleri
Sıralamalar | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Belirtilmemiş değer |
PAUSED |
Etkinlik duraklatıldı. Kullanıcı medyayı duraklattığında tetiklenir. |
STOPPED |
Etkinlik durduruldu. Kullanıcı medya oynatma sırasında 3. oturumdan çıktığında tetiklenir. |
MediaObject
Tek bir medya nesnesini temsil eder.
JSON gösterimi | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Alanlar | |
---|---|
name |
Bu medya nesnesinin adı. |
description |
Bu medya nesnesinin açıklaması. |
url |
Medya içeriğini gösteren URL. |
image |
Medya kartıyla gösterilecek resim. |
MediaImage
MediaPrompt içinde gösterilecek resim.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
Birleştirme alanı image . Yalnızca bir MediaImage türüne izin verilir. image şunlardan yalnızca biri olabilir: |
||
large |
Albümün kapağı gibi büyük bir resim. |
|
icon |
Başlığın sağında küçük bir resim simgesi görüntülenir. 36x36 dp olarak yeniden boyutlandırıldı. |
RepeatMode
Medya nesnelerinin listesi için tekrar modu türleri.
Sıralamalar | |
---|---|
REPEAT_MODE_UNSPECIFIED |
KAPALI durumuna eşdeğerdir. |
OFF |
Son medya nesnesinin sonunda medya oturumunu sonlandırın. |
ALL |
Son medya nesnesinin sonuna ulaşıldığında ilk medya nesnesinin başına döngü oluştur. |
StaticListPrompt
Seçebileceğiniz seçeneklerin listesini sunan bir kart.
JSON gösterimi | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Alanlar | |
---|---|
title |
İsteğe bağlı. Listenin başlığı. |
subtitle |
İsteğe bağlı. Listenin alt başlığı. |
items[] |
Zorunlu. Liste öğeleri. |
ListItem
Listedeki bir öğe.
JSON gösterimi | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Alanlar | |
---|---|
key |
Zorunlu. İlişkili türdeki giriş anahtarıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda, bu anahtar seçim seçeneği parametresi olarak geri yayınlanır. |
title |
Zorunlu. Öğenin başlığı. Bu metin dokunulduğunda, kullanıcı yazmış gibi görüşmede olduğu gibi yayınlanır. Her başlık, öğe grubu içinde benzersiz olmalıdır. |
description |
İsteğe bağlı. Öğenin gövde metni. |
image |
İsteğe bağlı. Öğe resmi. |
StaticCollectionPrompt
Aralarından seçim yapabileceğiniz bir dizi seçenek sunan bir kart.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Alanlar | |
---|---|
title |
İsteğe bağlı. Koleksiyonun başlığı. |
subtitle |
İsteğe bağlı. Koleksiyonun alt başlığı. |
items[] |
Zorunlu. Koleksiyon öğeleri'ne dokunun. |
imageFill |
İsteğe bağlı. Resim görüntüleme seçeneğinin türü. |
CollectionItem
Koleksiyondaki bir öğe.
JSON gösterimi | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Alanlar | |
---|---|
key |
Zorunlu. İlişkili Türdeki giriş anahtarı adıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda, bu anahtar seçim seçeneği parametresi olarak geri yayınlanır. |
title |
Zorunlu. Öğenin başlığı. Bu metin dokunulduğunda, kullanıcı yazmış gibi görüşmede olduğu gibi yayınlanır. Her başlık, öğe grubu içinde benzersiz olmalıdır. |
description |
İsteğe bağlı. Öğenin gövde metni. |
image |
İsteğe bağlı. Öğe resmi. |
StaticCollectionBrowsePrompt
Bir dizi web dokümanını, büyük parçalı öğelerin koleksiyonu olarak sunar. İlişkili web dokümanlarını bir web görüntüleyicide başlatmak için öğeler seçilebilir.
JSON gösterimi | |
---|---|
{ "items": [ { object ( |
Alanlar | |
---|---|
items[] |
Göz atma koleksiyonundaki öğeler. Liste boyutu [2, 10] aralığında olmalıdır. |
imageFill |
Koleksiyondaki resimler için resim görüntüleme seçeneği. |
CollectionBrowseItem
Koleksiyondaki öğe.
JSON gösterimi | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Alanlar | |
---|---|
title |
Zorunlu. Koleksiyon öğesinin başlığı. |
description |
Koleksiyon öğesinin açıklaması. |
footer |
Koleksiyon öğesi için açıklamanın altında görüntülenen altbilgi metni. Üç nokta ile kısaltılmış tek satır metin. |
image |
Koleksiyon öğesinin resmi. |
openUriAction |
Zorunlu. Öğe seçildiyse açılacak URI. |
Öneri
Kolaylık sağlamak amacıyla kullanıcıya gösterilen bir kullanıcı arayüzü öğesi olan öneri çipini temsil eder.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Zorunlu. Öneri çipinde gösterilen metin. Bu metin dokunulduğunda, kullanıcı yazmış gibi görüşmede olduğu gibi yayınlanır. Her başlık, öneri çipi grubu içinde benzersiz olmalıdır. Maksimum 25 karakter |
StaticCanvasPrompt
Kullanıcıya gönderilecek Etkileşimli Tuval yanıtını temsil eder. Bu, etkileşimli bir tuval yanıtı göstermenin yanı sıra kullanıcıyla konuşmak için içeren istemdeki firstSimple
alanıyla birlikte kullanılabilir.
JSON gösterimi | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
Alanlar | |
---|---|
url |
Zorunlu. Yüklenecek web görünümünün URL'si. |
data[] |
İsteğe bağlı. Tam sayfa deneyim web sayfasına etkinlik olarak aktarılacak JSON verileri. İçeren istemdeki |
suppressMic |
İsteğe bağlı. Doğru değeri, bu etkileyici yanıt kullanıcıya sunulduktan sonra giriş yakalamak için mikrofonun açılmayacağı anlamına gelir. |
sendStateDataToCanvasApp |
İsteğe bağlı. |
enableFullScreen |
İsteğe bağlı. |
Sahne
Sahne, bir konuşma tasarlarken kontrol akışının temel birimidir. Bu sahneler diğer sahnelerle birleştirilebilir, son kullanıcı için istemler oluşturabilir ve alanları tanımlayabilir. Sahne adı, dosyanın adında belirtilir.
JSON gösterimi | |
---|---|
{ "onEnter": { object ( |
Alanlar | |
---|---|
onEnter |
Bu sahneye geçiş yaparken çağrılacak işleyici. |
intentEvents[] |
Amaçlara göre tetiklenen etkinliklerin listesi. Bu etkinlikler, on_load İşleyicisi çağrıldıktan sonra herhangi bir zamanda tetiklenebilir. Önemli: Bu etkinlikler, bu sahnenin kapsamında olan amaçlar grubunu tanımlar ve aynı amaçlara veya tetikleme ifadelerine sahip olan ve genel olarak tanımlanmış tüm etkinliklere göre önceliklidir. Bir sahne içindeki amaç adları benzersiz olmalıdır. |
conditionalEvents[] |
Koşullu ifadelere göre tetiklenecek etkinliklerin listesi. Bu sahneler, form doldurulduktan sonra veya bu sahnede bir form yoksa (değerlendirme yalnızca bir kez yapılır) on_load olduktan hemen sonra değerlendirilir. Yalnızca eşleşen ilk etkinlik tetiklenir. |
slots[] |
Sıralı aralık listesi. Her alan, çözümleyeceği veri türünü ve bu çözünürlük deneyimini (ör. istemler) özelleştirmek için yapılandırılacak verileri tanımlar. |
onSlotUpdated |
İşleyici, başka bir İşleyici'deki güncellemelerden kaynaklanmayan bir alanın durumunda değişiklik olduğunda çağrıldı. Bu, alanların geçersiz kılınmasına, sahnenin geçersiz kılınmasına veya sahne durumunda yapılan diğer değişikliklere izin verir. |
IntentEvent
Amaç eşleşmesinin sonucu olarak tetiklenen Etkinlikleri kaydeder.
JSON gösterimi | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Alanlar | |
---|---|
intent |
Zorunlu. Etkinliği tetikleyen amaç. |
transitionToScene |
İsteğe bağlı. Sohbetin atlanması gereken hedef sahne. Geçerli sahnenin durumu geçişte yok olur. |
handler |
İsteğe bağlı. Amaç eşleştiğinde tetiklenen etkinlik işleyici. Hedef sahneye geçişten önce yürütülmelidir. Etkinliklere yanıt olarak istem oluşturmak için kullanışlıdır. |
ConditionalEvent
Doğru bir koşul sonucu tetiklenen etkinlikleri kaydeder.
JSON gösterimi | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Alanlar | |
---|---|
condition |
Zorunlu. Bu etkinliğin tetikleneceği filtre koşulu. Koşul doğru olarak değerlendirilirse ilişkilendirilmiş |
transitionToScene |
İsteğe bağlı. İlişkili koşul doğru olarak değerlendirildiğinde ileti dizisinin atlanması gereken hedef sahne. Geçerli sahnenin durumu geçişte yok olur. |
handler |
İsteğe bağlı. İlişkili koşul |
Alan
Alan yapılandırması. Alanlar, doğal dil (ör. intent parametreleri), oturum parametreleri ve diğer kaynaklarla doldurulabilen tek veri birimleridir.
JSON gösterimi | |
---|---|
{ "name": string, "type": { object ( |
Alanlar | |
---|---|
name |
Zorunlu. Alanın adı. |
type |
Zorunlu. Bu alanın veri türünü tanımlar. |
required |
İsteğe bağlı. İlerlemeden önce alanın doldurulmasının gerekli olup olmadığını gösterir. Doldurulmayan gerekli alanlar, kullanıcı için özelleştirilebilir bir istemi tetikler. |
promptSettings |
İsteğe bağlı. Slot doldurmanın farklı aşamaları için istemleri kaydeder. |
commitBehavior |
İsteğe bağlı. Alanla ilişkili kaydetme davranışı. |
config |
İsteğe bağlı. Alanı doldurmak için kullanılan alanla ilişkilendirilmiş ek yapılandırma. Yapılandırmanın biçimi, alanın türüne göre belirlenir. Bu yapılandırmaya, kullanıcı veya oturum parametresine kaynak referansları eklenebilir. Bu yapılandırma, işlemler ve kullanıcı etkileşimiyle ilgili alanları doldurmak için gereklidir. Örnek: actions.type.CompletePurchaseValue türündeki bir alan için aşağıdaki yapılandırma, istemci tanımlı { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } |
defaultValue |
İsteğe bağlı. Bu alan için varsayılan değeri dolduracak yapılandırma. |
PromptSettings
Alan istemlerinin tanımlandığı tek bir yer.
JSON gösterimi | |
---|---|
{ "initialPrompt": { object ( |
Alanlar | |
---|---|
initialPrompt |
Alan değerinin kendisi için istem girin. Örnek: "Hangi bedeni istemiştiniz?" |
noMatchPrompt1 |
Kullanıcının girişi, alan için beklenen değer türüyle ilk kez eşleşmediğinde komut istemi. Örnek: "Maalesef anlayamadım." |
noMatchPrompt2 |
Kullanıcının girişi, alan için beklenen değer türüyle ikinci kez eşleşmediğinde komut istemi. Örnek: "Maalesef anlayamadım." |
noMatchFinalPrompt |
Kullanıcının girişi, alan için son kez beklenen değer türüyle eşleşmediğinde komut istemi. Örnek: "Maalesef anlayamadım." |
noInputPrompt1 |
Kullanıcı ilk kez giriş sağlamadığında komut istemi. Örnek: "Maalesef anlayamadım." |
noInputPrompt2 |
Kullanıcı ikinci kez giriş sağlamadığında komut istemi. Örnek: "Maalesef anlayamadım." |
noInputFinalPrompt |
Kullanıcı son kez giriş sağlamadığında komut istemi. Örnek: "Maalesef anlayamadım." |
CommitBehavior
Başarıyla doldurulduktan sonra alanla ilişkili kaydetme davranışını açıklayan mesaj.
JSON gösterimi | |
---|---|
{ "writeSessionParam": string } |
Alanlar | |
---|---|
writeSessionParam |
Alan değeri doldurulduktan sonra yazılacak oturum parametresi. İç içe yerleştirilmiş yolların şu anda desteklenmediğini unutmayın. "$$" alan değerini, alanla aynı ada sahip bir oturum parametresine yazmak için kullanılır. Örnek: writeSessionParam = "meyve" "$session.params.fruit" değerine karşılık gelir. WriteSessionParam = "ticket" "$session.params.ticket" öğesine karşılık gelir. |
DefaultValue
Bu alan için varsayılan değeri dolduracak yapılandırma.
JSON gösterimi | |
---|---|
{ "sessionParam": string, "constant": value } |
Alanlar | |
---|---|
sessionParam |
İsteğe bağlı. Alan değerini başlatmak için kullanılacak oturum parametresi (boş olmayan bir değer içeriyorsa). Değerin türü alanın türüyle eşleşmelidir. İç içe yerleştirilmiş yolların şu anda desteklenmediğini unutmayın. Örnek: |
constant |
İsteğe bağlı. Alan için sabit varsayılan değer. Bu seçenek yalnızca bu alan için bir değer |
DataFiles
Tekrarlanan veri dosyası için sarmalayıcı. Yinelenen alanlar şunlardan birinde bulunamaz.
JSON gösterimi | |
---|---|
{
"dataFiles": [
{
object ( |
Alanlar | |
---|---|
dataFiles[] |
Birden fazla veri dosyası. |
DataFile
Yapılandırılmamış veri içeren tek bir dosyayı temsil eder. Resim dosyaları, ses dosyaları ve Cloud Functions işlevi kaynak kodu, bu bilgilere örnek olarak verilebilir.
JSON gösterimi | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Alanlar | |
---|---|
filePath |
SDK dosya yapısındaki proje kökünden veri dosyasının göreli yolu. İzin verilen dosya yolları: - Resimler: |
contentType |
Zorunlu. Bu öğenin içerik türü. Örnek: |
payload |
Veri dosyasının içeriği. Örnek olarak resimlerin ham baytları, ses dosyaları veya Cloud Functions işlevi ZIP biçimi verilebilir. Yük boyutu için 10 MB'lık katı bir sınır vardır. base64 kodlu bir dize. |