- JSON gösterimi
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Öğe
- SimpleResponse
- BasicCard
- Düğme
- StructuredResponse
- OrderUpdate
- İşlem
- Makbuz
- RejectionInfo
- CancellationInfo
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Öğe
- TableCard
- ColumnProperties
- Satır
- Hücre
- HtmlResponse
- Öneri
- LinkOutSuggestion
- ExpectedIntent
- FinalResponse
- CustomPushMessage
- UserNotification
- Hedef
AppResponse, istek karşılama isteğinin Google Asistan'a gönderdiği yanıttır. Bunun Actions on Google'da nasıl kullanıldığına dair örnekler için https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#conversation-response-body adresine göz atın.
JSON gösterimi | |
---|---|
{ "conversationToken": string, "userStorage": string, "resetUserStorage": boolean, "expectUserResponse": boolean, "expectedInputs": [ { object ( |
Alanlar | |
---|---|
conversationToken |
Her görüşme dönüşünde İşleme yeniden iletilen opak bir jeton. |
userStorage |
İşlem tarafından kontrol edilen ve belirli bir kullanıcı için görüşmelerde kalıcı olan opak jeton. Boş veya belirtilmemişse mevcut kalıcı jeton değişmez. Dizenin maksimum boyutu 10.000 bayttır. Aynı kullanıcı için eşzamanlı olarak birden fazla iletişim kutusu açılıyorsa bu jetonda yapılan güncellemeler beklenmedik bir şekilde birbirinin üzerine yazabilir. |
resetUserStorage |
Kalıcı userStorage'ın temizlenip temizlenmeyeceğini belirler. True (doğru) değerine ayarlanırsa kullanıcıyla bir sonraki etkileşimde, userStorage alanı boş olur. |
expectUserResponse |
İşlemin bir kullanıcı yanıtı bekleyip beklemediğini belirtir. Bu, görüşme devam ederken doğru, görüşme bittiğinde ise yanlıştır. |
expectedInputs[] |
İşlemin beklediği girişlerin listesi. Her giriş, Google amacı ile ilgili yaygın işlemler ("actions." ile başlayan) veya olası amaçların listesini alan bir giriş olabilir. Şu anda yalnızca bir giriş desteklenmektedir. |
finalResponse |
İşlem, kullanıcı girişi beklemediğinde nihai yanıt. |
customPushMessage |
Geliştiricilerin Google'daki işlemlere yapılandırılmış veriler göndermesine olanak tanıyan özel bir push mesajıdır. |
isInSandbox |
Yanıtın korumalı alan modunda işlenip işlenmeyeceğini belirtir. Bu bit, yapılandırılmış verileri korumalı alan modunda Google'a aktarmak için gereklidir. |
ExpectedInput
JSON gösterimi | |
---|---|
{ "inputPrompt": { object ( |
Alanlar | |
---|---|
inputPrompt |
Kullanıcıdan giriş istemek için kullanılan özelleştirilmiş istem. |
possibleIntents[] |
Bu girişi yerine getirmek için kullanılabilecek amaçların listesi. Google'da işlemlerin yalnızca ham kullanıcı girişini döndürmesi için uygulamanın |
speechBiasingHints[] |
İşlemin Google'dan konuşmaya ağırlık verme için kullanmasını istediği ifadelerin listesi. En fazla 1.000 kelime öbeğine izin verilir. |
InputPrompt
Asistan'ın, uygulamanın sorusu için giriş sağlaması amacıyla kullanıcıya rehberlik etmesi için kullanılan giriş istemi.
JSON gösterimi | |
---|---|
{ "initialPrompts": [ { object ( |
Alanlar | |
---|---|
initialPrompts[] |
Kullanıcıdan giriş yapmasını isteyen ilk istemler. Yalnızca tek bir initial_prompt değeri desteklenir. |
richInitialPrompt |
İstem yükü. |
noInputPrompts[] |
Kullanıcıdan giriş gelmediğinde kullanıcıya soru sormak için kullanılan istem. |
SpeechResponse
Yalnızca konuşma içeren yanıt. KULLANIMDAN KALDIRILDI.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
type alanı. Konuşma çıkışı türleri: metin okuma veya SSML. type şunlardan yalnızca biri olabilir: |
||
textToSpeech |
Konuşma çıktısının düz metni, ör. "Nereye gitmek istersiniz?"/ |
|
ssml |
Kullanıcıya SSML biçiminde yapılandırılmış sesli yanıt, ör. " |
RichResponse
Ses, metin, kartlar, öneriler ve yapılandırılmış veriler içerebilen zengin bir yanıt.
JSON gösterimi | |
---|---|
{ "items": [ { object ( |
Alanlar | |
---|---|
items[] |
Yanıtı oluşturan kullanıcı arayüzü öğelerinin listesi. Öğeler aşağıdaki şartları karşılamalıdır: 1. İlk öğe |
suggestions[] |
Önerilen yanıtların listesi. Bunlar her zaman yanıtın sonunda görünür. |
linkOutSuggestion |
İlişkilendirilmiş uygulamaya veya siteye bağlantı verebilen ek bir öneri çipi. |
Öğe
Yanıttaki öğeler.
JSON gösterimi | |
---|---|
{ "name": string, // Union field |
Alanlar | ||
---|---|---|
name |
Bu öğenin isteğe bağlı adlandırılmış tanımlayıcısı. |
|
item alanı. Öğenin türü. item şunlardan yalnızca biri olabilir: |
||
simpleResponse |
Sesli ve yalnızca kısa mesaj yanıt. |
|
basicCard |
Temel bir kart. |
|
structuredResponse |
Google tarafından işlenecek yapılandırılmış yük. |
|
mediaResponse |
Oynatılacak medya grubunu belirten yanıt. |
|
carouselBrowse |
Bant göz atma kartı, bunun yerine koleksiyona göz at'ı kullanın. |
|
tableCard |
Tablo kartı. |
|
htmlResponse |
Canvas'ta oluşturmak için kullanılan HTML yanıtı. |
SimpleResponse
Kullanıcıya gösterilecek konuşma veya metin içeren basit bir yanıt.
JSON gösterimi | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
Alanlar | |
---|---|
textToSpeech |
Konuşma çıktısının düz metni, ör. "nereye gitmek istiyorsunuz?" Ssml ile birlikte kullanılamaz. |
ssml |
Kullanıcıya SSML biçiminde yapılandırılmış sesli yanıt, ör. |
displayText |
Sohbet balonunda gösterilecek isteğe bağlı metin. Sağlanmazsa yukarıdaki textToSpeech veya ssml'nin görüntülü olarak oluşturulması kullanılır. Uzunluk sınırı 640 karakterdir. |
BasicCard
Bazı bilgileri (ör. resim ve/veya metin) gösteren temel bir kart.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "formattedText": string, "image": { object ( |
Alanlar | |
---|---|
title |
Kartın genel başlığı. İsteğe bağlı. |
subtitle |
İsteğe bağlı. |
formattedText |
Kartın gövde metni. Biçimlendirme için sınırlı bir Markdown söz dizimini destekler. Resim yoksa gereklidir. |
image |
Kartın lokomotif resmi. Yükseklik 192 dp'ye sabitlenir. İsteğe bağlı. |
buttons[] |
Düğmeler. Şu anda en fazla 1 düğme desteklenmektedir. İsteğe bağlı. |
imageDisplayOptions |
Resim görüntüleme seçeneği türü. İsteğe bağlı. |
Düğme
Genellikle kartın alt kısmında görünen bir düğme nesnesi.
JSON gösterimi | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
Alanlar | |
---|---|
title |
düğmenin başlığı. Zorunlu. |
openUrlAction |
Kullanıcı düğmeye dokunduğunda yapılacak işlem. Zorunlu. |
StructuredResponse
Uygulamanın yapılandırılmış verilerle yanıt vermesi için tanımlanan yanıt.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
data alanı. Üçüncü taraf aracılarından gelen yük yanıtı kapsayıcısıdır. data şunlardan yalnızca biri olabilir: |
||
orderUpdate |
Uygulama, siparişi aldıktan sonra sipariş güncellemesi (ör. |
|
orderUpdateV3 |
Uygulama, siparişi aldıktan sonra API v3 biçiminde bir sipariş güncellemesi sağlıyor. |
OrderUpdate
Kullanımdan kaldırıldı: Bunun yerine V3 Proto'yu kullanın. Bir siparişe güncelleyin.
JSON gösterimi | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
Alanlar | ||
---|---|---|
googleOrderId |
Siparişin kimliği, Google tarafından verilen kimliktir. |
|
actionOrderId |
Zorunlu. Bu siparişi referans alan standart sipariş kimliğidir. Entegratörler, sistemlerinde standart sipariş kimliği oluşturmazsa siparişe eklenen googleOrderId öğesini kopyalayabilir. |
|
orderState |
Siparişin yeni durumu. |
|
orderManagementActions[] |
Sipariş için uygulanabilir yönetim işlemleri (ör. yönetme, değiştirme, destek ekibiyle iletişime geçme) güncellendi. |
|
receipt |
Sipariş makbuzu. |
|
updateTime |
Siparişin uygulama açısından güncellendiği zaman. RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: |
|
totalPrice |
Siparişin yeni toplam fiyatı |
|
lineItemUpdates |
Öğe kimliğine göre ayarlanmış satır öğesi düzeyindeki değişikliklerin haritası. İsteğe bağlı.
|
|
userNotification |
Belirtilmişse kullanıcıya belirtilen başlık ve metni içeren bir bildirim görüntüler. Bildirim belirlemek, bilgilendirme amaçlı bir öneridir ve bildirimle sonuçlanacağı garanti edilmez. |
|
infoExtension |
Özel sipariş durumuna dayalı veya standart durum bilgilerine ek olarak ekstra veriler. Rastgele türde alanlar içeren bir nesne. |
|
info alanı. Siparişin durumuyla ilişkili ek bilgiler. info şunlardan yalnızca biri olabilir: |
||
rejectionInfo |
Reddedilme durumu hakkında bilgi. |
|
cancellationInfo |
İptal durumu hakkında bilgi. |
|
inTransitInfo |
Nakliye durumu hakkında bilgi. |
|
fulfillmentInfo |
Sipariş karşılama durumu hakkında bilgi. |
|
returnInfo |
İade durumu hakkında bilgi. |
İşlem
Sipariş güncellemesiyle ilişkili bir takip işlemi.
JSON gösterimi | |
---|---|
{ "type": enum ( |
Alanlar | |
---|---|
type |
işlem türü. |
button |
Düğme etiketi ve bağlantısı. |
Fatura
Kullanımdan kaldırıldı: Bunun yerine V3 Proto'yu kullanın. "ONAYLANDI" durumuna veya ONAYLANDI durumu dahil başka bir duruma (ör. IN_TRANSIT, FULFILLED) girildiğinde gönderilen makbuz.
JSON gösterimi | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Alanlar | |
---|---|
confirmedActionOrderId |
Sipariş entegratör tarafından alındığında onaylanan sipariş kimliği. Bu, entegratörün sisteminde siparişe atıfta bulunan standart sipariş kimliğidir ve daha sonra siparişi Bu alanın kullanımdan kaldırıldığını unutmayın. Lütfen alanı OrderUpdate.action_order_id üzerinden iletin. |
userVisibleOrderId |
İsteğe bağlı. Mevcut siparişe referansta bulunan kullanıcıya gösterilen kimlik; varsa makbuz kartında gösterilir. Bu, genellikle kullanıcının e-posta adresine gönderilen basılı bir makbuzda veya makbuzda görünen kimlik olmalıdır. Kullanıcı, entegratörler tarafından sunulan müşteri hizmetleri için siparişine referansta bulunan bu kimliği kullanabilmelidir. Entegratör yazdırılmış makbuz / e-posta makbuzu içeren bir sipariş için kullanıcıya görünen kimlik oluşturursa bu alanın doldurulması gerektiğini unutmayın. |
RejectionInfo
Eyalet REDDEDİLDİ olduğunda gönderilen ret bilgisi. Bu mesaj, ileti dizisindeki ilk sipariş güncellemesinde veya daha sonraki eşzamansız sipariş güncellemesinde doldurulabilir.
JSON gösterimi | |
---|---|
{
"type": enum ( |
Alanlar | |
---|---|
type |
Reddedilme türü. |
reason |
Hatanın nedeni. |
CancellationInfo
Kullanımdan kaldırıldı: Bunun yerine V3 Proto'yu kullanın. Durum İPTAL EDİLDİ olduğunda gönderilen iptal bilgisi.
JSON gösterimi | |
---|---|
{ "reason": string } |
Alanlar | |
---|---|
reason |
İptal nedeni. |
InTransitInfo
Kullanımdan kaldırıldı: Bunun yerine V3 Proto'yu kullanın. Eyalet IN_TRANSIT olduğunda ulaşım sırasında verilen bilgi.
JSON gösterimi | |
---|---|
{ "updatedTime": string } |
Alanlar | |
---|---|
updatedTime |
Toplu taşıma için son güncelleme zamanı. RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: |
FulfillmentInfo
Kullanımdan kaldırıldı: Bunun yerine V3 Proto'yu kullanın. Durum FULFILLED olduğunda sipariş karşılama bilgisi.
JSON gösterimi | |
---|---|
{ "deliveryTime": string } |
Alanlar | |
---|---|
deliveryTime |
Siparişin ne zaman teslim edileceği. RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: |
ReturnInfo
Kullanımdan kaldırıldı: Bunun yerine V3 Proto'yu kullanın. Eyalet REDDEDİLDİĞİNDE verilecek bilgi.
JSON gösterimi | |
---|---|
{ "reason": string } |
Alanlar | |
---|---|
reason |
İade nedeni. |
UserNotification
Sipariş güncellemesinin bir parçası olarak gösterilecek isteğe bağlı kullanıcı bildirimi.
JSON gösterimi | |
---|---|
{ "title": string, "text": string } |
Alanlar | |
---|---|
title |
Kullanıcı bildiriminin başlığı. |
text |
Bildirimin içeriği. |
MediaResponse
Görüşme içinde oynatılacak medya grubunu belirten yanıt.
JSON gösterimi | |
---|---|
{ "mediaType": enum ( |
Alanlar | |
---|---|
mediaType |
medya türünü belirtmelisiniz. |
mediaObjects[] |
Medya nesnelerinin listesi. |
MediaObject
MediaResponse ile döndürülen bir medya nesnesini temsil eder. Medya hakkında ad, açıklama, URL vb. bilgiler içerir.
JSON gösterimi | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Alanlar | ||
---|---|---|
name |
bu medya nesnesinin adını kullanın. |
|
description |
bu medya nesnesinin açıklaması. |
|
contentUrl |
Medya içeriğini işaret eden URL. |
|
image alanı. Medya kartıyla birlikte gösterilecek resim. image şunlardan yalnızca biri olabilir: |
||
largeImage |
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ı. |
CarouselBrowse
AMP dokümanları grubunu, büyük parçalı öğelerden oluşan bir bant olarak sunar. Öğeler, ilişkili AMP dokümanını bir AMP görüntüleyicide başlatmak için seçilebilir.
JSON gösterimi | |
---|---|
{ "items": [ { object ( |
Alanlar | |
---|---|
items[] |
Min: 2. Maks: 10. |
imageDisplayOptions |
Resim görüntüleme seçeneği türü. İsteğe bağlı. |
Öğe
Banttaki öğe.
JSON gösterimi | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Alanlar | |
---|---|
title |
atlı karınca öğesinin başlığı. Zorunlu. |
description |
açıklaması. İsteğe bağlı. |
footer |
Açıklamanın altında görüntülenen bant öğesi için altbilgi metni. Üç nokta ile kısaltılmış tek satırlık metin. İsteğe bağlı. |
image |
Dönen öğe için lokomotif resim. İsteğe bağlı. |
openUrlAction |
Bant öğesiyle ilişkili dokümanın URL'si. Doküman HTML içeriği barındırabilir veya "urlTypeHint", AMP_CONTENT olarak ayarlanmışsa AMP içeriği içerebilir. Zorunlu. |
TableCard
Metin tablosunu gösteren tablo kartı.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Alanlar | |
---|---|
title |
Tablonun genel başlığı. İsteğe bağlıdır ancak altyazı ayarlanmışsa ayarlanmalıdır. |
subtitle |
Tablonun alt başlığı. İsteğe bağlı. |
image |
Tabloyla ilişkilendirilen resim. İsteğe bağlı. |
columnProperties[] |
Başlıklar ve sütunların hizalaması. |
rows[] |
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. WEB_BROWSER işlevini destekleyen yüzeylerde kullanıcıyı daha fazla veri içeren bir web sayfasına yönlendirebilirsiniz. |
buttons[] |
Düğmeler. Şu anda en fazla 1 düğme desteklenmektedir. İsteğe bağlı. |
ColumnProperties
Sütunların özelliklerini korur (başlıklar dahil).
JSON gösterimi | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Alanlar | |
---|---|
header |
Sütunun başlık metni. |
horizontalAlignment |
İçeriğin sütunla yatay hizalaması. Belirtilmemişse içerik ön kenara hizalanır. |
Satır
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. |
dividerAfter |
Her satırdan sonra ayırıcı olup olmadığını gösterir. |
Cell
Bir satırdaki hücreyi açıklar.
JSON gösterimi | |
---|---|
{ "text": string } |
Alanlar | |
---|---|
text |
Hücrenin metin içeriği. |
HtmlResponse
Etkileşimli tuval özelliğini kullanarak HTML gösteren yanıt. Yanıtın maksimum boyutu 50.000 bayttır.
JSON gösterimi | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
Alanlar | |
---|---|
updatedState |
Aşağıdaki JSON nesnesini uygulamaya iletin. |
suppressMic |
Bu kapsamlı yanıttan sonra mikrofonun açılmaması için bir seçenek sağlayın. |
url |
Uygulamanın URL'si. |
Öneri
Kullanıcının görüşmede hızlıca yanıt yayınlamak için dokunabileceği bir öneri çipi.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Ö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. Maksimum 25 karakter gerekir |
LinkOutSuggestion
Kullanıcının bu aracıyla ilişkili uygulamaya veya web sitesine geçmesine olanak tanıyan bir öneri çipi oluşturur.
JSON gösterimi | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Alanlar | |
---|---|
destinationName |
Bu çipin bağlantı verdiği uygulamanın veya sitenin adı. Çip, "Aç |
url |
Kullanımdan kaldırıldı. Bunun yerine OpenUrlAction kullanın. |
openUrlAction |
Kullanıcı, öneri çipine dokunduğunda açılacak Uygulama veya Sitenin URL'si. Bu Uygulamanın/URL'nin sahipliği, Google Developers Console'daki işlemlerde doğrulanmalıdır. Aksi takdirde öneri kullanıcıya gösterilmez. Açık URL İşlemi http, https ve amaç URL'lerini destekler. Amaç URL'leri için şu adrese bakın: https://developer.chrome.com/multidevice/android/intents |
ExpectedIntent
Uygulamanın, asistandan sağlamasını istediği beklenen amaç.
JSON gösterimi | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
Alanlar | |
---|---|
intent |
Yerleşik amaç adı (ör. |
inputValueData |
Yerleşik intent için gereken ek yapılandırma verileri. Yerleşik amaçlar için olası değerler: Rastgele türde alanlar içeren bir nesne. |
parameterName |
İsteğe bağlı olarak, istenen amacın bir parametresi. Yalnızca istenen amaçlar için geçerlidir. Konuşmaya ağırlık vermek için kullanılır. |
FinalResponse
Kullanıcı girişi beklenmeyen durumlarda verilen son yanıt.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
response alanı. Olası yanıt türleri. response şunlardan yalnızca biri olabilir: |
||
speechResponse |
Kullanıcının giriş sağlaması gerekmediğinde sesli yanıt. |
|
richResponse |
Kullanıcının giriş sağlaması gerekmediğinde zengin yanıt. |
CustomPushMessage
İşlemler Fulfillment API için aktarmak üzere yapılandırılmış verileri barındıran özel bir push mesajı.
JSON gösterimi | |
---|---|
{ "target": { object ( |
Alanlar | ||
---|---|---|
target |
Push isteği için belirtilen hedef. |
|
content alanı. Farklı yük türleri. content şunlardan yalnızca biri olabilir: |
||
orderUpdate |
İşlem API'leri üzerinden verilen siparişlerin güncellenmesi. |
|
userNotification |
Belirtilmişse kullanıcıya belirtilen başlık ve metinle birlikte bir bildirim görüntüler. |
UserNotification
Bir istekle birlikte gösterilecek kullanıcı bildirimi.
JSON gösterimi | |
---|---|
{ "title": string, "text": string } |
Alanlar | |
---|---|
title |
Bildirimin başlığı. |
text |
Bildirimin içeriği. |
Hedef
Push isteği için belirtilen hedef.
JSON gösterimi | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Alanlar | |
---|---|
userId |
Hedeflenecek kullanıcı. |
intent |
Hedefleme amacı. |
argument |
Bir amaç için hedeflenecek bağımsız değişken. V1 için yalnızca bir bağımsız değişken desteklenir. |
locale |
Hedeflenecek yerel ayar. IETF BCP-47 dil kodunu izler. Çok dilli uygulamalar tarafından, belirtilen yerelleştirilmiş uygulamadaki bir kullanıcıyı hedeflemek için kullanılabilir. Belirtilmezse varsayılan olarak en-US olur. |