- 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 dalam 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 diresirkulasi ke Action setiap percakapan berganti. |
userStorage |
Token buram yang dikontrol oleh Action yang dipertahankan di seluruh percakapan untuk pengguna tertentu. Jika kosong atau tidak ditentukan, token persisten yang 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 tidak terduga. |
resetUserStorage |
Apakah akan menghapus userStorage yang dipertahankan. Jika ditetapkan ke true, pada interaksi berikutnya dengan pengguna, kolom userStorage akan kosong. |
expectUserResponse |
Menunjukkan apakah Action mengharapkan respons pengguna atau tidak. Hal ini berlaku saat percakapan sedang berlangsung, dan salah jika percakapan selesai. |
expectedInputs[] |
Daftar input yang diharapkan Action, setiap input dapat 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 ke 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 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 oleh Google untuk pembiasan ucapan. Hingga 1.000 frasa diizinkan. |
InputPrompt
Prompt input yang digunakan asisten untuk memandu pengguna memberikan input bagi pertanyaan aplikasi.
Representasi JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Kolom | |
---|---|
initialPrompts[] |
Permintaan awal yang meminta pengguna untuk memberikan input. Hanya satu initial_prompt yang didukung. |
richInitialPrompt |
Payload dialog. |
noInputPrompts[] |
{i>Prompt<i} yang digunakan untuk menanyakan kepada pengguna ketika 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 ada berupa salah satu diantara berikut: |
||
textToSpeech |
Teks biasa dari output ucapan, misalnya, "Anda mau pergi ke mana?"/ |
|
ssml |
Respons lisan terstruktur kepada pengguna dalam format SSML, mis. " |
RichResponse
Respons beragam 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. Respons ini akan selalu muncul di akhir respons. Jika digunakan dalam |
linkOutSuggestion |
Chip saran tambahan yang dapat menautkan ke aplikasi atau situs terkait. |
Item
Item respons.
Representasi JSON | |
---|---|
{ "name": string, // Union field |
Kolom | ||
---|---|---|
name |
ID bernama Item ini opsional. |
|
Kolom union item . Jenis item. item hanya ada berupa salah satu diantara berikut: |
||
simpleResponse |
Respons suara dan teks saja. |
|
basicCard |
Kartu dasar. |
|
structuredResponse |
Payload terstruktur yang akan diproses oleh Google. |
|
mediaResponse |
Respons yang menunjukkan sekumpulan 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 ditampilkan kepada pengguna.
Representasi JSON | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
Kolom | |
---|---|
textToSpeech |
Teks biasa dari output ucapan, misalnya, "ke mana kamu mau pergi?" Saling eksklusif dengan ssml. |
ssml |
Respons lisan terstruktur kepada pengguna dalam format SSML, misalnya |
displayText |
Teks opsional yang akan 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 |
Judul kartu secara keseluruhan. Opsional. |
subtitle |
Opsional. |
formattedText |
Teks isi kartu. Mendukung serangkaian sintaksis markdown terbatas untuk pemformatan. Wajib, kecuali jika ada gambar. |
image |
Banner besar untuk kartu. Tingginya ditetapkan ke 192 dp. Opsional. |
buttons[] |
Tombol. Saat ini maksimum hanya 1 tombol yang didukung. Opsional. |
imageDisplayOptions |
jenis tampilan gambar. Opsional. |
Tombol
Objek tombol yang biasanya muncul di bagian bawah kartu.
Representasi JSON | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
Kolom | |
---|---|
title |
judul tombol. Wajib. |
openUrlAction |
Tindakan yang diambil saat pengguna mengetuk tombol. Wajib. |
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 ada berupa salah satu diantara berikut: |
||
orderUpdate |
Aplikasi akan 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. Memperbarui pesanan.
Representasi JSON | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
Kolom | ||
---|---|---|
googleOrderId |
Id pesanan adalah id yang dikeluarkan Google. |
|
actionOrderId |
Wajib. ID pesanan kanonis yang merujuk pesanan ini. Jika integrator tidak menghasilkan ID pesanan kanonis di sistem mereka, integrator cukup menyalin googleOrderId yang disertakan secara berurutan. |
|
orderState |
Status baru pesanan. |
|
orderManagementActions[] |
Memperbarui tindakan pengelolaan yang berlaku untuk pesanan tersebut, misalnya mengelola, mengubah, menghubungi dukungan. |
|
receipt |
Tanda terima untuk pesanan. |
|
updateTime |
Saat pesanan diperbarui dari perspektif aplikasi. Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: |
|
totalPrice |
Total harga baru pesanan |
|
lineItemUpdates |
Peta perubahan tingkat item baris, dengan kunci berdasarkan 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 status standar. Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
|
Kolom union info . Informasi tambahan yang terkait dengan status pesanan. info hanya ada berupa salah satu diantara berikut: |
||
rejectionInfo |
Informasi tentang status penolakan. |
|
cancellationInfo |
Informasi tentang status pembatalan. |
|
inTransitInfo |
Informasi tentang status transit. |
|
fulfillmentInfo |
Informasi tentang status fulfillment. |
|
returnInfo |
Informasi tentang status yang dikembalikan. |
Tindakan
Tindakan lanjutan yang terkait dengan pembaruan pesanan.
Representasi JSON | |
---|---|
{ "type": enum ( |
Kolom | |
---|---|
type |
dari jenis tindakan. |
button |
Label tombol dan link. |
Tanda Terima
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Tanda terima ketika negara bagian DIKONFIRMASI atau negara bagian lainnya (misalnya IN_TRANSIT, FULFILLED) termasuk status CONFIRMED.
Representasi JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Kolom | |
---|---|
confirmedActionOrderId |
Mengonfirmasi ID pesanan saat pesanan diterima oleh integrator. Ini adalah ID pesanan kanonis yang digunakan dalam sistem integrator yang merujuk pesanan 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 di tanda terima cetak atau tanda terima yang dikirim ke email pengguna. Pengguna harus dapat menggunakan ID ini yang merujuk pesanannya untuk layanan pelanggan yang disediakan oleh integrator. Perhatikan bahwa kolom ini harus diisi jika integrator membuat ID yang ditampilkan kepada pengguna untuk pesanan dengan tanda terima yang dicetak / tanda terima email. |
RejectionInfo
Info penolakan saat status DITOLAK. Pesan ini dapat diisi dalam pembaruan urutan 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 jika status DIBATALKAN.
Representasi JSON | |
---|---|
{ "reason": string } |
Kolom | |
---|---|
reason |
Alasan pembatalan. |
InTransitInfo
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Info transit saat statusnya adalah IN_TRANSIT.
Representasi JSON | |
---|---|
{ "updatedTime": string } |
Kolom | |
---|---|
updatedTime |
Waktu transit terakhir. Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: |
FulfillmentInfo
Tidak digunakan lagi: Sebagai gantinya, gunakan V3 Proto. Info pemenuhan jika status FULFILLED.
Representasi JSON | |
---|---|
{ "deliveryTime": string } |
Kolom | |
---|---|
deliveryTime |
Waktu 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 |
nama objek media ini. |
|
description |
deskripsi objek media ini. |
|
contentUrl |
URL yang mengarah ke konten media. |
|
Kolom union image . Gambar yang akan ditampilkan dengan kartu media. image hanya ada berupa salah satu diantara berikut: |
||
largeImage |
Gambar 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 berukuran besar. Item dapat dipilih untuk meluncurkan dokumen AMP terkaitnya di AMP viewer.
Representasi JSON | |
---|---|
{ "items": [ { object ( |
Kolom | |
---|---|
items[] |
Min: 2. Maksimal: 10. |
imageDisplayOptions |
jenis tampilan gambar. Opsional. |
Item
Item di carousel.
Representasi JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Kolom | |
---|---|
title |
judul item carousel. Wajib. |
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. |
TableCard
Kartu tabel untuk menampilkan tabel teks.
Representasi JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Kolom | |
---|---|
title |
Judul tabel secara keseluruhan. Opsional, tetapi harus disetel jika subtitel telah disetel. |
subtitle |
Subtitel untuk tabel. Opsional. |
image |
Gambar yang terkait dengan tabel. Opsional. |
columnProperties[] |
Header dan perataan kolom. |
rows[] |
Data baris dalam tabel. 3 baris pertama dijamin akan ditampilkan, tetapi baris lainnya mungkin terpotong pada permukaan tertentu. Uji dengan simulator untuk melihat baris mana yang akan ditampilkan untuk platform tertentu. Pada platform yang mendukung kemampuan WEB_BROWSER, Anda dapat mengarahkan pengguna ke laman web yang berisi lebih banyak data. |
buttons[] |
Tombol. Saat ini maksimum hanya 1 tombol yang didukung. Opsional. |
ColumnProperties
Menyimpan properti kolom (termasuk {i>header<i}).
Representasi JSON | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Kolom | |
---|---|
header |
Teks header untuk kolom. |
horizontalAlignment |
Perataan horizontal kolom konten. Jika tidak ditentukan, konten akan disejajarkan dengan tepi depan. |
Baris
Menjelaskan baris dalam tabel.
Representasi JSON | |
---|---|
{
"cells": [
{
object ( |
Kolom | |
---|---|
cells[] |
Sel dalam baris ini. 3 sel pertama dijamin akan ditampilkan, tetapi sel lainnya mungkin terpotong pada permukaan tertentu. Uji dengan simulator untuk melihat sel mana yang akan ditampilkan untuk permukaan tertentu. |
dividerAfter |
Menunjukkan apakah harus ada pemisah setelah setiap baris. |
{i>Cell <i}atau sel
Menjelaskan sel secara berurutan.
Representasi JSON | |
---|---|
{ "text": string } |
Kolom | |
---|---|
text |
Konten teks di sel. |
HtmlResponse
Respons yang menampilkan HTML menggunakan fitur kanvas interaktif. Ukuran maksimum respons adalah 50 ribu 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 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 Maks 25 karakter |
LinkOutSuggestion
Membuat chip saran yang memungkinkan pengguna melompat ke 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 "Buka |
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 developer Google. Jika tidak, saran tidak akan ditampilkan kepada pengguna. Tindakan URL Terbuka 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, misalnya, |
inputValueData |
Data konfigurasi tambahan yang diperlukan oleh intent bawaan. Nilai yang mungkin untuk intent bawaan: Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
parameterName |
Opsional, parameter intent yang diminta. Hanya valid untuk intent yang diminta. Digunakan untuk pembiasan ucapan. |
FinalResponse
Respons akhir saat input pengguna tidak diharapkan.
Representasi JSON | |
---|---|
{ // Union field |
Kolom | ||
---|---|---|
Kolom union response . Jenis respons yang mungkin. response hanya ada berupa salah satu diantara berikut: |
||
speechResponse |
Respons lisan ketika pengguna tidak diharuskan memberikan input. |
|
richResponse |
Respons yang kaya saat pengguna tidak diwajibkan untuk memberikan input. |
CustomPushMessage
Pesan push kustom yang menyimpan data terstruktur untuk mendorong tindakan Fulfillment API.
Representasi JSON | |
---|---|
{ "target": { object ( |
Kolom | ||
---|---|---|
target |
Target yang ditentukan untuk permintaan push. |
|
Kolom union content . Berbagai jenis payload. content hanya ada berupa salah satu diantara 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 yang akan ditampilkan dengan permintaan.
Representasi JSON | |
---|---|
{ "title": string, "text": string } |
Kolom | |
---|---|
title |
Judul untuk notifikasi. |
text |
Isi 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 akan 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 yang dilokalkan tertentu. Jika tidak ditentukan, en-US akan ditetapkan secara default. |