- 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, sipariş karşılama tarafından Google Asistan'a gönderilen 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üşmede İşleme geri aktarılan opak bir jeton. |
userStorage |
İşlem tarafından kontrol edilen ve belirli bir kullanıcının görüşmelerinde kalıcı olan opak bir jeton. Boşsa veya belirtilmemişse mevcut kalıcı jetonda değişiklik olmaz. Dizenin maksimum boyutu 10.000 bayttır. Aynı kullanıcı için eşzamanlı olarak birden fazla iletişim kutusu oluşuyorsa bu jetonda yapılan güncellemeler, beklenmedik bir şekilde birbirinin üzerine yazabilir. |
resetUserStorage |
Kalıcı userStorage'ın temizlenip temizlenmeyeceğini belirler. 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 yanlıştır. |
expectedInputs[] |
İşlemin beklediği girişlerin listesi. Her giriş, Google amacına yönelik genel bir işlem ("işlemler" ile başlayın) veya olası amaçların bir listesi olabilir. Şimdilik yalnızca bir giriş desteklenmektedir. |
finalResponse |
İşlem, kullanıcı girişini beklemediğinde nihai yanıt. |
customPushMessage |
Geliştiricilerin, Google'daki işlemlere yapılandırılmış veri 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 gerçekleştirmek için kullanılabilecek intent'lerin listesi. Google'daki işlemlerin yalnızca ham kullanıcı girişini döndürmesini sağlamak için uygulamanın |
speechBiasingHints[] |
İşlemin Google'ın konuşmaya ağırlık vermek için kullanmasını istediği ifadelerin listesi. En fazla 1.000 ifadeye izin verilir. |
InputPrompt
Asistan'ın, uygulamanın sorusuyla ilgili giriş sağlaması için kullanıcıyı yönlendirmesi 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 desteklenir. |
richInitialPrompt |
İstem yükü. |
noInputPrompts[] |
Kullanıcı herhangi bir giriş olmadığında kullanıcıya sormak için kullanılan istem. |
SpeechResponse
Yalnızca konuşma içeren yanıt. KULLANIMDAN KALDIRILDI.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
Birleştirme alanı type . 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 istiyorsun?"/ |
|
ssml |
Kullanıcıya SSML biçiminde yapılandırılmış sözlü yanıt, ör. " |
RichResponse
Ses, metin, kart, öneri ve yapılandırılmış verileri 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şkili uygulama veya siteye bağlantı verebilecek ek bir öneri çipi. |
Öğe
Yanıt öğeleri.
JSON gösterimi | |
---|---|
{ "name": string, // Union field |
Alanlar | ||
---|---|---|
name |
Bu Öğenin isteğe bağlı adlandırılmış tanımlayıcısı. |
|
Birleştirme alanı item . Öğenin türü. item şunlardan yalnızca biri olabilir: |
||
simpleResponse |
Sesli ve yalnızca metin yanıtı. |
|
basicCard |
Temel kart. |
|
structuredResponse |
Google tarafından işlenecek yapılandırılmış yük. |
|
mediaResponse |
Oynatılacak bir grup medyayı gösteren yanıt. |
|
carouselBrowse |
Atlı karınca göz atma kartı, bunun yerine collectionsBrowse'u kullanın. |
|
tableCard |
Tablo kartı. |
|
htmlResponse |
Tuval'de oluşturmak için kullanılan html yanıtı. |
SimpleResponse
Kullanıcıya göstermek için 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 istiyorsun?" Ssml ile birlikte kullanılamaz. |
ssml |
Kullanıcıya SSML biçiminde yapılandırılmış sözlü yanıt, ör. |
displayText |
Sohbet balonunda görüntülenecek isteğe bağlı metin. Belirtilmezse yukarıdaki textToSpeech veya ssml'nin görüntülemesi kullanılır. Uzunluk sınırı 640 karakterdir. |
BasicCard
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, "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 dizimi grubunu destekler. Resim mevcut olmadığı sürece gereklidir. |
image |
Kart için hero resim. Yükseklik 192 dp olarak sabitlendi. İ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ğinin 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 |
başlık ekleyin. 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 | ||
---|---|---|
Birleştirme alanı data . Üçüncü taraf aracılarından gelen yük yanıtının kapsayıcısıdır. data şunlardan yalnızca biri olabilir: |
||
orderUpdate |
Uygulama, siparişi aldıktan sonra siparişle ilgili bir güncelleme (ör. |
|
orderUpdateV3 |
Uygulama, siparişi aldıktan sonra API v3 biçiminde sipariş güncellemesi sağlar. |
OrderUpdate
Desteği sonlandırıldı: Bunun yerine V3 Proto'yu kullanın. Bir siparişle 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şe referans veren standart sipariş kimliği. Entegratörler sistemlerinde standart sipariş kimliğini oluşturmazsa siparişteki google OrderId değerini kopyalayabilir. |
|
orderState |
Siparişin yeni durumu. |
|
orderManagementActions[] |
Sipariş için geçerli yönetim işlemleri güncellendi, ör. yönetme, değiştirme ve destek ekibiyle iletişime geçme. |
|
receipt |
Siparişin makbuzu. |
|
updateTime |
Siparişin, uygulamanın bakış açısından ne zaman güncellendiği 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 ayrılmış satır öğesi düzeyindeki değişikliklerin haritası. İsteğe bağlı.
|
|
userNotification |
Belirtilirse kullanıcıya, belirtilen başlık ve metinle bir bildirim görüntüler. Bir bildirimin belirtilmesi, bildirimde bulunulması önerilir ve bildirimle sonuçlanacağı garanti edilmez. |
|
infoExtension |
Özel bir sipariş durumuna dayalı veya standart durum bilgisine ek olarak ekstra veriler. Rastgele türden alanlar içeren nesne. Ek bir |
|
Birleştirme alanı info . Siparişin durumuyla ilişkili ek bilgiler. info şunlardan yalnızca biri olabilir: |
||
rejectionInfo |
Reddedilme durumuyla ilgili bilgi. |
|
cancellationInfo |
İptal durumuyla ilgili bilgi. |
|
inTransitInfo |
Aktarım durumu hakkında bilgi. |
|
fulfillmentInfo |
Sipariş karşılama durumuyla ilgili bilgi. |
|
returnInfo |
Döndürülen durumla ilgili bilgi. |
İşlem
Sipariş güncellemesiyle ilişkili takip işlemi.
JSON gösterimi | |
---|---|
{ "type": enum ( |
Alanlar | |
---|---|
type |
İşlem türü. |
button |
Düğme etiketi ve bağlantı. |
Fatura
Desteği sonlandırıldı: Bunun yerine V3 Proto'yu kullanın. Eyalet CONFIRMED olduğunda veya CONFIRMED durumu dahil başka bir eyalette (ör. IN_TRANSIT, FULFILLED) belirtilen makbuz.
JSON gösterimi | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Alanlar | |
---|---|
confirmedActionOrderId |
Sipariş entegrasyon uzmanına ulaştığında onaylanan sipariş kimliği. Bu, entegratörün sisteminde siparişe referans veren standart sipariş kimliğidir ve daha sonra siparişi Bu alanın kullanımdan kaldırıldığını unutmayın. Bunun yerine lütfen alanı OrderUpdate.action_order_id üzerinden iletin. |
userVisibleOrderId |
İsteğe bağlı. Mevcut siparişe referans veren, kullanıcının gördüğü kimlik. Bu 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ı, entegrasyon uzmanları tarafından sağlanan müşteri hizmetleri için siparişini referans alan bu kimliği kullanabilmelidir. Entegratör, yazdırılmış makbuz / e-posta makbuzu içeren bir sipariş için kullanıcıya yönelik kimlik oluşturuyorsa bu alanın doldurulması gerekir. |
RejectionInfo
Durum REJECTED olduğunda ret bilgisi. Bu mesaj, ileti dizisindeki ilk sipariş güncellemesinde veya sonraki eşzamansız sipariş güncellemesinde doldurulabilir.
JSON gösterimi | |
---|---|
{
"type": enum ( |
Alanlar | |
---|---|
type |
Ret türü. |
reason |
Hatanın nedeni. |
CancellationInfo
Desteği sonlandırıldı: Bunun yerine V3 Proto'yu kullanın. Eyalet İPTAL olduğunda sağlanan iptal bilgileri.
JSON gösterimi | |
---|---|
{ "reason": string } |
Alanlar | |
---|---|
reason |
İptal nedeni. |
InTransitInfo
Desteği sonlandırıldı: Bunun yerine V3 Proto'yu kullanın. Eyalet IN_TRANSIT olduğunda toplu taşıma bilgileri.
JSON gösterimi | |
---|---|
{ "updatedTime": string } |
Alanlar | |
---|---|
updatedTime |
Toplu taşımada için son güncelleme zamanı. RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: |
FulfillmentInfo
Desteği sonlandırıldı: Bunun yerine V3 Proto'yu kullanın. Durum FULFILLED olduğunda gösterilecek sipariş karşılama bilgileri.
JSON gösterimi | |
---|---|
{ "deliveryTime": string } |
Alanlar | |
---|---|
deliveryTime |
Siparişin ne zaman tamamlanacağı. RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: |
ReturnInfo
Desteği sonlandırıldı: Bunun yerine V3 Proto'yu kullanın. Eyalet REJECTED olduğunda döndürülen 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
Sohbette oynatılacak bir grup medyayı belirten yanıt.
JSON gösterimi | |
---|---|
{ "mediaType": enum ( |
Alanlar | |
---|---|
mediaType |
Bu yanıttaki medya türü. |
mediaObjects[] |
Medya nesnelerinin listesi. |
MediaObject
MediaResponse ile döndürülen bir medya nesnesini temsil eder. Medya hakkında ad, açıklama, URL gibi bilgileri içerir.
JSON gösterimi | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Alanlar | ||
---|---|---|
name |
adını tıklayın. |
|
description |
açıklaması. |
|
contentUrl |
Medya içeriğini gösteren URL. |
|
Birleştirme alanı image . Medya kartıyla gösterilecek resim. image şunlardan yalnızca biri olabilir: |
||
largeImage |
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ı. |
CarouselBrowse
Bir dizi AMP dokümanı, büyük öğeli öğelerin yer aldığı bir bant olarak sunar. İlişkili AMP dokümanını bir AMP görüntüleyicide başlatmak için öğeler seçilebilir.
JSON gösterimi | |
---|---|
{ "items": [ { object ( |
Alanlar | |
---|---|
items[] |
Min: 2. Maks.: 10. |
imageDisplayOptions |
Resim görüntüleme seçeneğinin türü. İsteğe bağlı. |
Öğe
Banttaki öğe.
JSON gösterimi | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Alanlar | |
---|---|
title |
başlığı. Zorunlu. |
description |
ve bant öğesinin açıklaması. İsteğe bağlı. |
footer |
Bant öğesi için açıklamanın altında görüntülenen altbilgi metni. Üç nokta ile kısaltılmış tek satır metin. İsteğe bağlı. |
image |
Bant öğesi için hero resim. İsteğe bağlı. |
openUrlAction |
Bant öğesiyle ilişkili dokümanın URL'si. Dokümanda HTML içeriği olabilir veya "urlTypeHint" AMP_CONTENT, AMP içeriği olarak ayarlandı. Zorunlu. |
TableCard
Bir 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 alt başlık 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ö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. WEB_BROWSER özelliğini 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 (başlıklar dahil) korur.
JSON gösterimi | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Alanlar | |
---|---|
header |
Sütunun başlık metni. |
horizontalAlignment |
İçerik sütunuyla yatay hizalama. Belirtilmemişse içerik ön kenarla 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ö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. |
dividerAfter |
Her satırdan sonra bir ayırıcı olması gerekip gerekmediğini belirtir. |
Cell
Bir satırdaki bir 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. Maksimum boyut yanıt 50 bin 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 ileti dizisine hızlı bir şekilde yanıt yayınlamak için dokunabileceği bir öneri çipi.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Ö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. En fazla 25 karakter gerekir |
LinkOutSuggestion
Kullanıcının bu temsilciyle ilişkili uygulama veya web sitesine gitmesine 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 uygulama 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 intent URL'lerini destekler. Amaç URL'leri için şu sayfaya bakın: https://developer.chrome.com/multidevice/android/intents |
ExpectedIntent
Uygulamanın asistandan sağlaması beklenen amaç.
JSON gösterimi | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
Alanlar | |
---|---|
intent |
Yerleşik amaç adı, ör. |
inputValueData |
Yerleşik bir amaç için gereken ek yapılandırma verileri. Yerleşik amaçlar için olası değerler: Rastgele türden alanlar içeren nesne. Ek bir |
parameterName |
İsteğe bağlı olarak, istenen niyetin 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 bir durumda verilen nihai yanıt.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
Birleştirme alanı response . Olası yanıt türleri. response şunlardan yalnızca biri olabilir: |
||
speechResponse |
Kullanıcının giriş sağlaması gerekmediğinde sözlü yanıt. |
|
richResponse |
Kullanıcının giriş sağlaması gerekmediğinde zengin yanıt. |
CustomPushMessage
İşlemler Fulfillment API'si için aktarılmak üzere yapılandırılmış verileri tutan özel bir push mesajı.
JSON gösterimi | |
---|---|
{ "target": { object ( |
Alanlar | ||
---|---|---|
target |
Push isteği için belirtilen hedef. |
|
Birleştirme alanı content . Farklı yük türleri. content şunlardan yalnızca biri olabilir: |
||
orderUpdate |
İşlem API'leri aracılığıyla verilen siparişleri güncelleyen bir sipariş güncellemesi. |
|
userNotification |
Belirtilirse kullanıcıya, belirtilen başlık ve metinle bir bildirim gösterir. |
UserNotification
İstekle 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 |
Hedeflemenin amacı. |
argument |
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 kodu kullanılır. Belirli yerelleştirilmiş bir uygulamadaki bir kullanıcıyı hedeflemek için çok dilli uygulamalarda kullanılabilir. Belirtilmezse varsayılan olarak en-US kullanılır. |