- 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
- Yuva
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Dosya listesi için sarmalayıcı.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
file_type alanı. Yapılandırma dosyaları veya veri dosyaları gibi aynı anda sunucuya yalnızca bir dosya türü gönderilebilir. file_type şunlardan yalnızca biri olabilir: |
||
configFiles |
Yapılandırma dosyalarının listesi. Buna manifest, ayarlar, etkileşim modeli kaynak grupları ve daha fazlası dahildir. |
|
dataFiles |
Veri dosyalarının listesi. Buna görüntü, ses dosyası, Cloud Functions işlevi kaynak kodu da dahildir. |
ConfigFiles
Tekrarlanan yapılandırma dosyaları için sarmalayıcı. Yinelenen alanlar bunlardan birinde bulunamaz.
JSON gösterimi | |
---|---|
{
"configFiles": [
{
object ( |
Alanlar | |
---|---|
configFiles[] |
Birden fazla yapılandırma dosyası. |
ConfigFile
Yapılandırılmış veriler içeren tek bir dosyayı temsil eder. Geliştiriciler projelerinin çoğunu; İşlemler, Ayarlar ve Sipariş Karşılama gibi yapılandırılmış yapılandırmalar kullanarak tanımlayabilirler.
JSON gösterimi | |
---|---|
{ "filePath": string, // Union field |
Alanlar | ||
---|---|---|
filePath |
SDK dosya yapısındaki proje kökünden yapılandırma dosyasının göreli yolu. Aşağıdaki her dosya türü için izin verilen bir dosya yolu vardır. Ör. settings/settings.yaml |
|
file alanı. Her yapılandırma dosyası türüne 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 bir işlem dosyası. İzin verilen dosya yolları: |
|
settings |
Projenin varsayılan yerel ayarı (belirtilmişse) için yerelleştirilemeyen ayarları ve ayarları 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 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 bir 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
"Taşınabilir" olan, yani belirli bir projeye özgü olmayan ve projeler arasında taşınabilen bilgileri içerir.
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 İşlemlerin listesini temsil eder.
JSON gösterimi | |
---|---|
{
"custom": {
string: {
object ( |
Alanlar | |
---|---|
custom |
Projenin çağrılarını yapılandırmak için amaçlardan özel işlemlere eşleyin. Çağrı amaçları "custom/intents/" paketinde tanımlanan sistem veya özel amaçlar olabilir. Burada tanımlanan tüm amaçların (sistem amaçları ve özel amaçlar) "custom/global/" paketinde karşılık gelen bir intent dosyası olmalıdır.
|
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 niyetle 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üncellemeye 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}" bilgilerinizi saat kaçta göndermemi istersiniz ve push bildirimleriyle ilgili olarak "{title}" için push bildirimleri göndersem olur mu? Bu alan yerelleştirilebilir. |
pushNotification |
Bu etkileşimin desteklediği push bildirimi ayarları. |
actionLink |
Paylaşım bağlantılarının işlem için etkinleştirilip etkinleştirilmediğini belirleyen ve etkinleştirildiğinde bağlantının kullanıcı dostu görünen adını içeren bir işlemin bağlantı yapılandırması. ActionLink desteği sonlandırıldı. Bunun yerine AssistantLink'i kullanın. |
assistantLink |
Paylaşım bağlantılarının işlem için etkinleştirilip etkinleştirilmediğini belirleyen ve etkinleştirildiğinde bağlantının kullanıcı dostu görünen adını içeren bir işlemin bağlantı yapılandırması. |
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
Paylaşım bağlantılarının bu işlem için etkinleştirilip etkinleştirilmediğini ve ilgili ayarları 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ı için kullanıcı dostu görünen başlık. |
AssistantLink
Paylaşım bağlantılarının bu işlem için etkinleştirilip etkinleştirilmediğini ve ilgili ayarları 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ı için kullanıcı dostu görünen başlık. |
Ayarlar
Bir Actions projesinin yerel ayara özgü 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 olan yerel ayar. |
enabledRegions[] |
Kullanıcının, bulunduğu konuma bağlı olarak İşlemlerinizi çağırabileceği bölgeleri temsil eder. |
disabledRegions[] |
Kullanıcının bulunduğu konuma göre İşlemlerinizin engellendiği bölgeleri temsil eder. |
category |
Bu Actions projesinin kategorisi. |
usesTransactionsApi |
İşlemlerin işlemleri kullanıp kullanamayacağı (örneğin, rezervasyon yapma, sipariş alma vb.). Yanlış değerine ayarlanırsa İşlemler API'lerini kullanma denemeleri başarısız olur. |
usesDigitalPurchaseApi |
İşlemlerin dijital ürünlerle ilgili işlem yapıp yapamayacağını belirtir. |
usesInteractiveCanvas |
İşlemlerin Etkileşimli Tuval kullanıp kullanmayacağını belirler. |
usesHomeStorage |
Actions'ın ev depolama alanı özelliğini kullanıp kullanmayacağını belirler. |
designedForFamily |
Actions içeriğinin aileler için (DFF) olup olmadığı. |
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ğını belirtir. |
surfaceRequirements |
Bu projede Actions'ı çağırmak için bir istemci yüzeyinin desteklemesi gereken yüzey gereksinimleri. |
testingInstructions |
İşlem inceleme uzmanı için serbest biçimli test talimatları (ör. 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 üzerinden hesap oluşturmasına veya bağlamasına izin verin. |
selectedAndroidApps[] |
İşlemler için 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 actions projesine bağlı Android uygulamalarından yapılan 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çimleridir.
Sıralamalar | |
---|---|
CATEGORY_UNSPECIFIED |
Bilinmiyor / Belirtilmemiş. |
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 |
Oyunlar 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 |
Verimlilik kategorisi. |
SHOPPING |
Alışveriş kategorisi. |
SOCIAL |
Sosyal kategori. |
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
Projenizde İşlemleri çağırmak için istemci yüzeyinin desteklemesi gereken bir dizi gereksinim içerir.
JSON gösterimi | |
---|---|
{
"minimumRequirements": [
{
object ( |
Alanlar | |
---|---|
minimumRequirements[] |
Projenizdeki Actions'ı çağırmak için gereken minimum özellik grubu. Yüzeyde bunlardan herhangi biri eksikse işlem tetiklenmez. |
CapabilityRequirement
Belirli bir işlevin kullanılabilirliği ile ilgili bir gereksinimi temsil eder.
JSON gösterimi | |
---|---|
{
"capability": enum ( |
Alanlar | |
---|---|
capability |
Özelliğin türü. |
SurfaceCapability
Olası yüzey özellikleri kümesi.
Sıralamalar | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Bilinmiyor / Belirtilmemiş. |
AUDIO_OUTPUT |
Yüzey, ses çıkışını destekler. |
SCREEN_OUTPUT |
Yüzey, ekran/görsel çıkışı destekler. |
MEDIA_RESPONSE_AUDIO |
Yüzey, medya yanıtı sesini destekler. |
WEB_BROWSER |
Surface web tarayıcılarını destekler. |
ACCOUNT_LINKING |
Surface, hesap bağlamayı destekliyor. |
INTERACTIVE_CANVAS |
Yüzey, Etkileşimli Tuval'i destekler. |
HOME_STORAGE |
Yüzey, evde depolama alanını destekler. |
LocalizedSettings
Bir Actions projesinin kullanıcının yerel ayarına özel 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 projesinin varsayılan görünen adı (çeviri yoksa) |
pronunciation |
Zorunlu. Ses (sözlü) bağlamında çağrılacak görünen adın telaffuzu. |
shortDescription |
Zorunlu. Actions projesinin varsayılan kısa açıklaması (çeviri yoksa). 80 karakterle sınırlıdır. |
fullDescription |
Zorunlu. Actions projesinin varsayılan uzun açıklaması (ç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 piksellik 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 bulunduklarında duydukları 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ı kullanılır. Belirtilirse 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 dizininde 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ı olur. |
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 |
Actions on Google kartlarında başlığın metin rengini, işlem öğesi arka plan rengini belirlemek için işlemin birincil tema rengi 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 Yoğunlaştırılmış - Sans Serif Yoğunlaştırılmış Orta - Serif - Serif Kalın - Tek Aralıklı - Steno - Sans Serif Smallcaps |
imageCornerStyle |
Kartların ön plan resminin kenarlık stili. Örneğin, basit bir kartın veya rulo kartının ön plan resmine uygulanabilir. |
landscapeBackgroundImage |
Yatay mod (minimum 1.920x1.200 piksel). Bu, |
portraitBackgroundImage |
Dikey mod (minimum 1.200x1.920 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
AccountLinking, Google'ın kullanıcıyı uygulamanın web hizmetlerinde oturum açması için yönlendirmesine olanak tanır.
Google, Google ile Oturum Açma ve OAuth + Google ile Oturum Açma bağlantı türlerinde, Uygulamanızı Google'a tanımlayan bir istemci kimliği oluşturur ("İstemci Kimliği", Console kullanıcı arayüzünde Google tarafından İşlemler'inize gönderilir). 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 adresine göz atın.
Not: Tüm hesap bağlama ayar türlerinde (Google ile Oturum Açma hariç) inceleme ekibinin uygulamayı incelemesi için Settings.testing_instructions adresinde bir test hesabı için kullanıcı adı ve şifre sağlamanız gerekir (kullanıcılar bunlar tarafından görülmez).
JSON gösterimi | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Alanlar | |
---|---|
enableAccountCreation |
Zorunlu. |
linkingType |
Zorunlu. Kullanılacak bağlantı türü. Bağlantı türleri hakkında daha fazla 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'ı hizmetiniz için 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 dolaylı akışları destekleyen uç nokta. URL'de HTTPS kullanılmalı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'de HTTPS kullanılmalıdır. Bağlantı türü olarak yalnızca IMPLICIT izni ile OAuth kullanılırken bu ayarlanmaz. Yalnızca OAuth kullanılırken ayarlanır. |
scopes[] |
İsteğe bağlı. Hizmetinizi kullanmak için kullanıcının izin vermesi 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 yer alan ve 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 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. |
useBasicAuthHeader |
İsteğe bağlı. Doğru değerine ayarlanırsa Google'ın, istemci kimliğini ve gizli anahtarı HTTP temel kimlik doğrulama başlığı üzerinden iletmesine izin ver. Aksi takdirde Google, yayın gövdesinde istemci kimliğini ve gizli anahtarı 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ünü kullanıyorsanız aşağıda OAuth ile ilgili herhangi bir alanı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, uygulamanızın web hizmetinde oturum açması için kullanıcıyı yönlendirmek amacıyla kullandığı OAuth2 erişim izni türü.
Sıralamalar | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
Belirtilmedi. |
AUTH_CODE |
Yetkilendirme kodu verme. Hem kimlik doğrulama URL'si hem de erişim jetonu URL'si sağlamanızı gerektirir. |
IMPLICIT |
Örtülü kod verme. Yalnızca kimlik doğrulama URL'si sağlamanızı gerektirir. |
Webhook
Farklı webhook türleriyle ilgili 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ğerinin kod yapısı şuna benzer: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
JSON gösterimi | |
---|---|
{ "handlers": [ { object ( |
Alanlar | ||
---|---|---|
handlers[] |
Bu webhook için işleyicilerin listesi. |
|
webhook_type alanı. Yalnızca bir webhook türü desteklenir. webhook_type şunlardan yalnızca biri olabilir: |
||
httpsEndpoint |
Özel webhook HTTPS uç noktası. |
|
inlineCloudFunction |
Webhook klasöründeki koddan dağıtılan bulut işlevi için meta veriler. |
İşleyici
Webhoook işleyicinin adını tanımlar. Bir webhook'un birden fazla işleyicisi olabilir. Bu işleyiciler, Actions projenizdeki birden fazla yerden çağrılabilir.
JSON gösterimi | |
---|---|
{ "name": string } |
Alanlar | |
---|---|
name |
Zorunlu. İşleyicinin adı. Actions projesinin tüm işleyicileri genelinde 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ın 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 uyarınca). Örneğin, "https://gactions.service.com/api" temel URL'si "https://gactions.service.com/api:{method}" URL'sine sahip istekleri alır. |
httpHeaders |
POST isteğine dahil edilecek HTTP parametreleri eşlemesi.
|
endpointApiVersion |
Uç nokta tarafından kullanılan protokolün sürümü. Bu, tüm istek karşılama türleri tarafından paylaşılan ve Google istek karşılama türüne özel olmayan protokoldür. |
InlineCloudFunction
Webhook klasöründen dağıtılan bir 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 koddan dışa aktarılan yöntemin adıyla eşleşmelidir. |
Amaç
Intent'ler, açık uçlu kullanıcı girişini yapılandırılmış nesnelerle eşleştirir. Konuşulan ifadeler, Google'ın Doğal Dil Anlama (NLU) özelliğiyle amaçlarla eşleştirilir. Amaç eşleşmeleri, kullanıcının konuşmasını ilerletmek için görüşme tasarımınızdaki etkinlikleri tetikleyebilir. Amaç adı, dosyanın adında belirtilir.
JSON gösterimi | |
---|---|
{
"parameters": [
{
object ( |
Alanlar | |
---|---|
parameters[] |
Eğitim ifadeleri içindeki parametrelerin listesi. Eğitim ifadesinde kullanılacak tüm parametrelerin burada tanımlanması gerekir. |
trainingPhrases[] |
Eğitim ifadeleri, Google'ın NLU'nun, amaçları kullanıcı girişiyle otomatik olarak eşleştirmesini sağlar. Ne kadar çok benzersiz ifade sağlanırsa bu amacın eşleşme olasılığı o kadar artar. Aşağıda, ek açıklamaya sahip eğitim ifadesi bölümünün biçimidir. |
IntentParameter
Eğitim ifadelerinin içinde kullanılabilecek bir parametrenin tanımı.
JSON gösterimi | |
---|---|
{ "name": string, // Union field |
Alanlar | ||
---|---|---|
name |
Zorunlu. Niyet parametresinin benzersiz adı. $intent.params.[name].resolved ile NLU tarafından ayıklanan amaç parametrelerine referans vermek için kullanılan koşullarda ve yanıtlarda kullanılabilir |
|
parameter_type alanı. 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" dizinindeki varlık gruplarına işaret eder. |
ClassReference
Bir alanın türünü veya döndürülen değeri bildirmek için kullanılan bir sınıfa başvuru. Sıralamalar aynı zamanda ClassReference kullanılarak referans verilebilen bir sınıf türüdür.
JSON gösterimi | |
---|---|
{ "name": string, "list": boolean } |
Alanlar | |
---|---|
name |
Zorunlu. Parametrenin yerleşik 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 varlık grubu referansları.
JSON gösterimi | |
---|---|
{
"entitySetReferences": [
{
object ( |
Alanlar | |
---|---|
entitySetReferences[] |
Zorunlu. Bir intent parametresi için varlık 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 öğe koleksiyonunu tanımlar. İlgili varlık grubu tanımı custom/entitySets/ dizininde bulunmalıdır. |
Tür
Yerleşik türler yerine özel tür bildirimi. Türler, bir sahnedeki slotlara veya bir amacın eğitim ifadelerinin parametrelerine atanabilir. Türler, pratikte enum'lar olarak düşünülebilir. Tür adı, dosyanın adında belirtilir.
JSON gösterimi | |
---|---|
{ "exclusions": [ string ], // Union field |
Alanlar | ||
---|---|---|
exclusions[] |
Türe göre eşleştirilmemesi gereken istisnai kelimeler/kelime öbekleri grubu. Not: Kelime/kelime öbeği türle eşleşse de hariç tutma olarak listelenirse parametre çıkarma sonucunda döndürülmez. Bu alan yerelleştirilebilir. |
|
sub_type alanı. Yapılacak eşleşme türüne göre alt tür seçimi. sub_type şunlardan yalnızca biri olabilir: |
||
synonym |
Temelde bir enum olan eş anlamlılar türü. |
|
regularExpression |
Normal ifade türü, normal ifade eşleşmesine olanak tanır. |
|
freeText |
FreeText türü. |
SynonymType
Metinle eş anlamlılar kümesine göre eşleşen tür.
JSON gösterimi | |
---|---|
{ "matchType": enum ( |
Alanlar | |
---|---|
matchType |
İsteğe bağlı. Eş anlamlı kelimenin eşleme türü. |
acceptUnknownValues |
İsteğe bağlı. Doğru değerine ayarlandığında, bilinmeyen kelimeleri veya ifadeleri etraftaki 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ürdeki girişlerin kullanacağı eşleme türü. Bu, tüm türlerin aynı eşleştirme yöntemini kullanmasını sağlar ve eş anlamlı eşleme için eşleme varyasyonuna (ör. belirsiz veya tam eşleme) izin verir. Değer UNSPECIFIED
ise varsayılan olarak EXACT_MATCH
olur.
Sıralamalar | |
---|---|
UNSPECIFIED |
Varsayılan olarak EXACT_MATCH değerine ayarlanır. |
EXACT_MATCH |
Eş anlamlı kelimenin veya adın tam eşleşmesini arar. |
FUZZY_MATCH |
EXACT_MATCH değerinden daha geniş. Tam eşleşmelerin yanı sıra benzer eşleşmeleri de arar. |
Varlık
Tür içindeki tek bir girişin ayrıntılarını içeren eş anlamlı bir varlık alanını temsil eder.
JSON gösterimi | |
---|---|
{
"display": {
object ( |
Alanlar | |
---|---|
display |
İsteğe bağlı. Varlıkta görünen 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ıktan sonra tuvalde gösterilecek öğeler. Yalnızca tuvalin etkin olduğu 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
Normal ifadelere göre metinle eşleşen 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ıktan sonra tuvalde gösterilecek öğeler. Yalnızca tuvalin etkin olduğu uygulamalar için geçerlidir. |
regularExpressions[] |
Zorunlu. RE2 normal ifade söz dizimini kullanır (Daha ayrıntılı bilgi için https://github.com/google/re2/wiki/Syntax adresine bakın) |
FreeTextType
Kelimelerin bağlamı eğitim örneklerine yakınsa herhangi bir metinle eşleşen metin yazın.
JSON gösterimi | |
---|---|
{
"display": {
object ( |
Alanlar | |
---|---|
display |
İsteğe bağlı. Sorgudan bir varlık çıkarıldıktan sonra tuvalde gösterilecek öğeler. Yalnızca tuvalin etkin olduğu uygulamalar için geçerlidir. |
EntitySet
Varlık grupları, yerleşik amaç parametrelerinin değerlerinin gelebileceği önceden tanımlanmış varlık grubunu tanımlar. Yerleşik amaç parametrelerindeki assetSet parametresinden varlık gruplarına referans verilebilir.
JSON gösterimi | |
---|---|
{
"entities": [
{
object ( |
Alanlar | |
---|---|
entities[] |
Zorunlu. Bu öğe grubunun desteklediği varlıkların listesi. |
Varlık
Yerleşik amaç parametresi değerinin gelebileceği bir varlık.
JSON gösterimi | |
---|---|
{ "id": string } |
Alanlar | |
---|---|
id |
Zorunlu. Varlığın kimliği. Yerleşik amaç parametrelerinin ve desteklenen varlıklarının listesi için https://developers.google.com/assistant/conversational/build/built-in-intents adresini ziyaret edin. |
GlobalIntentEvent
Genel amaç işleyici tanımlar. Genel amaç etkinlikleri, Actions projesinin tamamını kapsar ve bir sahnedeki amaç işleyiciler tarafından geçersiz kılınabilir. Amaç adları bir Actions projesi içinde benzersiz olmalıdır.
Genel amaçlar oturum sırasında herhangi bir zamanda eşleştirilebilir. Böylece kullanıcılar "yardım alma" veya "ana sayfaya geri dönme" gibi sık kullanılan akışlara erişebilir. Bir İşlemi çağırdıklarında kullanıcıları belirli akışlara derin bağlantı oluşturmak için de kullanılabilirler.
Amaç adının, dosyanın adında belirtildiğini unutmayın.
JSON gösterimi | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Alanlar | |
---|---|
transitionToScene |
İsteğe bağlı. Konuşmanın atlanacağı hedef sahne. Geçişte mevcut sahnenin durumu silinir. |
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 İstem oluşturmak için kullanışlıdır. |
EventHandler
Bir etkinlikten sonra yürütülecek bir işleyici tanımlar. Etkinliklere örnek olarak, bir sahnedeki amaç ve koşula dayalı etkinlikler verilebilir.
JSON gösterimi | |
---|---|
{ "webhookHandler": string, // Union field |
Alanlar | ||
---|---|---|
webhookHandler |
Çağrılacak webhook işleyicinin adı. |
|
prompt alanı. İstemler satır içine alınabilir veya ada göre referans gösterilebilir. 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. Bunlardan biri kullanıcıya verilen 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 istemde, ne zaman kullanılabileceğini belirleyen bir seçici bulunur. Bir istekle eşleşen ilk seçici gönderilir ve geri kalanı yok sayı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
İstemin bir 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 işlem için istekte bulunmak üzere kullandığı yüzeyi temsil eder.
JSON gösterimi | |
---|---|
{
"capabilities": [
enum ( |
Alanlar | |
---|---|
capabilities[] |
Zorunlu. İşlem'e istekte bulunan yüzeyin özellikleri. |
Kapasite
İstek sırasında cihaz yüzeyinin desteklediği özellikler.
Sıralamalar | |
---|---|
UNSPECIFIED |
Yüzey kapasitesi belirtilmedi. |
SPEECH |
Cihaz, metin okuma veya SSML aracılığıyla 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 ses medyalarını çalabilir. |
INTERACTIVE_CANVAS |
Cihaz, etkileşimli bir tuval yanıtı gösterebilir. |
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, evdeki depolama alanını kaydetmeyi ve getirmeyi destekleyebilir. |
StaticPromptResponse
Kullanıcıya gönderilecek yapılandırılmış yanıtları (ör. metin, konuşma, kartlar, tuval verileri, öneri çipleri) 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ı. Sesli ve yalnızca metin içeren son yanıt. |
suggestions[] |
İsteğe bağlı. Öneriler her zaman yanıtın sonunda görünür ve kullanıcıya gösterilir. İçeren istemdeki |
link |
İsteğe bağlı. İlişkilendirilmiş uygulamaya veya siteye bağlantı verebilen ek bir öneri çipi. Çip, "Aç |
override |
İsteğe bağlı. Bu mesajların önceden tanımlanmış iletilerle nasıl birleştirileceğini belirleyen mod. |
canvas |
Etkileşimli tuval deneyimi için kullanılacak bir yanıt. |
StaticSimplePrompt
Kullanıcıya gönderilecek 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 konuşulacak konuşmayı temsil eder. SSML veya metin okuma olabilir. Varsayılan olarak konuşma, önceki Basit istemin konuşmasına eklenir. İçeren istemdeki |
text |
İsteğe bağlı. Sohbet balonunda gösterilecek metin. Sağlanmazsa yukarıdaki konuşma alanının bir ekran oluşturma işlemi kullanılır. Uzunluk sınırı 640 karakterdir. Metin, varsayılan olarak önceki Basit istemin metnine eklenir. İçeren istemdeki |
StaticContentPrompt
StaticPrompt'un İçerik bölümü için bir yer tutucu.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
content alanı. İstemde yalnızca bir içerik türü bulunabilir. content şunlardan yalnızca biri olabilir: |
||
card |
Temel bir kart. |
|
image |
Bir resim. |
|
table |
Tablo kartı. |
|
media |
Oynatılacak medya grubunu belirten yanıt. |
|
list |
Aralarından seçim yapabileceğiniz seçeneklerin listesini sunan bir kart. |
|
collection |
Aralarından seçim yapabileceğiniz seçeneklerin listesini gösteren bir kart. |
|
collectionBrowse |
Açılacak web sayfaları koleksiyonunu gösteren bir kart. |
StaticCardPrompt
Bazı bilgileri (ör. resim ve/veya metin) gösteren temel bir kart.
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 yoksa gereken kart gövde metni. Biçimlendirme için sınırlı bir Markdown söz dizimini destekler. |
image |
İsteğe bağlı. Kartın lokomotif resmi. Yükseklik 192 dp'ye sabitlenir. |
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 gösterilen bir resim.
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 etkilemek için kullanılabilecek olası resim görüntüleme seçenekleri. Bu, resmin en boy oranı, resim 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 resim kapsayıcısı arasındaki boşlukları gri çubuklarla doldurun. |
WHITE |
Resim ile resim kapsayıcısı arasındaki boşlukları beyaz çubuklarla doldurun. |
CROPPED |
Resim, resim genişliği ve yüksekliği kapsayıcı boyutlarıyla eşleşecek veya bu boyutları aşacak şekilde ölçeklendirilir. Ölçeklendirilmiş resmin yüksekliği kapsayıcı yüksekliğinden fazlaysa resmin üst ve alt kısmı kırpılabilir. Ölçeklendirilmiş resmin genişliği kapsayıcı genişliğinden fazlaysa resmin sol ve sağ tarafı kırpılabilir. Bu, 4:3 oranındaki bir video oynatırken geniş ekran TV'deki "Yakınlaştırma Modu"na benzer. |
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ı bağlantıyı açtığında nasıl davranacağını tanımlar. |
OpenUrl
Kullanıcı bağlantıyı açtığında nasıl davranacağını tanımlar.
JSON gösterimi | |
---|---|
{
"url": string,
"hint": enum ( |
Alanlar | |
---|---|
url |
Şunlardan herhangi biri olabilecek URL alanı: - Uygulamayla Bağlantılı Uygulama veya web sayfası açmak için http/https URL'leri |
hint |
URL türüyle ilgili bir ipucu gösterir. |
UrlHint
Farklı URL ipucu 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 bir URL'ye yönlendiren URL. |
StaticTablePrompt
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österilmesi garanti edilir ancak diğerleri belirli yüzeylerde kesilebilir. Belirli bir yüzey için hangi satırların gösterileceğini görmek üzere lütfen simülatörle test yapın. |
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 |
İçeriğin sütunla yatay hizalaması. Belirtilmemişse içerik ön kenara hizalanır. |
HorizontalAlignment
Hücre içindeki içeriğin hizalaması.
Sıralamalar | |
---|---|
UNSPECIFIED |
Yatay Hizalama belirtilmedi. |
LEADING |
Hücrenin baş kenarı. Bu varsayılan seçenektir. |
CENTER |
İçerik, sütunun ortasına hizalanır. |
TRAILING |
İçerik, sütunun son kenarına 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österilmesi 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ülatörle test yapın. |
divider |
Her satırdan sonra ayırıcı olup olmadığını gösterir. |
TableCell
Bir satırdaki 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 kesir basamağı içeren ve " |
optionalMediaControls[] |
Bu medya yanıt oturumunun destekleyebileceği isteğe bağlı medya denetimi türleri. Ayarlanırsa belirli bir medya etkinliği gerçekleştiğinde 3p'ye istek gönderilir. Ayarlanmazsa 3p yine de TAMAM ve BAŞARISIZ olmak üzere iki varsayılan kontrol türünü işlemelidir. |
mediaObjects[] |
Medya nesnelerinin listesi. |
repeatMode |
Medya Nesneleri listesi için modu tekrar edin. |
MediaType
Bu yanıtın medya türü.
Sıralamalar | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
UNSPECIFIED değeri |
AUDIO |
Ses dosyası. |
MEDIA_STATUS_ACK |
Medya durum raporunu onaylama yanıtı. |
OptionalMediaControls
İsteğe bağlı olarak medya yanıtının destekleyebileceği medya denetimi türleri
Sıralamalar | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Değer belirtilmemiş |
PAUSED |
Etkinlik duraklatıldı. Kullanıcı medyayı duraklattığında tetiklenir. |
STOPPED |
Etkinlik durduruldu. Kullanıcı medya oynatma sırasında 3. taraf oturumundan çı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 işaret eden URL. |
image |
Medya kartıyla birlikte gösterilecek resim. |
MediaImage
MediaPrompt içinde gösterilecek resim.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
image alanı. Yalnızca bir MediaImage türüne izin verilir. image şunlardan yalnızca biri olabilir: |
||
large |
Albümün kapağı vb. büyük bir resim. |
|
icon |
Başlığın sağında gösterilen küçük resim simgesi. 36x36 dp olarak yeniden boyutlandırıldı. |
RepeatMode
Medya nesneleri listesi için tekrar modu türleri.
Sıralamalar | |
---|---|
REPEAT_MODE_UNSPECIFIED |
KAPALI değerine 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ü. |
StaticListPrompt
Aralarından seçim yapabileceğ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ı adıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda bu anahtar seçim parametresi olarak geri gönderilir. |
title |
Zorunlu. Öğenin başlığı. Bu metine dokunulduğunda, kullanıcı yazmış gibi, görüşmede aynen geri gönderilir. Her başlık, öğe kümesi 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çeneği sunan 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ür'deki giriş anahtarı adıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda bu anahtar seçim parametresi olarak geri gönderilir. |
title |
Zorunlu. Öğenin başlığı. Bu metine dokunulduğunda, kullanıcı yazmış gibi, görüşmede aynen geri gönderilir. Her başlık, öğe kümesi 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ı, büyük parçalardan oluşan bir koleksiyon olarak sunulur. Öğeler, ilişkili web dokümanını bir web görüntüleyicide başlatmak için 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
Öğe koleksiyonda.
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 öğesinin açıklamanın altında görüntülenen altbilgi metni. Üç nokta ile kısaltılmış tek satırlık metin. |
image |
Koleksiyon öğesinin resmi. |
openUriAction |
Zorunlu. Öğe seçilmişse açılacak URI. |
Öneri
Bir öneri çipini temsil eder. Kolaylık sağlamak için kullanıcıya gösterilen bir kullanıcı arayüzü öğesidir.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Zorunlu. Öneri çipinde gösterilen metin. Bu metine dokunulduğunda, kullanıcı yazmış gibi, görüşmede aynen geri gönderilir. Öneri çipi grubundaki her başlık benzersiz olmalıdır. Maks. 25 karakter |
StaticCanvasPrompt
Kullanıcıya gönderilecek Etkileşimli Tuval yanıtını temsil eder. Bu, kullanıcıyla konuşmak için yer alan istemdeki firstSimple
alanıyla birlikte kullanılabilir ve etkileşimli bir tuval yanıtı görüntüleyebilir.
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ı. Kapsamlı deneyim web sayfasına etkinlik olarak aktarılacak JSON verileri. İçeren istemdeki |
suppressMic |
İsteğe bağlı. Doğru değeri, bu kapsamlı yanıt kullanıcıya sunulduktan sonra mikrofonun giriş yakalamak için açılmayacağı anlamına gelir. |
sendStateDataToCanvasApp |
İsteğe bağlı. |
enableFullScreen |
İsteğe bağlı. |
Düzen
Sahne, bir konuşma tasarlarken kullanabileceğiniz temel kontrol akışının birimidir. Bunlar diğer sahnelerle birbirine bağlanabilir, 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ş sırasında ç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 sahne kapsamındaki amaçlar grubunu tanımlar ve aynı amaçlara veya tetikleyici ifadelerine sahip, dünya genelinde tanımlanmış tüm etkinliklere göre önceliklidir. Amaç adları bir sahne içinde benzersiz olmalıdır. |
conditionalEvents[] |
Koşullu ifadelere göre tetiklenecek etkinliklerin listesi. Bunlar, form doldurulduktan sonra veya bu sahnenin formu yoksa on_load sonrasında değerlendirilir (değerlendirme yalnızca bir kez yapılır). Yalnızca eşleşen ilk etkinlik tetiklenir. |
slots[] |
Sıralı slot listesi. Her alan, çözeceği veri türünü ve bu çözünürlük deneyimini özelleştirmek için yapılandırmayı tanımlar (ör. istemler). |
onSlotUpdated |
Başka bir İşleyici içindeki güncellemelerden kaynaklanmayan bir slot durumunda değişiklik olduğunda işleyici çağrılır. Bu, aralıkların geçersiz kılınmasına, sahnenin geçersiz kılınmasına veya sahne durumunda diğer değişikliklerin yapılmasına izin verir. |
IntentEvent
Amaç eşleşmesi sonucu tetiklenen Etkinlikleri kaydeder.
JSON gösterimi | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Alanlar | |
---|---|
intent |
Zorunlu. Etkinliği tetikleyen amaç. |
transitionToScene |
İsteğe bağlı. Konuşmanın atlanacağı hedef sahne. Geçişte mevcut sahnenin durumu silinir. |
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şulun sonucu olarak tetiklenen etkinlikleri kaydeder.
JSON gösterimi | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Alanlar | |
---|---|
condition |
Zorunlu. Bu etkinliğin tetiklenmesi için filtre koşulu. Koşul doğru olarak değerlendirilirse ilişkilendirilen |
transitionToScene |
İsteğe bağlı. İlişkilendirilen koşul doğru olarak değerlendirildiğinde konuşmanın atlaması gereken hedef sahne. Geçişte mevcut sahnenin durumu silinir. |
handler |
İsteğe bağlı. İlişkili koşul |
Alan
Bir slot için yapılandırma. Slot'lar; doğal dil (ör. amaç parametreleri), oturum parametreleri ve diğer kaynaklar üzerinden doldurulabilen tek veri birimleridir.
JSON gösterimi | |
---|---|
{ "name": string, "type": { object ( |
Alanlar | |
---|---|
name |
Zorunlu. Alanın adı. |
type |
Zorunlu. Bu slotun veri türünü tanımlar. |
required |
İsteğe bağlı. İlerlemeden önce alanın doldurulmasının gerekip gerekmediğini 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 ilgili davranışı gerçekleştirin. |
config |
İsteğe bağlı. Alanı doldurmak için kullanılan alanla ilişkilendirilmiş ek yapılandırma. Yapılandırmanın biçimi, slot türüne özeldir. Bu yapılandırmaya kullanıcı veya oturum parametresi için kaynak referansları eklenebilir. Bu yapılandırma, işlemler ve kullanıcı etkileşimi ile ilgili yuvaları doldurmak için gereklidir. Örnek: actions.type.CompletePurchaseValue türündeki bir slot için aşağıdaki yapılandırmada, istemci tarafından tanımlanan { "@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 bir değer doldurulacak yapılandırma. |
PromptSettings
Slot istemlerinin tanımlandığı tek bir yer.
JSON gösterimi | |
---|---|
{ "initialPrompt": { object ( |
Alanlar | |
---|---|
initialPrompt |
Slot değerinin kendisini iste. Örnek: "Hangi boy istemiştiniz?" |
noMatchPrompt1 |
Kullanıcının girişi, slot için beklenen değer türüyle ilk kez eşleşmediğinde verilmesini sor. Örnek: "Maalesef anlayamadım." |
noMatchPrompt2 |
Kullanıcının girişi ikinci kez slot için beklenen değer türüyle eşleşmediğinde verilmesini iste. Örnek: "Maalesef anlayamadım." |
noMatchFinalPrompt |
Kullanıcının girişi son kez slot için beklenen değer türüyle eşleşmediğinde verilmesini iste. Örnek: "Maalesef anlayamadım." |
noInputPrompt1 |
Kullanıcı ilk kez giriş yapmadığında bilgi istemi. Örnek: "Maalesef anlayamadım." |
noInputPrompt2 |
Kullanıcı ikinci kez giriş yapmadığında bilgi istemi. Örnek: "Maalesef anlayamadım." |
noInputFinalPrompt |
Kullanıcı en son kez giriş sağlamadığında bilgi istemi. Örnek: "Maalesef anlayamadım." |
CommitBehavior
Alanla ilişkili kaydetme davranışının, alan başarıyla doldurulduktan sonra açıklandığı mesaj.
JSON gösterimi | |
---|---|
{ "writeSessionParam": string } |
Alanlar | |
---|---|
writeSessionParam |
Doldurulduktan sonra alan değerini yazacak 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. Ör: writeSessionParam = "fruit", "$session.params.fruit"e karşılık gelir. writeSessionParam = "ticket", "$session.params.ticket"e karşılık gelir. |
DefaultValue
Bu alan için varsayılan bir değer doldurulacak yapılandırma.
JSON gösterimi | |
---|---|
{ "sessionParam": string, "constant": value } |
Alanlar | |
---|---|
sessionParam |
İsteğe bağlı. Boş olmayan bir değeri varsa slot değerini başlatmak için kullanılacak oturum parametresi. 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 alan yalnızca bu alan için bir değer |
DataFiles
Tekrarlanan veri dosyası için sarmalayıcı. Yinelenen alanlar bunlardan birinde bulunamaz.
JSON gösterimi | |
---|---|
{
"dataFiles": [
{
object ( |
Alanlar | |
---|---|
dataFiles[] |
Birden fazla veri dosyası. |
DataFile
Yapılandırılmamış veriler içeren tek bir dosyayı temsil eder. Örnek olarak resim dosyaları, ses dosyaları ve Cloud Functions işlevi kaynak kodu 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. Resim ham baytları, ses dosyaları veya Cloud Functions işlevi zip biçimi örnek olarak verilebilir. Yük boyutu için 10 MB katı bir sınır vardır. Base64 olarak kodlanmış bir dize. |