- Representasi JSON
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Item
- SimpleResponse
- BasicCard
- Tombol
- StructuredResponse
- OrderUpdate
- Tindakan
- Tanda Terima
- RejectionInfo
- CancellationInfo
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Item
- TableCard
- ColumnProperties
- Baris
- Sel
- HtmlResponse
- Saran
- LinkOutSuggestion
- ExpectedIntent
- FinalResponse
- CustomPushMessage
- UserNotification
- Target
AppResponse adalah respons yang dikirim oleh fulfillment ke Asisten Google. Untuk contoh cara penggunaannya di Actions on Google, lihat https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#conversation-response-body
Representasi JSON | |
---|---|
{ "conversationToken": string, "userStorage": string, "resetUserStorage": boolean, "expectUserResponse": boolean, "expectedInputs": [ { object ( |
Kolom | |
---|---|
conversationToken |
Token buram yang diedarkan ulang ke Action setiap percakapan berubah. |
userStorage |
Token buram yang dikontrol oleh Action yang dipertahankan di seluruh percakapan untuk pengguna tertentu. Jika kosong atau tidak ditentukan, token yang dipertahankan dan sudah ada tidak akan berubah. Ukuran maksimum string adalah 10 ribu byte. Jika beberapa dialog terjadi secara serentak untuk pengguna yang sama, update pada token ini dapat menimpa satu sama lain secara tiba-tiba. |
resetUserStorage |
Apakah akan menghapus userStorage yang dipertahankan. Jika ditetapkan ke true, maka dalam interaksi berikutnya dengan pengguna, kolom userStorage akan kosong. |
expectUserResponse |
Menunjukkan apakah Action mengharapkan respons pengguna. Ini berlaku jika percakapan sedang berlangsung, salah jika percakapan selesai. |
expectedInputs[] |
Daftar input yang diharapkan Action, setiap input bisa berupa tindakan umum pada intent Google (dimulai dengan 'actions'), atau input yang mengambil daftar kemungkinan intent. Hanya satu input yang didukung untuk saat ini. |
finalResponse |
Respons akhir saat Action tidak mengharapkan input pengguna. |
customPushMessage |
Pesan push kustom yang memungkinkan developer mengirim data terstruktur untuk melakukan tindakan di Google. |
isInSandbox |
Menunjukkan apakah respons harus ditangani dalam mode sandbox. Bit ini diperlukan untuk mengirim data terstruktur ke Google dalam mode sandbox. |
ExpectedInput
Representasi JSON | |
---|---|
{ "inputPrompt": { object ( |
Kolom | |
---|---|
inputPrompt |
Prompt kustom yang digunakan untuk meminta input dari pengguna. |
possibleIntents[] |
Daftar intent yang dapat digunakan untuk memenuhi input ini. Agar tindakan di Google hanya menampilkan input pengguna mentah, aplikasi harus meminta intent |
speechBiasingHints[] |
Daftar frasa yang diinginkan Action untuk digunakan Google untuk pembiasan ucapan. Hingga 1.000 frasa diizinkan. |
InputPrompt
Permintaan input yang digunakan asisten untuk memandu pengguna memberikan input untuk pertanyaan aplikasi.
Representasi JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Kolom | |
---|---|
initialPrompts[] |
Perintah awal yang meminta pengguna untuk memberikan input. Hanya satu initial_prompt yang didukung. |
richInitialPrompt |
Payload prompt. |
noInputPrompts[] |
Perintah yang digunakan untuk bertanya kepada pengguna saat tidak ada input dari pengguna. |
SpeechResponse
Respons yang hanya berisi ucapan. TIDAK DIGUNAKAN LAGI.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union type . Jenis output ucapan: text to speech atau SSML. type hanya dapat berupa salah satu dari berikut: |
||
textToSpeech |
Teks biasa dari output ucapan, misalnya, "ke mana kamu ingin pergi?"/ |
|
ssml |
Respons lisan terstruktur kepada pengguna dalam format SSML, misalnya, " |
RichResponse
Respons lengkap yang dapat mencakup audio, teks, kartu, saran, dan data terstruktur.
Representasi JSON | |
---|---|
{ "items": [ { object ( |
Kolom | |
---|---|
items[] |
Daftar elemen UI yang menyusun respons Item harus memenuhi persyaratan berikut: 1. Item pertama harus berupa |
suggestions[] |
Daftar balasan yang disarankan. Ini akan selalu muncul di akhir respons. Jika digunakan di |
linkOutSuggestion |
Chip saran tambahan yang dapat ditautkan ke aplikasi atau situs terkait. |
Item
Item respons.
Representasi JSON | |
---|---|
{ "name": string, // Union field |
Kolom | ||
---|---|---|
name |
ID bernama opsional untuk Item ini. |
|
Kolom union item . Jenis item. item hanya dapat berupa salah satu dari berikut: |
||
simpleResponse |
Respons suara dan teks saja. |
|
basicCard |
Kartu dasar. |
|
structuredResponse |
Payload terstruktur yang akan diproses oleh Google. |
|
mediaResponse |
Respons yang menunjukkan kumpulan media yang akan diputar. |
|
carouselBrowse |
Kartu penjelajahan carousel, gunakan collectionBrowse sebagai gantinya.. |
|
tableCard |
Kartu tabel. |
|
htmlResponse |
Respons html yang digunakan untuk merender di Canvas. |
SimpleResponse
Respons sederhana yang berisi ucapan atau teks untuk ditunjukkan kepada pengguna.
Representasi JSON | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
Kolom | |
---|---|
textToSpeech |
Teks biasa dari output ucapan, misalnya, "ke mana kamu ingin pergi?" Tidak dapat muncul bersamaan dengan ssml. |
ssml |
Respons lisan terstruktur kepada pengguna dalam format SSML, misalnya, |
displayText |
Teks opsional untuk ditampilkan dalam balon chat. Jika tidak diberikan, rendering tampilan textToSpeech atau ssml di atas akan digunakan. Dibatasi hingga 640 karakter. |
BasicCard
Kartu dasar untuk menampilkan beberapa informasi, misalnya gambar dan/atau teks.
Representasi JSON | |
---|---|
{ "title": string, "subtitle": string, "formattedText": string, "image": { object ( |
Kolom | |
---|---|
title |
Keseluruhan judul kartu. Opsional. |
subtitle |
Opsional. |
formattedText |
Teks isi kartu. Mendukung serangkaian sintaksis markdown terbatas untuk pemformatan. Wajib, kecuali ada gambar. |
image |
Banner besar untuk kartu. Tinggi ditetapkan ke 192 dp. Opsional. |
buttons[] |
Tombol. Saat ini, maksimum 1 tombol didukung. Opsional. |
imageDisplayOptions |
jenis opsi tampilan gambar. Opsional. |
Tombol
Objek tombol yang biasanya muncul di bagian bawah kartu.
Representasi JSON | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
Kolom | |
---|---|
title |
judul tombolnya. Wajib diisi. |
openUrlAction |
Tindakan yang akan diambil saat pengguna mengetuk tombol. Wajib diisi. |
StructuredResponse
Respons yang ditentukan agar aplikasi merespons dengan data terstruktur.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union data . Container respons payload dari agen pihak ketiga. data hanya dapat berupa salah satu dari berikut: |
||
orderUpdate |
Aplikasi memberikan pembaruan pesanan (misalnya, |
|
orderUpdateV3 |
Aplikasi memberikan pembaruan pesanan dalam format API v3 setelah menerima pesanan. |
OrderUpdate
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Pembaruan pada pesanan.
Representasi JSON | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
Kolom | ||
---|---|---|
googleOrderId |
ID pesanan adalah ID yang dikeluarkan Google. |
|
actionOrderId |
Wajib diisi. ID pesanan kanonis yang merujuk pesanan ini. Jika integrator tidak membuat ID pesanan kanonis di sistemnya, mereka dapat menyalin googleOrderId yang disertakan secara berurutan. |
|
orderState |
Status baru pesanan. |
|
orderManagementActions[] |
Memperbarui tindakan pengelolaan yang berlaku untuk pesanan, misalnya, kelola, ubah, hubungi dukungan. |
|
receipt |
Tanda terima pesanan. |
|
updateTime |
Saat pesanan diperbarui dari perspektif aplikasi. Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: |
|
totalPrice |
Total harga pesanan baru |
|
lineItemUpdates |
Peta perubahan tingkat item baris, yang dibatasi oleh ID item. Opsional. Objek yang berisi daftar pasangan |
|
userNotification |
Jika ditentukan, menampilkan notifikasi kepada pengguna dengan judul dan teks yang ditentukan. Menentukan notifikasi adalah saran untuk memberi tahu dan tidak dijamin akan menghasilkan notifikasi. |
|
infoExtension |
Data tambahan berdasarkan status pesanan khusus atau selain info tentang status standar. Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
|
Kolom union info . Informasi tambahan yang terkait dengan status pesanan. info hanya dapat berupa salah satu dari berikut: |
||
rejectionInfo |
Informasi tentang status penolakan. |
|
cancellationInfo |
Informasi tentang status pembatalan. |
|
inTransitInfo |
Informasi tentang status dalam pengiriman. |
|
fulfillmentInfo |
Informasi tentang status fulfillment. |
|
returnInfo |
Informasi tentang status yang ditampilkan. |
Tindakan
Tindakan tindak lanjut yang terkait dengan pembaruan pesanan.
Representasi JSON | |
---|---|
{ "type": enum ( |
Kolom | |
---|---|
type |
jenis tindakan tertentu. |
button |
Label dan link tombol. |
Tanda Terima
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Tanda terima ketika negara bagian DIKONFIRMASI atau status lainnya (misalnya IN_TRANSIT, FULFILLED) termasuk status CONFIRMED.
Representasi JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Kolom | |
---|---|
confirmedActionOrderId |
ID pesanan yang dikonfirmasi saat pesanan telah diterima oleh integrator. Ini adalah ID pesanan kanonis yang digunakan dalam sistem integrator yang merujuk pesanan tersebut dan selanjutnya dapat digunakan untuk mengidentifikasi pesanan sebagai Perhatikan bahwa kolom ini tidak digunakan lagi. Sebagai gantinya, teruskan kolom melalui OrderUpdate.action_order_id. |
userVisibleOrderId |
Opsional. ID yang dilihat pengguna yang merujuk ke pesanan saat ini, yang akan muncul di kartu tanda terima jika ada. Ini harus berupa ID yang biasanya muncul pada tanda terima atau tanda terima yang dicetak yang dikirim ke email pengguna. Pengguna harus dapat menggunakan ID ini yang merujuk pada pesanannya untuk layanan pelanggan yang disediakan oleh integrator. Perhatikan bahwa kolom ini harus diisi jika integrator memang membuat ID yang ditampilkan kepada pengguna untuk pesanan dengan tanda terima cetak / tanda terima email. |
RejectionInfo
Info penolakan saat status DITOLAK. Pesan ini dapat diisi pada pembaruan pesanan awal dalam percakapan atau melalui pembaruan urutan asinkron berikutnya.
Representasi JSON | |
---|---|
{
"type": enum ( |
Kolom | |
---|---|
type |
Jenis penolakan. |
reason |
Alasan error. |
CancellationInfo
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Info pembatalan saat status DIBATALKAN.
Representasi JSON | |
---|---|
{ "reason": string } |
Kolom | |
---|---|
reason |
Alasan pembatalan. |
InTransitInfo
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Info dalam pengiriman saat status adalah IN_TRANSIT.
Representasi JSON | |
---|---|
{ "updatedTime": string } |
Kolom | |
---|---|
updatedTime |
Waktu terakhir diperbarui untuk transit. Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: |
FulfillmentInfo
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Info fulfillment saat status TERPENUHI.
Representasi JSON | |
---|---|
{ "deliveryTime": string } |
Kolom | |
---|---|
deliveryTime |
Kapan pesanan akan dipenuhi. Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: |
ReturnInfo
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Info pengembalian jika status DITOLAK.
Representasi JSON | |
---|---|
{ "reason": string } |
Kolom | |
---|---|
reason |
Alasan pengembalian. |
UserNotification
Notifikasi pengguna opsional yang akan ditampilkan sebagai bagian dari Pembaruan pesanan.
Representasi JSON | |
---|---|
{ "title": string, "text": string } |
Kolom | |
---|---|
title |
Judul untuk notifikasi pengguna. |
text |
Isi notifikasi. |
MediaResponse
Respons yang menunjukkan sekumpulan media yang akan diputar dalam percakapan.
Representasi JSON | |
---|---|
{ "mediaType": enum ( |
Kolom | |
---|---|
mediaType |
jenis media dalam respons ini. |
mediaObjects[] |
Daftar objek media. |
MediaObject
Mewakili satu objek media yang ditampilkan dengan MediaResponse. Berisi informasi tentang media, seperti nama, deskripsi, URL, dll.
Representasi JSON | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Kolom | ||
---|---|---|
name |
dari objek media ini. |
|
description |
objek media ini. |
|
contentUrl |
URL yang mengarah ke konten media. |
|
Kolom union image . Gambar yang akan ditampilkan dengan kartu media. image hanya dapat berupa salah satu dari berikut: |
||
largeImage |
Gambar berukuran besar, seperti sampul album, dll. |
|
icon |
Ikon gambar kecil ditampilkan di sebelah kanan dari judul. Ukurannya diubah menjadi 36x36 dp. |
CarouselBrowse
Menampilkan kumpulan dokumen AMP sebagai carousel item kartu besar. Item dapat dipilih untuk meluncurkan dokumen AMP terkait di AMP viewer.
Representasi JSON | |
---|---|
{ "items": [ { object ( |
Kolom | |
---|---|
items[] |
Minimum: 2. Maks: 10. |
imageDisplayOptions |
jenis opsi tampilan gambar. Opsional. |
Item
Item di carousel.
Representasi JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Kolom | |
---|---|
title |
judul item carousel. Wajib diisi. |
description |
deskripsi item carousel. Opsional. |
footer |
Teks footer untuk item carousel, ditampilkan di bawah deskripsi. Satu baris teks, terpotong dengan elipsis. Opsional. |
image |
Banner besar untuk item carousel. Opsional. |
openUrlAction |
URL dokumen yang terkait dengan item carousel. Dokumen dapat berisi konten HTML atau, jika "urlTypeHint" ditetapkan ke AMP_CONTENT, konten AMP. Wajib diisi. |
TableCard
Kartu tabel untuk menampilkan tabel teks.
Representasi JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Kolom | |
---|---|
title |
Judul tabel keseluruhan. Opsional, tetapi harus ditetapkan jika subtitel disetel. |
subtitle |
Subtitel untuk tabel. Opsional. |
image |
Gambar yang terkait dengan tabel. Opsional. |
columnProperties[] |
Header dan perataan kolom. |
rows[] |
Data baris pada tabel. Tiga baris pertama dijamin akan ditampilkan, tetapi baris lainnya mungkin dipotong di platform tertentu. Uji dengan simulator guna melihat baris yang akan ditampilkan untuk platform tertentu. Pada platform yang mendukung kemampuan WEB_BROWSER, Anda dapat mengarahkan pengguna ke halaman web yang berisi lebih banyak data. |
buttons[] |
Tombol. Saat ini, maksimum 1 tombol didukung. Opsional. |
ColumnProperties
Menyimpan properti kolom (termasuk header).
Representasi JSON | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Kolom | |
---|---|
header |
Teks header untuk kolom. |
horizontalAlignment |
Perataan horizontal kolom w.r.t konten. Jika tidak ditentukan, konten akan disejajarkan dengan bagian tepi utama. |
Baris
Mendeskripsikan baris dalam tabel.
Representasi JSON | |
---|---|
{
"cells": [
{
object ( |
Kolom | |
---|---|
cells[] |
Sel di baris ini. Tiga sel pertama dijamin akan ditampilkan, tetapi sel lainnya mungkin terpotong pada permukaan tertentu. Uji dengan simulator untuk mengetahui sel mana yang akan ditampilkan untuk permukaan tertentu. |
dividerAfter |
Menunjukkan apakah harus ada pemisah setelah setiap baris. |
{i>Cell <i}atau sel
Menggambarkan sel dalam baris.
Representasi JSON | |
---|---|
{ "text": string } |
Kolom | |
---|---|
text |
Konten teks dalam sel. |
HtmlResponse
Respons yang menampilkan HTML menggunakan fitur kanvas interaktif. Ukuran maksimum responsnya adalah 50k byte.
Representasi JSON | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
Kolom | |
---|---|
updatedState |
Komunikasikan objek JSON berikut ke aplikasi. |
suppressMic |
Berikan opsi agar mikrofon tidak akan dibuka setelah respons imersif ini. |
url |
URL aplikasi. |
Saran
Chip saran yang dapat diketuk oleh pengguna untuk memposting balasan ke percakapan dengan cepat.
Representasi JSON | |
---|---|
{ "title": string } |
Kolom | |
---|---|
title |
Teks yang ditampilkan dalam chip saran. Saat diketuk, teks ini akan diposting kembali ke percakapan kata demi kata seolah-olah pengguna telah mengetiknya. Setiap judul harus unik di antara kumpulan chip saran. Diperlukan maksimum 25 karakter |
LinkOutSuggestion
Membuat chip saran yang memungkinkan pengguna membuka Aplikasi atau Situs yang terkait dengan agen ini.
Representasi JSON | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Kolom | |
---|---|
destinationName |
Nama aplikasi atau situs yang ditautkan ke chip ini. Chip akan dirender dengan judul "Open |
url |
Tidak digunakan lagi. Sebagai gantinya, gunakan OpenUrlAction. |
openUrlAction |
URL Aplikasi atau Situs yang akan dibuka saat pengguna mengetuk chip saran. Kepemilikan Aplikasi/URL ini harus divalidasi dalam tindakan di Konsol Google Play, atau saran tidak akan ditampilkan kepada pengguna. Buka Tindakan URL mendukung URL http, https, dan intent. Untuk URL Intent, lihat: https://developer.chrome.com/multidevice/android/intents |
ExpectedIntent
Intent yang diharapkan yang diminta aplikasi untuk diberikan oleh asisten.
Representasi JSON | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
Kolom | |
---|---|
intent |
Nama intent bawaan, mis. |
inputValueData |
Data konfigurasi tambahan yang diperlukan oleh intent bawaan. Nilai yang mungkin untuk intent bawaan: Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
parameterName |
Secara opsional, parameter intent yang sedang diminta. Hanya valid untuk intent yang diminta. Digunakan untuk pembiasan ucapan. |
FinalResponse
Respons akhir ketika input pengguna tidak diharapkan.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union response . Jenis respons yang mungkin. response hanya dapat berupa salah satu dari berikut: |
||
speechResponse |
Respons lisan ketika pengguna tidak diharuskan memberikan input. |
|
richResponse |
Respons kaya saat pengguna tidak diharuskan memberikan input. |
CustomPushMessage
Pesan push kustom yang menyimpan data terstruktur yang akan dikirim untuk tindakan Fulfillment API.
Representasi JSON | |
---|---|
{ "target": { object ( |
Kolom | ||
---|---|---|
target |
Target yang ditentukan untuk permintaan push. |
|
Kolom union content . Berbagai jenis payload. content hanya dapat berupa salah satu dari berikut: |
||
orderUpdate |
Pembaruan pesanan yang memperbarui pesanan yang dilakukan melalui API transaksi. |
|
userNotification |
Jika ditentukan, menampilkan notifikasi kepada pengguna dengan judul dan teks yang ditentukan. |
UserNotification
Notifikasi pengguna untuk ditampilkan dengan permintaan.
Representasi JSON | |
---|---|
{ "title": string, "text": string } |
Kolom | |
---|---|
title |
Judul untuk notifikasi. |
text |
Konten notifikasi. |
Target
Target yang ditentukan untuk permintaan push.
Representasi JSON | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Kolom | |
---|---|
userId |
Pengguna yang akan ditargetkan. |
intent |
Intent yang akan ditargetkan. |
argument |
Argumen yang ditargetkan untuk intent. Untuk V1, hanya satu Argumen yang didukung. |
locale |
Lokalitas yang akan ditargetkan. Mengikuti kode bahasa IETF BCP-47. Dapat digunakan oleh aplikasi multibahasa untuk menargetkan pengguna di aplikasi tertentu yang dilokalkan. Jika tidak ditentukan, defaultnya adalah en-US. |