Files

Wrapper untuk daftar file.

Representasi JSON
{

  // Union field file_type can be only one of the following:
  "configFiles": {
    object (ConfigFiles)
  },
  "dataFiles": {
    object (DataFiles)
  }
  // End of list of possible types for union field file_type.
}
Kolom
Kolom union file_type. Hanya satu jenis file yang dapat dikirim ke server pada satu waktu, file konfigurasi, atau file data. file_type hanya ada berupa salah satu diantara berikut:
configFiles

object (ConfigFiles)

Daftar file konfigurasi. Hal ini termasuk manifes, setelan, paket resource model interaksi, dan lainnya.

dataFiles

object (DataFiles)

Daftar file data. Ini mencakup gambar, file audio, kode sumber fungsi cloud.

ConfigFiles

Wrapper untuk file konfigurasi berulang. Kolom berulang tidak boleh ada di salah satu dari kolom tersebut.

Representasi JSON
{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}
Kolom
configFiles[]

object (ConfigFile)

Beberapa file konfigurasi.

ConfigFile

Mewakili satu file yang berisi data terstruktur. Developer dapat menentukan sebagian besar project mereka menggunakan konfigurasi terstruktur termasuk Actions, Settings, Fulfillment.

Representasi JSON
{
  "filePath": string,

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}
Kolom
filePath

string

Jalur relatif file konfigurasi dari root project dalam struktur file SDK. Setiap jenis file di bawah memiliki jalur file yang diizinkan. Misalnya: settings/settings.yaml

Kolom union file. Setiap jenis file konfigurasi harus memiliki kolom yang sesuai di salah satunya. file hanya ada berupa salah satu diantara berikut:
manifest

object (Manifest)

Satu file manifes. Jalur file yang diizinkan: manifest.yaml

actions

object (Actions)

File tindakan tunggal dengan semua tindakan yang ditentukan. Jalur file yang diizinkan: actions/{language}?/actions.yaml

settings

object (Settings)

Konfigurasi setelan tunggal yang mencakup setelan dan setelan yang tidak dapat dilokalkan untuk lokalitas default project (jika ditentukan). Untuk file penggantian lokalitas, hanya kolom localSettings yang akan diisi. Jalur file yang diizinkan: settings/{language}?/settings.yaml Perhatikan bahwa file setelan settings/settings.yaml yang tidak dilokalkan harus ada dalam permintaan alur tulis.

webhook

object (Webhook)

Definisi webhook tunggal. Jalur file yang diizinkan: webhooks/{WebhookName}.yaml

intent

object (Intent)

Definisi intent tunggal. Jalur file yang diizinkan: custom/intents/{language}?/{IntentName}.yaml

type

object (Type)

Definisi jenis tunggal. Jalur file yang diizinkan: custom/types/{language}?/{TypeName}.yaml

entitySet

object (EntitySet)

Definisi set entity tunggal. Jalur file yang diizinkan: custom/entitySets/{language}?/{EntitySetName}.yaml

globalIntentEvent

object (GlobalIntentEvent)

Definisi peristiwa intent global tunggal. Jalur file yang diizinkan: custom/global/{GlobalIntentEventName}.yaml Nama file (GlobalIntentEventName) harus berupa nama intent yang terkait dengan peristiwa intent global ini.

scene

object (Scene)

Definisi scene tunggal. Jalur file yang diizinkan: custom/scenes/{SceneName}.yaml

staticPrompt

object (StaticPrompt)

Definisi perintah statis tunggal. Jalur file yang diizinkan: custom/prompts/{language}?/{StaticPromptName}.yaml

accountLinkingSecret

object (AccountLinkingSecret)

Metadata yang sesuai dengan rahasia klien yang digunakan dalam penautan akun. Jalur file yang diizinkan: settings/accountLinkingSecret.yaml

resourceBundle

object (Struct format)

Paket resource tunggal, yang merupakan peta dari string ke string atau daftar string. Paket resource dapat digunakan untuk melokalkan string dalam perintah statis. Jalur file yang diizinkan: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

Manifes

Berisi informasi yang "dapat dipindahkan" yaitu tidak spesifik untuk project tertentu dan dapat dipindahkan antar-project.

Representasi JSON
{
  "version": string
}
Kolom
version

string

Versi format file. Versi format file saat ini adalah 1.0 Contoh: "1.0"

Tindakan

Menggambarkan daftar Action yang ditentukan dalam sebuah project.

Representasi JSON
{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}
Kolom
custom

map (key: string, value: object (CustomAction))

Petakan dari intent ke Action kustom guna mengonfigurasi pemanggilan untuk project. Intent pemanggilan bisa berupa intent sistem atau kustom yang didefinisikan dalam paket "custom/intents/". Semua intent yang didefinisikan di sini (intent sistem & intent kustom) harus memiliki file intent yang sesuai dalam paket "custom/global/".

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomAction

Detail terkait tindakan kustom.

Representasi JSON
{
  "engagement": {
    object (Engagement)
  }
}
Kolom
engagement

object (Engagement)

Mekanisme interaksi yang dikaitkan dengan tindakan untuk membantu pengguna akhir berlangganan notifikasi push dan info terbaru harian. Perhatikan bahwa nama intent yang ditentukan dalam konfigurasi slot notifikasi push/update harian harus cocok dengan intent yang sesuai dengan tindakan ini agar pengguna akhir berlangganan update ini.

Engagement

Mendefinisikan mekanisme interaksi yang terkait dengan tindakan ini. Hal ini memungkinkan pengguna akhir untuk berlangganan notifikasi push dan info terbaru harian.

Representasi JSON
{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}
Kolom
title

string

Judul engagement yang akan dikirim ke pengguna akhir yang meminta izin mereka untuk menerima info terbaru. Permintaan yang dikirim ke pengguna akhir untuk informasi terbaru harian akan terlihat seperti "Jam berapa Anda ingin saya mengirimkan {title}" harian Anda dan untuk notifikasi push akan terlihat seperti "Apakah tidak apa-apa jika saya mengirim notifikasi push untuk {title}". Kolom ini dapat dilokalkan.

pushNotification

object (PushNotification)

Setelan notifikasi push yang didukung engagement ini.

dailyUpdate

object (DailyUpdate)

Setelan update harian yang didukung engagement ini.

PushNotification

Menentukan setelan notifikasi push yang didukung engagement ini.

DailyUpdate

Menentukan setelan update harian yang didukung engagement ini.

Setelan

Mewakili setelan project Action yang tidak spesifik untuk lokalitas. Tag berikutnya: 22

Representasi JSON
{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}
Kolom
projectId

string

ID project Action.

defaultLocale

string

Lokalitas yang merupakan default untuk project. Untuk semua file kecuali dalam resources/ tanpa lokalitas di jalur, data yang dilokalkan diatribusikan ke defaultLocale ini. Untuk file yang berada di resources/, tidak ada lokalitas berarti resource dapat berlaku untuk semua lokalitas.

enabledRegions[]

string

Mewakili wilayah tempat pengguna dapat memanggil Action Anda, yang didasarkan pada lokasi kehadiran pengguna. Tidak dapat ditetapkan jika disabledRegions ditetapkan. Jika enabledRegions dan disabledRegions tidak ditentukan, pengguna dapat memanggil Action Anda di semua wilayah. Setiap wilayah direpresentasikan menggunakan Nama Kanonis target geografis AdWords. Lihat https://developers.google.com/adwords/api/docs/appendix/geotargeting Contohnya antara lain: - "Jerman" - "Ghana" - "Yunani" - "Grenada" - "Inggris Raya" - "Amerika Serikat" - "Kepulauan Terluar Kecil Amerika Serikat" - "Uruguay"

disabledRegions[]

string

Merepresentasikan wilayah tempat Action Anda diblokir, berdasarkan lokasi kehadiran pengguna. Tidak dapat ditetapkan jika enabledRegions ditetapkan. Setiap wilayah direpresentasikan menggunakan Nama Kanonis target geografis AdWords. Lihat https://developers.google.com/adwords/api/docs/appendix/geotargeting Contohnya antara lain: - "Jerman" - "Ghana" - "Yunani" - "Grenada" - "Inggris Raya" - "Amerika Serikat" - "Kepulauan Terluar Kecil Amerika Serikat" - "Uruguay"

category

enum (Category)

Kategori untuk project Action ini.

usesTransactionsApi

boolean

Apakah Action dapat menggunakan transaksi (misalnya, membuat reservasi, menerima pesanan, dll.). Jika salah, upaya untuk menggunakan Transactions API akan gagal.

usesDigitalPurchaseApi

boolean

Apakah Action dapat melakukan transaksi untuk barang digital.

usesInteractiveCanvas

boolean

Apakah Action menggunakan Canvas Interaktif.

usesHomeStorage

boolean

Apakah Action menggunakan fitur penyimpanan rumah.

designedForFamily

boolean

Apakah konten Action didesain untuk keluarga (DFF).

containsAlcoholOrTobaccoContent

boolean

Apakah Action berisi konten terkait alkohol atau tembakau.

keepsMicOpen

boolean

Apakah Action dapat membiarkan mikrofon aktif tanpa dialog eksplisit selama percakapan.

surfaceRequirements

object (SurfaceRequirements)

Persyaratan platform yang harus didukung platform klien untuk memanggil Action dalam project ini.

testingInstructions

string

Petunjuk pengujian bentuk bebas untuk peninjau Action (misalnya, petunjuk penautan akun).

localizedSettings

object (LocalizedSettings)

Setelan yang dilokalkan untuk lokalitas default project. Setiap lokal tambahan harus memiliki file setelan dalam direktorinya sendiri.

accountLinking

object (AccountLinking)

Izinkan pengguna membuat atau menautkan akun melalui login dengan Google dan/atau layanan OAuth Anda sendiri.

selectedAndroidApps[]

string

Aplikasi Android yang dipilih untuk mengakses pembelian Google Play untuk transaksi. Ini adalah pilihan dari aplikasi Android yang terhubung ke project tindakan untuk memverifikasi kepemilikan merek dan mengaktifkan fitur tambahan. Lihat https://developers.google.com/assistant/console/brand-verification untuk informasi selengkapnya.

Kategori

Pilihan kategori untuk project Action.

Enum
CATEGORY_UNSPECIFIED Tidak diketahui / Belum ditentukan.
BUSINESS_AND_FINANCE Kategori Bisnis dan Keuangan.
EDUCATION_AND_REFERENCE Kategori Pendidikan dan Referensi.
FOOD_AND_DRINK Kategori Makanan dan Minuman.
GAMES_AND_TRIVIA Kategori Game dan Trivia.
HEALTH_AND_FITNESS Kategori Kesehatan dan Kebugaran.
KIDS_AND_FAMILY Kategori Anak-Anak dan Keluarga.
LIFESTYLE Kategori gaya hidup.
LOCAL Kategori lokal.
MOVIES_AND_TV Film dan kategori TV.
MUSIC_AND_AUDIO Kategori Musik dan Audio.
NEWS Kategori berita,
NOVELTY_AND_HUMOR Kategori hal baru dan Humor.
PRODUCTIVITY Kategori produktivitas.
SHOPPING Kategori Shopping.
SOCIAL Kategori sosial.
SPORTS Kategori olahraga.
TRAVEL_AND_TRANSPORTATION Kategori Perjalanan dan Transportasi.
UTILITIES Kategori utilitas.
WEATHER Kategori cuaca.
HOME_CONTROL Kategori Kontrol Rumah.

SurfaceRequirements

Berisi kumpulan persyaratan yang harus didukung platform klien untuk memanggil Action dalam project Anda.

Representasi JSON
{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}
Kolom
minimumRequirements[]

object (CapabilityRequirement)

Serangkaian kemampuan minimum yang diperlukan untuk memanggil Action dalam project Anda. Jika platform tidak memiliki salah satu dari parameter ini, Action tidak akan dipicu.

CapabilityRequirement

Mewakili persyaratan tentang ketersediaan kemampuan tertentu.

Representasi JSON
{
  "capability": enum (SurfaceCapability)
}
Kolom
capability

enum (SurfaceCapability)

Jenis kemampuan.

SurfaceCapability

Kemungkinan rangkaian kemampuan permukaan.

Enum
SURFACE_CAPABILITY_UNSPECIFIED Tidak diketahui / Belum ditentukan.
AUDIO_OUTPUT Surface mendukung output audio.
SCREEN_OUTPUT Surface mendukung output layar/visual.
MEDIA_RESPONSE_AUDIO Surface mendukung audio respons media.
WEB_BROWSER Surface mendukung browser web.
ACCOUNT_LINKING Surface mendukung penautan akun.
INTERACTIVE_CANVAS Surface mendukung Canvas Interaktif.
HOME_STORAGE Surface mendukung penyimpanan rumah.

LocalizedSettings

Mewakili setelan project Action yang spesifik untuk lokalitas pengguna. Dalam contoh ini, pengguna adalah pengguna akhir yang memanggil Action Anda. Pesan ini dapat dilokalkan.

Representasi JSON
{
  "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 (ThemeCustomization)
  }
}
Kolom
displayName

string

Wajib. Nama tampilan default untuk project Action ini (jika tidak ada terjemahan yang tersedia)

pronunciation

string

Wajib. Pengucapan nama tampilan untuk memanggilnya dalam konteks suara (lisan).

shortDescription

string

Wajib. Deskripsi singkat default untuk project Action (jika tidak ada terjemahan yang tersedia). Maksimal 80 karakter.

fullDescription

string

Wajib. Deskripsi panjang default untuk project Action (jika tidak ada terjemahan yang tersedia). Maksimal 4.000 karakter.

smallLogoImage

string

Wajib. Gambar persegi kecil, 192x192 piksel. Ini harus ditentukan sebagai referensi ke gambar yang sesuai dalam direktori resources/images/. Misalnya, $resources.images.foo (tanpa ekstensi) untuk gambar di resources/images/foo.jpg Saat mengerjakan project yang diambil dari Konsol, URL yang dikelola Google yang diambil dapat digunakan. URL dari sumber eksternal tidak diizinkan.

largeBannerImage

string

Opsional. Gambar lanskap besar, 1920x1080 piksel. Ini harus ditentukan sebagai referensi ke gambar yang sesuai dalam direktori resources/images/. Misalnya, $resources.images.foo (tanpa ekstensi) untuk gambar di resources/images/foo.jpg Saat mengerjakan project yang diambil dari Konsol, URL yang dikelola Google yang diambil dapat digunakan. URL dari sumber eksternal tidak diizinkan.

developerName

string

Wajib. Nama developer yang akan ditampilkan kepada pengguna.

developerEmail

string

Wajib. Alamat email kontak developer.

termsOfServiceUrl

string

Opsional. URL persyaratan layanan.

voice

string

Wajib. Jenis suara Asisten Google yang didengar pengguna saat mereka berinteraksi dengan Action Anda. Nilai yang didukung adalah "male_1", "male_2", "Female_1", dan "Female_2".

voiceLocale

string

Opsional. Lokalitas untuk suara yang ditentukan. Jika tidak ditentukan, tindakan ini akan me-resolve ke lokalitas Asisten pengguna. Jika ditentukan, lokalitas suara harus memiliki bahasa root yang sama dengan lokalitas yang ditentukan di LocalizedSettings.

privacyPolicyUrl

string

Wajib. URL kebijakan privasi.

sampleInvocations[]

string

Opsional. Contoh frasa panggilan yang ditampilkan sebagai bagian dari deskripsi project Action Anda di direktori Asisten. Hal ini akan membantu pengguna mempelajari cara menggunakannya.

themeCustomization

object (ThemeCustomization)

Opsional. Penyesuaian tema untuk komponen visual Action Anda.

ThemeCustomization

Gaya yang diterapkan pada kartu yang ditampilkan kepada pengguna

Representasi JSON
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
Kolom
backgroundColor

string

Warna latar belakang kartu. Berfungsi sebagai penggantian jika background_image tidak disediakan oleh developer atau background_image tidak sesuai untuk platform tertentu. Contoh penggunaan: #FAFAFA

primaryColor

string

Warna tema utama Action akan digunakan untuk menetapkan warna teks judul, warna latar belakang item tindakan untuk kartu Actions on Google. Contoh penggunaan: #FAFAFA

fontFamily

string

Jenis font yang akan digunakan untuk judul kartu. Font yang didukung: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Cursive - Sans Serif Smallcaps

imageCornerStyle

enum (ImageCornerStyle)

Gaya batas gambar latar depan kartu. Misalnya, kartu ini dapat diterapkan pada gambar latar depan kartu dasar atau kartu carousel.

landscapeBackgroundImage

string

Mode lanskap (minimal 1920x1200 piksel). Ini harus ditentukan sebagai referensi ke gambar yang sesuai dalam direktori resources/images/. Misalnya: $resources.images.foo (tanpa ekstensi) untuk gambar di resources/images/foo.jpg Saat mengerjakan project yang diambil dari Konsol, URL terkelola Google yang diambil dapat digunakan.

portraitBackgroundImage

string

Mode potret (minimal 1200x1920 piksel). Ini harus ditentukan sebagai referensi ke gambar yang sesuai dalam direktori resources/images/. Misalnya: $resources.images.foo (tanpa ekstensi) untuk gambar di resources/images/foo.jpg Saat mengerjakan project yang diambil dari Konsol, URL terkelola Google yang diambil dapat digunakan.

ImageCornerStyle

Menjelaskan bagaimana batas gambar harus dirender.

Enum
IMAGE_CORNER_STYLE_UNSPECIFIED Tidak Ditentukan / Tidak Ditentukan.
CURVED Sudut bulat untuk gambar.
ANGLED Sudut persegi panjang untuk gambar.

AccountLinking

AccountLinking memungkinkan Google memandu pengguna untuk login ke layanan web Aplikasi.

Untuk jenis penautan Login dengan Google dan OAuth + Login dengan Google, Google membuat client ID yang mengidentifikasi Aplikasi Anda ke Google ("Client ID yang diterbitkan oleh Google ke Action Anda" di UI Konsol). Kolom ini bersifat hanya baca dan dapat diperiksa dengan membuka halaman Penautan Akun di UI Konsol. Lihat: https://developers.google.com/assistant/identity/google-sign-in

Catatan: Untuk semua jenis setelan penautan akun (kecuali untuk Login dengan Google), Anda harus memberikan nama pengguna dan sandi untuk akun uji coba di Settings.testing_instructions agar tim peninjau dapat meninjau aplikasi (tidak akan terlihat oleh pengguna).

Representasi JSON
{
  "enableAccountCreation": boolean,
  "linkingType": enum (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}
Kolom
enableAccountCreation

boolean

Wajib. Jika true, pengguna akan diizinkan mendaftar akun baru melalui Voice. Jika false, pembuatan akun hanya diizinkan di situs Anda. Pilih opsi ini jika Anda ingin menampilkan persyaratan layanan atau mendapatkan izin pengguna selama pendaftaran. linkingType tidak boleh GOOGLE_SIGN_IN jika nilainya adalah false. linkingType tidak dapat menjadi OAUTH jika nilainya adalah true.

linkingType

enum (LinkingType)

Wajib. Jenis penautan yang akan digunakan. Lihat https://developers.google.com/assistant/identity untuk detail selengkapnya tentang jenis penautan.

authGrantType

enum (AuthGrantType)

Opsional. Menunjukkan jenis autentikasi untuk linkingType OAUTH.

appClientId

string

Opsional. Client-ID yang dikeluarkan oleh Aplikasi Anda kepada Google. Ini adalah Client ID OAuth2 yang mengidentifikasi Google ke layanan Anda. Hanya disetel saat menggunakan OAuth.

authorizationUrl

string

Opsional. Endpoint untuk halaman login Anda yang mendukung kode OAuth2 atau alur implisit. URL harus menggunakan HTTPS. Hanya disetel saat menggunakan OAuth.

tokenUrl

string

Opsional. Endpoint OAuth2 untuk pertukaran token. URL harus menggunakan HTTPS. Kebijakan ini tidak disetel jika hanya menggunakan OAuth dengan pemberian izin IMPLICIT sebagai jenis penautan. Hanya disetel saat menggunakan OAuth.

scopes[]

string

Opsional. Daftar izin yang harus disetujui pengguna untuk menggunakan layanan Anda. Hanya disetel saat menggunakan OAuth. Pastikan untuk memberikan Persyaratan Layanan di informasi direktori di bagian LocalizedSettings.terms_of_service_url jika menentukan kolom ini.

learnMoreUrl

string

Opsional. Ini adalah halaman web di layanan Anda yang menjelaskan izin yang diberikan pengguna kepada Google. Hanya setel jika menggunakan OAuth dan Login dengan Google. Pastikan untuk memberikan Persyaratan Layanan di informasi direktori di bagian LocalizedSettings.terms_of_service_url jika menentukan kolom ini.

useBasicAuthHeader

boolean

Opsional. Jika true (benar), izinkan Google untuk mengirimkan client ID dan rahasia melalui header autentikasi dasar HTTP. Jika tidak, Google akan menggunakan client ID dan rahasia di dalam isi postingan. Hanya disetel saat menggunakan OAuth. Pastikan untuk memberikan Persyaratan Layanan di informasi direktori di bagian LocalizedSettings.terms_of_service_url jika menentukan kolom ini.

LinkingType

Jenis Penautan Akun yang akan dilakukan.

Enum
LINKING_TYPE_UNSPECIFIED Tidak ditentukan.
GOOGLE_SIGN_IN Jenis penautan Login dengan Google. Jika menggunakan jenis penautan ini, kolom terkait OAuth tidak perlu ditetapkan di bawah.
OAUTH_AND_GOOGLE_SIGN_IN Jenis penautan OAuth dan Login dengan Google.
OAUTH Jenis penautan OAuth.

AuthGrantType

Jenis pemberian OAuth2 yang digunakan Google untuk memandu pengguna login ke layanan web Aplikasi Anda.

Enum
AUTH_GRANT_TYPE_UNSPECIFIED Tidak ditentukan.
AUTH_CODE Pemberian kode otorisasi. Mengharuskan Anda memberikan URL autentikasi dan URL token akses.
IMPLICIT Pemberian kode implisit. Hanya mengharuskan Anda memberikan URL autentikasi.

Webhook

Metadata untuk berbagai jenis webhook. Jika Anda menggunakan inlineCloudFunction, kode sumber harus berada dalam direktori yang memiliki nama yang sama dengan nilai untuk kunci executeFunction. Misalnya, nilai my_webhook untuk kunci executeFunction akan memiliki struktur kode seperti ini: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json

Representasi JSON
{
  "handlers": [
    {
      object (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}
Kolom
handlers[]

object (Handler)

Daftar pengendali untuk webhook ini.

Kolom union webhook_type. Hanya satu jenis webhook yang didukung. webhook_type hanya ada berupa salah satu diantara berikut:
httpsEndpoint

object (HttpsEndpoint)

Endpoint HTTPS webhook kustom.

inlineCloudFunction

object (InlineCloudFunction)

Metadata untuk cloud function yang di-deploy dari kode di folder webhook.

Handler

Mendeklarasikan nama pengendali webhoook. Webhook dapat memiliki beberapa pengendali yang terdaftar. Pengendali ini dapat dipanggil dari beberapa tempat dalam project Action Anda.

Representasi JSON
{
  "name": string
}
Kolom
name

string

Wajib. Nama pengendali. Harus unik di semua pengendali project Actions. Anda dapat memeriksa nama pengendali ini untuk memanggil fungsi yang benar dalam kode sumber fulfillment Anda.

HttpsEndpoint

REST endpoint untuk memberi tahu jika Anda tidak menggunakan editor inline.

Representasi JSON
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
Kolom
baseUrl

string

URL dasar HTTPS untuk endpoint fulfillment Anda (HTTP tidak didukung). Nama pengendali ditambahkan ke jalur URL dasar setelah titik dua (dengan mengikuti panduan gaya di https://cloud.google.com/apis/design/custom_methods). Misalnya, URL dasar 'https://gactions.service.com/api' akan menerima permintaan dengan URL 'https://gactions.service.com/api:{method}'.

httpHeaders

map (key: string, value: string)

Peta parameter HTTP yang akan disertakan dalam permintaan POST.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

endpointApiVersion

integer

Versi protokol yang digunakan oleh endpoint. Ini adalah protokol yang digunakan bersama oleh semua jenis fulfillment dan tidak khusus untuk jenis fulfillment Google.

InlineCloudFunction

Menyimpan metadata Cloud Function inline yang di-deploy dari folder webhook.

Representasi JSON
{
  "executeFunction": string
}
Kolom
executeFunction

string

Nama titik entri Cloud Function. Nilai kolom ini harus cocok dengan nama metode yang diekspor dari kode sumber.

Intent

Intent memetakan input pengguna open-ended ke objek terstruktur. Frasa lisan dicocokkan dengan intent dengan Natural Language Understanding (NLU) Google. Kecocokan intent bisa memicu peristiwa di desain percakapan Anda untuk melanjutkan percakapan pengguna. Nama intent ditetapkan dalam nama file.

Representasi JSON
{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}
Kolom
parameters[]

object (IntentParameter)

Daftar parameter dalam frasa pelatihan. Semua parameter harus ditentukan di sini untuk digunakan dalam frasa pelatihan.

trainingPhrases[]

string

Frasa pelatihan memungkinkan NLU Google mencocokkan intent dengan input pengguna secara otomatis. Semakin unik frasa yang diberikan, semakin besar peluang intent ini akan dicocokkan. Berikut adalah format bagian frasa pelatihan yang dianotasi. Perlu diperhatikan bahwa kolom auto bersifat opsional dan perilaku default saat auto tidak ditentukan setara dengan auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true berarti bagian tersebut dianotasi secara otomatis oleh NLU. auto = false berarti bagian tersebut dianotasi oleh pengguna. Ini adalah setelan default saat otomatis tidak ditentukan. Contoh: "Pesan penerbangan dari ($source 'San Francisco' auto=false) ke ($dest 'Vancouver')"

IntentParameter

Definisi parameter yang dapat digunakan di dalam frasa pelatihan.

Representasi JSON
{
  "name": string,

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}
Kolom
name

string

Wajib. Nama unik parameter intent. Dapat digunakan dalam kondisi dan respons terhadap parameter intent referensi yang diekstrak oleh NLU dengan $intent.params.[name].resolved

Kolom union parameter_type. Jenis parameter intent. parameter_type hanya ada berupa salah satu diantara berikut:
type

object (ClassReference)

Opsional. Mendeklarasikan jenis data parameter ini. Ini tidak boleh ditetapkan untuk intent bawaan.

entitySetReferences

object (EntitySetReferences)

Opsional. Referensi ke kumpulan entity yang diizinkan untuk parameter intent ini. Hanya valid untuk parameter intent bawaan. Referensi ini mengarah ke set entity di direktori 'custom/entitySets'.

ClassReference

Referensi ke class yang digunakan untuk mendeklarasikan jenis kolom atau nilai yang ditampilkan. Enum juga merupakan jenis class yang dapat direferensikan menggunakan ClassReference.

Representasi JSON
{
  "name": string,
  "list": boolean
}
Kolom
name

string

Wajib. Nama jenis bawaan atau jenis kustom parameter. Contoh: PizzaToppings, actions.type.Number

list

boolean

Opsional. Menunjukkan apakah jenis data mewakili daftar nilai.

EntitySetReferences

Referensi set entity untuk parameter intent.

Representasi JSON
{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}
Kolom
entitySetReferences[]

object (EntitySetReference)

Wajib. Referensi set entity untuk parameter intent.

EntitySetReference

Referensi ke kumpulan entity yang diizinkan untuk parameter intent ini.

Representasi JSON
{
  "entitySet": string
}
Kolom
entitySet

string

Wajib. Mengidentifikasi kumpulan entity tertentu yang akan dipertimbangkan untuk parameter tertentu. Definisi set entity yang sesuai harus ada di direktori kustom/entitySets/.

Jenis

Deklarasi jenis kustom, bukan jenis bawaan. Jenis dapat ditetapkan ke slot dalam scene atau parameter frasa pelatihan intent. Secara praktis, Jenis dapat dianggap sebagai enum. Catatan, nama jenis ditetapkan dalam nama file.

Representasi JSON
{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}
Kolom
exclusions[]

string

Kumpulan kata/frasa luar biasa yang tidak boleh dicocokkan menurut jenisnya. Catatan: Jika kata/frasa cocok dengan jenis tetapi dicantumkan sebagai pengecualian, kata/frasa ini tidak akan ditampilkan dalam hasil ekstraksi parameter. Kolom ini dapat dilokalkan.

Kolom union sub_type. Pemilihan subjenis berdasarkan jenis pencocokan yang akan dilakukan. sub_type hanya ada berupa salah satu diantara berikut:
synonym

object (SynonymType)

Jenis sinonim, yang pada dasarnya adalah enum.

regularExpression

object (RegularExpressionType)

Jenis ekspresi reguler, memungkinkan pencocokan ekspresi reguler.

freeText

object (FreeTextType)

Jenis FreeText.

SynonymType

Ketik yang mencocokkan teks berdasarkan kumpulan sinonim.

Representasi JSON
{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Kolom
matchType

enum (MatchType)

Opsional. Jenis pencocokan untuk sinonim.

acceptUnknownValues

boolean

Opsional. Jika ditetapkan ke benar (true), parameter ini akan cocok dengan kata atau frasa yang tidak diketahui berdasarkan data pelatihan intent dan input di sekitarnya, seperti item yang mungkin ditambahkan ke daftar belanja.

entities

map (key: string, value: object (Entity))

Wajib. Peta entitas sinonim yang bernama.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

MatchType

Jenis pencocokan yang akan digunakan oleh entri dalam jenis ini. Hal ini akan memastikan semua jenis menggunakan metode pencocokan yang sama dan memungkinkan variasi pencocokan untuk pencocokan sinonim (yaitu fuzzy versus tepat). Jika nilainya UNSPECIFIED, nilai tersebut akan ditetapkan secara default ke EXACT_MATCH.

Enum
UNSPECIFIED Default-nya adalah EXACT_MATCH.
EXACT_MATCH Mencari sinonim atau nama yang sama persis.
FUZZY_MATCH Lebih longgar dari EXACT_MATCH. Mencari kecocokan yang serupa serta pencocokan persis.

Entitas

Mewakili kolom entity sinonim yang berisi detail satu entri dalam jenis.

Representasi JSON
{
  "display": {
    object (EntityDisplay)
  },
  "synonyms": [
    string
  ]
}
Kolom
display

object (EntityDisplay)

Opsional. Detail tampilan entitas.

synonyms[]

string

Opsional. Daftar sinonim untuk entity. Kolom ini dapat dilokalkan.

EntityDisplay

Elemen yang akan ditampilkan di kanvas setelah entity jenis tertentu diekstrak dari kueri. Hanya relevan untuk aplikasi yang mendukung kanvas. Pesan ini dapat dilokalkan.

Representasi JSON
{
  "iconTitle": string,
  "iconUrl": string
}
Kolom
iconTitle

string

Opsional. Judul ikon.

iconUrl

string

Wajib. URL ikon.

RegularExpressionType

Ketik yang mencocokkan teks menurut ekspresi reguler. Pesan ini dapat dilokalkan.

Representasi JSON
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Kolom
entities

map (key: string, value: object (Entity))

Wajib. Peta entity bernama yang masing-masing berisi string Regex.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Entitas

Mewakili objek entity yang berisi ekspresi reguler yang digunakan untuk perbandingan.

Representasi JSON
{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}
Kolom
display

object (EntityDisplay)

Opsional. Elemen yang akan ditampilkan di kanvas setelah entity diekstrak dari kueri. Hanya relevan untuk aplikasi yang mendukung kanvas.

regularExpressions[]

string

Wajib. Menggunakan sintaksis ekspresi reguler RE2 (Lihat https://github.com/google/re2/wiki/Syntax untuk detail selengkapnya)

FreeTextType

Ketik yang cocok dengan teks apa pun jika konteks kata-kata di sekitarnya dekat dengan contoh pelatihan yang diberikan.

Representasi JSON
{
  "display": {
    object (EntityDisplay)
  }
}
Kolom
display

object (EntityDisplay)

Opsional. Elemen yang akan ditampilkan di kanvas setelah entity diekstrak dari kueri. Hanya relevan untuk aplikasi yang mendukung kanvas.

EntitySet

Set entity menjelaskan kumpulan entity yang telah ditetapkan sebelumnya yang dapat menjadi sumber nilai parameter intent bawaan. Set entity dapat direferensikan dari entitySet dalam parameter intent bawaan.

Representasi JSON
{
  "entities": [
    {
      object (Entity)
    }
  ]
}
Kolom
entities[]

object (Entity)

Wajib. Daftar entity yang didukung set entity ini.

Entitas

Entity tempat nilai parameter intent bawaan dapat berasal.

Representasi JSON
{
  "id": string
}
Kolom
id

string

Wajib. ID entitas. Untuk mengetahui daftar parameter intent bawaan dan entity yang didukungnya, lihat https://developers.google.com/assistant/conversational/build/built-in-intents

GlobalIntentEvent

Mendefinisikan pengendali intent global. Peristiwa intent global dicakupkan ke seluruh project Action dan dapat diganti oleh pengendali intent dalam scene. Nama intent harus unik dalam project Action.

Intent global dapat dicocokkan kapan saja selama sesi, yang memungkinkan pengguna mengakses alur umum seperti "dapatkan bantuan" atau "kembali ke beranda". Metode ini juga dapat digunakan untuk memberikan deep link kepada pengguna ke alur tertentu saat mereka memanggil Action.

Perhatikan, nama intent ditetapkan dalam nama file.

Representasi JSON
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Kolom
transitionToScene

string

Opsional. Adegan tujuan tempat percakapan akan dimulai. Status scene saat ini dihancurkan saat transisi.

handler

object (EventHandler)

Opsional. Pengendali peristiwa yang dipicu saat intent cocok. Harus dijalankan sebelum beralih ke scene tujuan. Berguna untuk menghasilkan Prompt sebagai respons terhadap peristiwa.

EventHandler

Mendefinisikan pengendali yang akan dijalankan setelah suatu peristiwa. Contoh peristiwa adalah peristiwa berbasis intent dan kondisi dalam scene.

Representasi JSON
{
  "webhookHandler": string,

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}
Kolom
webhookHandler

string

Nama pengendali webhook yang akan dipanggil.

Kolom union prompt. Perintah dapat disisipkan atau direferensikan dengan nama. prompt hanya ada berupa salah satu diantara berikut:
staticPrompt

object (StaticPrompt)

Dialog statis inline. Dapat berisi referensi ke resource string dalam paket.

staticPromptName

string

Nama perintah statis yang akan dipanggil.

StaticPrompt

Mewakili daftar kandidat perintah, salah satunya akan dipilih sebagai perintah yang akan ditampilkan dalam respons kepada pengguna. Pesan ini dapat dilokalkan.

Representasi JSON
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Kolom
candidates[]

object (StaticPromptCandidate)

Daftar perintah kandidat yang akan dikirim ke klien. Setiap dialog memiliki pemilih untuk menentukan kapan dapat digunakan. Pemilih pertama yang cocok dengan permintaan akan dikirim dan pemilih lainnya akan diabaikan.

StaticPromptCandidate

Mewakili kandidat perintah statis.

Representasi JSON
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Kolom
selector

object (Selector)

Opsional. Kriteria apakah dialog ini cocok dengan permintaan. Jika pemilih kosong, permintaan ini akan selalu dipicu.

promptResponse

object (StaticPromptResponse)

Respons cepat yang terkait dengan pemilih.

Pemilih

Menentukan kriteria apakah dialog cocok dengan permintaan.

Representasi JSON
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Kolom
surfaceCapabilities

object (SurfaceCapabilities)

Kumpulan kemampuan platform yang diperlukan.

SurfaceCapabilities

Menampilkan platform yang digunakan pengguna untuk membuat permintaan ke Action.

Representasi JSON
{
  "capabilities": [
    enum (Capability)
  ]
}
Kolom
capabilities[]

enum (Capability)

Wajib. Kemampuan platform yang membuat permintaan ke Action.

Kemampuan

Kemampuan yang didukung platform perangkat pada saat permintaan.

Enum
UNSPECIFIED Kemampuan permukaan tidak ditentukan.
SPEECH Perangkat dapat berbicara dengan pengguna melalui text-to-speech atau SSML.
RICH_RESPONSE Perangkat dapat menampilkan respons lengkap seperti kartu, daftar, dan tabel.
LONG_FORM_AUDIO Perangkat dapat memutar media audio berdurasi panjang seperti musik dan podcast.
INTERACTIVE_CANVAS Perangkat dapat menampilkan respons kanvas interaktif.
HOME_STORAGE Perangkat dapat mendukung penyimpanan dan pengambilan penyimpanan rumah.

StaticPromptResponse

Menampilkan respons terstruktur untuk dikirim kepada pengguna, seperti teks, ucapan, kartu, data kanvas, chip saran, dll.

Representasi JSON
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
Kolom
firstSimple

object (StaticSimplePrompt)

Opsional. Respons pertama yang hanya berisi teks dan suara.

content

object (StaticContentPrompt)

Opsional. Konten seperti kartu, daftar, atau media yang akan ditampilkan kepada pengguna.

lastSimple

object (StaticSimplePrompt)

Opsional. Respons terakhir yang hanya berupa teks dan suara.

suggestions[]

object (Suggestion)

Opsional. Saran yang akan ditampilkan kepada pengguna yang akan selalu muncul di akhir respons. Jika kolom append di perintah yang memuatnya adalah true, judul yang ditentukan di kolom ini akan ditambahkan ke judul yang ditentukan dalam perintah saran yang ditentukan sebelumnya dan nilai duplikat akan dihapus.

override

boolean

Opsional. Mode penggabungan pesan ini dengan pesan yang telah ditentukan sebelumnya. true akan menghapus semua pesan yang ditentukan sebelumnya (pertama dan terakhir, konten, link saran, dan kanvas) serta menambahkan pesan yang ditentukan dalam perintah ini. false akan menambahkan pesan yang ditentukan dalam permintaan ini ke pesan yang ditentukan dalam respons sebelumnya. Jika kolom ini ditetapkan ke false, Anda juga akan dapat menambahkan ke beberapa kolom di dalam perintah Sederhana, perintah Saran, dan perintah Canvas (bagian dari perintah Konten). Pesan Content dan Link akan selalu ditimpa jika ditentukan dalam perintah. Nilai defaultnya adalah false.

canvas

object (StaticCanvasPrompt)

Respons yang akan digunakan untuk pengalaman kanvas interaktif.

StaticSimplePrompt

Menampilkan perintah sederhana yang akan dikirim ke pengguna.

Representasi JSON
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Kolom
variants[]

object (Variant)

Daftar kemungkinan varian.

Varian

Menampilkan varian yang merupakan bagian dari prompt sederhana.

Representasi JSON
{
  "speech": string,
  "text": string
}
Kolom
speech

string

Opsional. Merepresentasikan ucapan yang akan diucapkan kepada pengguna. Dapat berupa SSML atau text to speech. Secara default, ucapan akan ditambahkan ke ucapan perintah Sederhana sebelumnya. Jika kolom override dalam perintah yang memuatnya adalah true, ucapan yang ditentukan dalam kolom ini akan menggantikan ucapan perintah Sederhana sebelumnya.

text

string

Opsional. Teks yang akan ditampilkan dalam balon chat. Jika tidak diberikan, rendering tampilan untuk kolom ucapan di atas akan digunakan. Dibatasi hingga 640 karakter. Secara default, teks akan ditambahkan ke teks Simple prompt sebelumnya. Jika kolom override dalam prompt yang memuatnya adalah true, teks yang ditentukan dalam kolom ini akan menggantikan teks prompt Sederhana sebelumnya.

StaticContentPrompt

Placeholder untuk bagian Content pada StaticPrompt.

Representasi JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}
Kolom
Kolom union content. Hanya satu jenis konten yang boleh ada di Perintah. content hanya ada berupa salah satu diantara berikut:
card

object (StaticCardPrompt)

Kartu dasar.

image

object (StaticImagePrompt)

Gambar.

table

object (StaticTablePrompt)

Kartu tabel.

media

object (StaticMediaPrompt)

Respons yang menunjukkan sekumpulan media yang akan diputar.

list

object (StaticListPrompt)

Kartu untuk menampilkan daftar opsi yang dapat dipilih.

collection

object (StaticCollectionPrompt)

Kartu yang menampilkan daftar opsi untuk dipilih.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Kartu yang menampilkan kumpulan halaman web yang akan dibuka.

StaticCardPrompt

Kartu dasar untuk menampilkan beberapa informasi, misalnya gambar dan/atau teks.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
Kolom
title

string

Opsional. Judul kartu secara keseluruhan.

subtitle

string

Opsional. Subtitel kartu.

text

string

Wajib. Teks isi kartu yang diperlukan kecuali ada gambar. Mendukung serangkaian sintaksis markdown terbatas untuk pemformatan.

image

object (StaticImagePrompt)

Opsional. Banner besar untuk kartu. Tingginya ditetapkan ke 192 dp.

imageFill

enum (ImageFill)

Opsional. Cara mengisi latar belakang gambar.

button

object (StaticLinkPrompt)

Opsional. Tombol yang dapat diklik untuk ditampilkan di Kartu.

StaticImagePrompt

Gambar yang ditampilkan di kartu.

Representasi JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Kolom
url

string

Wajib. URL sumber gambar. Gambar dapat berupa JPG, PNG, dan GIF (animasi dan non-animasi). Misalnya,https://www.agentx.com/logo.png.

alt

string

Wajib. Deskripsi teks dari gambar yang akan digunakan untuk aksesibilitas, misalnya pembaca layar.

height

integer

Opsional. Tinggi gambar dalam piksel.

width

integer

Opsional. Lebar gambar dalam piksel.

ImageFill

Kemungkinan opsi tampilan gambar untuk memengaruhi penyajian gambar. Ini harus digunakan saat rasio aspek gambar tidak cocok dengan rasio aspek penampung gambar.

Enum
UNSPECIFIED ImageFill tidak ditentukan.
GRAY Isi celah antara gambar dan penampung gambar dengan batang abu-abu.
WHITE Isi celah antara gambar dan penampung gambar dengan batang putih.
CROPPED Gambar diskalakan sedemikian rupa sehingga lebar dan tinggi gambar sesuai atau melebihi dimensi penampung. Tindakan ini dapat memangkas bagian atas dan bawah gambar jika tinggi gambar yang diskalakan lebih besar dari tinggi penampung, atau memangkas bagian kiri dan kanan gambar jika lebar gambar yang diskalakan lebih besar dari lebar penampung. Ini mirip dengan "Mode Zoom" di TV layar lebar saat memutar video 4:3.

StaticLinkPrompt

Menentukan link yang akan ditampilkan sebagai chip saran dan dapat dibuka oleh pengguna.

Representasi JSON
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
Kolom
name

string

Nama link

open

object (OpenUrl)

Menentukan perilaku saat pengguna membuka link.

OpenUrl

Menentukan perilaku saat pengguna membuka link.

Representasi JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
Kolom
url

string

Kolom URL yang dapat berupa salah satu dari: - URL http/https untuk membuka Aplikasi atau halaman web yang ditautkan ke Aplikasi

hint

enum (UrlHint)

Menunjukkan petunjuk untuk jenis URL.

UrlHint

Berbagai jenis petunjuk URL.

Enum
HINT_UNSPECIFIED Belum ditetapkan
AMP URL yang mengarah langsung ke konten AMP, atau ke URL kanonis yang merujuk ke konten AMP melalui <link rel="amphtml">.

StaticTablePrompt

Kartu tabel untuk menampilkan tabel teks.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}
Kolom
title

string

Opsional. Judul tabel secara keseluruhan. Harus disetel jika subtitel sudah disetel.

subtitle

string

Opsional. Subtitel untuk tabel.

image

object (StaticImagePrompt)

Opsional. Gambar yang terkait dengan tabel.

columns[]

object (TableColumn)

Opsional. Header dan perataan kolom.

rows[]

object (TableRow)

Opsional. 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 halaman web yang memiliki lebih banyak data.

button

object (StaticLinkPrompt)

Opsional. Tombol.

TableColumn

Menjelaskan kolom dalam tabel.

Representasi JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Kolom
header

string

Teks header untuk kolom.

align

enum (HorizontalAlignment)

Perataan horizontal kolom konten. Jika tidak ditentukan, konten akan disejajarkan dengan tepi depan.

HorizontalAlignment

Perataan konten dalam sel.

Enum
UNSPECIFIED HorizontalAlignment tidak ditentukan.
LEADING Tepi depan sel. Ini adalah defaultnya.
CENTER Konten sejajar dengan bagian tengah kolom.
TRAILING Konten disejajarkan dengan tepi akhir kolom.

TableRow

Menjelaskan baris dalam tabel.

Representasi JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Kolom
cells[]

object (TableCell)

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.

divider

boolean

Menunjukkan apakah harus ada pemisah setelah setiap baris.

TableCell

Menjelaskan sel secara berurutan.

Representasi JSON
{
  "text": string
}
Kolom
text

string

Konten teks di sel.

StaticMediaPrompt

Berisi informasi tentang media, seperti nama, deskripsi, URL, dll. ID berikutnya: 11

Representasi JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode)
}
Kolom
mediaType

enum (MediaType)

Jenis media respons ini.

startOffset

string (Duration format)

Offset awal objek media pertama.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Jenis kontrol media opsional yang dapat didukung sesi respons media ini. Jika ditetapkan, permintaan akan dibuat ke pihak ketiga saat peristiwa media tertentu terjadi. Jika tidak disetel, 3p masih harus menangani dua jenis kontrol default, FINISHED dan FAILED.

mediaObjects[]

object (MediaObject)

Daftar objek media.

repeatMode

enum (RepeatMode)

Mode berulang untuk daftar Objek Media.

MediaType

Jenis media respons ini.

Enum
MEDIA_TYPE_UNSPECIFIED Nilai UNSPECIFIED
AUDIO File audio.
MEDIA_STATUS_ACK Respons untuk mengonfirmasi laporan status media.

OptionalMediaControls

Jenis kontrol media yang dapat didukung respons media secara opsional

Enum
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Nilai belum ditetapkan
PAUSED Acara dijeda. Dipicu saat pengguna menjeda media.
STOPPED Acara yang dihentikan. Dipicu saat pengguna keluar dari sesi 3p selama pemutaran media.

MediaObject

Mewakili satu objek media.

Representasi JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Kolom
name

string

Nama objek media ini.

description

string

Deskripsi objek media ini.

url

string

URL yang mengarah ke konten media.

image

object (MediaImage)

Gambar yang akan ditampilkan dengan kartu media.

MediaImage

Gambar yang akan ditampilkan di dalam MediaPrompt.

Representasi JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
Kolom
Kolom union image. Hanya satu jenis MediaImage yang diizinkan. image hanya ada berupa salah satu diantara berikut:
large

object (StaticImagePrompt)

Gambar besar, seperti sampul album, dll.

icon

object (StaticImagePrompt)

Ikon gambar kecil ditampilkan di sebelah kanan dari judul. Ukurannya diubah menjadi 36x36 dp.

RepeatMode

Jenis mode berulang untuk daftar objek media.

Enum
REPEAT_MODE_UNSPECIFIED Setara dengan NONAKTIF.
OFF Mengakhiri sesi media di akhir objek media terakhir.
ALL Melakukan loop ke awal objek media pertama saat akhir objek media terakhir tercapai.

StaticListPrompt

Kartu untuk menampilkan daftar opsi yang dapat dipilih.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Kolom
title

string

Opsional. Judul daftar.

subtitle

string

Opsional. Subtitel daftar.

items[]

object (ListItem)

Wajib. Daftar item.

ListItem

Item dalam daftar.

Representasi JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Kolom
key

string

Wajib. Kunci NLU yang cocok dengan nama kunci entri dalam jenis terkait. Saat item diketuk, kunci ini akan diposting kembali sebagai parameter opsi pilih.

title

string

Wajib. Judul item. Saat diketuk, teks ini akan diposting kembali ke percakapan kata demi kata seolah-olah pengguna telah mengetiknya. Setiap judul harus unik di antara kumpulan item.

description

string

Opsional. Teks isi item.

image

object (StaticImagePrompt)

Opsional. Gambar item.

StaticCollectionPrompt

Kartu untuk menampilkan kumpulan opsi yang dapat dipilih.

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Kolom
title

string

Opsional. Judul koleksi.

subtitle

string

Opsional. Subtitel koleksi.

items[]

object (CollectionItem)

Wajib. Item koleksi.

imageFill

enum (ImageFill)

Opsional. Jenis opsi tampilan gambar.

CollectionItem

Item dalam koleksi.

Representasi JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Kolom
key

string

Wajib. Kunci NLU yang cocok dengan nama kunci entri dalam Jenis terkait. Saat item diketuk, kunci ini akan diposting kembali sebagai parameter opsi pilih.

title

string

Wajib. Judul item. Saat diketuk, teks ini akan diposting kembali ke percakapan kata demi kata seolah-olah pengguna telah mengetiknya. Setiap judul harus unik di antara kumpulan item.

description

string

Opsional. Teks isi item.

image

object (StaticImagePrompt)

Opsional. Gambar item.

StaticCollectionBrowsePrompt

Menampilkan kumpulan dokumen web sebagai koleksi item kartu berukuran besar. Item dapat dipilih untuk meluncurkan dokumen web yang terkait di penampil web.

Representasi JSON
{
  "items": [
    {
      object (CollectionBrowseItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Kolom
items[]

object (CollectionBrowseItem)

Item dalam koleksi jelajahi. Ukuran daftar harus dalam rentang [2, 10].

imageFill

enum (ImageFill)

Opsi tampilan gambar untuk gambar dalam koleksi.

CollectionBrowseItem

Item dalam koleksi.

Representasi JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (StaticImagePrompt)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
Kolom
title

string

Wajib. Judul item koleksi.

description

string

Deskripsi item koleksi.

footer

string

Teks footer untuk item koleksi, yang ditampilkan di bawah deskripsi. Satu baris teks, terpotong dengan elipsis.

image

object (StaticImagePrompt)

Gambar untuk item koleksi.

openUriAction

object (OpenUrl)

Wajib. URI yang akan dibuka jika item dipilih.

Saran

Mewakili chip saran, elemen UI yang ditampilkan kepada pengguna untuk kenyamanan.

Representasi JSON
{
  "title": string
}
Kolom
title

string

Wajib. Teks yang ditampilkan di 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. Maks 25 karakter

StaticCanvasPrompt

Mewakili respons Canvas Interaktif untuk dikirim ke pengguna. Ini dapat digunakan bersama dengan kolom firstSimple dalam perintah yang berisi untuk berbicara dengan pengguna selain menampilkan respons kanvas interaktif.

Representasi JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}
Kolom
url

string

Wajib. URL tampilan web yang akan dimuat.

data[]

value (Value format)

Opsional. Data JSON yang akan diteruskan ke halaman web pengalaman imersif sebagai peristiwa. Jika kolom override di perintah yang memuatnya adalah nilai data false yang ditentukan dalam perintah Canvas ini akan ditambahkan setelah nilai data yang ditentukan dalam perintah Canvas sebelumnya.

suppressMic

boolean

Opsional. Nilai sebenarnya berarti mikrofon tidak akan dibuka untuk menangkap input setelah respons imersif ini ditampilkan kepada pengguna.

sendStateDataToCanvasApp

boolean

Opsional. Jika true, metadata terkait percakapan akan disertakan dan dikirim kembali ke aplikasi kanvas.

enableFullScreen

boolean

Opsional. Jika true, aplikasi kanvas akan menempati layar penuh dan tidak akan memiliki header di bagian atas. Pesan toast juga akan ditampilkan di layar pemuatan yang menyertakan nama tampilan Action, nama developer, dan petunjuk untuk keluar dari Action. Nilai default: false.

Suasana

Scene adalah unit dasar dari alur kontrol saat mendesain percakapan. Mereka dapat dirantai bersama dengan scene lain, menghasilkan prompt untuk pengguna akhir, dan menentukan slot. Nama scene ditentukan dalam nama file.

Representasi JSON
{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}
Kolom
onEnter

object (EventHandler)

Pengendali yang akan dipanggil saat bertransisi ke scene ini.

intentEvents[]

object (IntentEvent)

Daftar peristiwa yang dipicu berdasarkan intent. Peristiwa ini dapat dipicu kapan saja setelah Pengendali on_load dipanggil. Penting - peristiwa ini menentukan kumpulan intent yang dicakupkan ke scene ini dan akan lebih diutamakan daripada peristiwa yang didefinisikan secara global yang memiliki intent yang sama atau frasa pemicunya. Nama intent harus unik dalam scene.

conditionalEvents[]

object (ConditionalEvent)

Daftar peristiwa yang akan dipicu berdasarkan pernyataan kondisional. Ini dievaluasi setelah formulir diisi atau segera setelah on_load jika scene ini tidak memiliki formulir (evaluasi hanya dilakukan sekali). Hanya peristiwa pertama yang cocok yang akan dipicu.

slots[]

object (Slot)

Daftar slot yang diurutkan. Setiap slot menentukan jenis data yang akan diselesaikan dan konfigurasinya untuk menyesuaikan pengalaman resolusi ini (misalnya perintah).

onSlotUpdated

object (EventHandler)

Pengendali dipanggil saat ada perubahan status slot yang tidak disebabkan oleh update dalam Pengendali lain. Hal ini memungkinkan slot menjadi tidak valid, scene menjadi tidak valid, atau perubahan lain pada status scene.

IntentEvent

Mendaftarkan Peristiwa yang dipicu sebagai hasil dari pencocokan intent.

Representasi JSON
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Kolom
intent

string

Wajib. Intent yang memicu peristiwa.

transitionToScene

string

Opsional. Adegan tujuan tempat percakapan akan dimulai. Status scene saat ini dihancurkan saat transisi.

handler

object (EventHandler)

Opsional. Pengendali peristiwa yang dipicu saat intent cocok. Harus dijalankan sebelum beralih ke scene tujuan. Berguna untuk menghasilkan prompt sebagai respons terhadap peristiwa.

ConditionalEvent

Mendaftarkan peristiwa yang dipicu sebagai hasil dari kondisi yang benar.

Representasi JSON
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Kolom
condition

string

Wajib. Filter kondisi untuk peristiwa ini yang akan dipicu. Jika kondisi dievaluasi ke benar (true), handler terkait akan dipicu. Referensi variabel berikut didukung: $session - Untuk mereferensikan data dalam penyimpanan sesi. $user - Untuk mereferensikan data di penyimpanan pengguna. Operator boolean berikut didukung (dengan contoh): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) Perbandingan berikut didukung: ==, !=, <, >, <=, >= Daftar dan operator string berikut ini didukung (dengan contoh): in - "Watermelon" in session.params.fruitList size - size(session.params.fruitList) > 2 session.params.fullName.contains("John") - size(session.params.fruitList) > 2 session.params.fullName.contains("John")substring

transitionToScene

string

Opsional. Suasana tujuan tempat percakapan akan melompat saat kondisi terkait dievaluasi ke benar (true). Status scene saat ini dihancurkan saat transisi.

handler

object (EventHandler)

Opsional. Pengendali peristiwa yang dipicu saat kondisi terkait dievaluasi ke true. Harus dijalankan sebelum beralih ke scene tujuan. Berguna untuk menghasilkan Prompt sebagai respons terhadap peristiwa.

Slot

Konfigurasi untuk slot. Slot adalah unit tunggal data yang dapat diisi melalui bahasa alami (yaitu parameter intent), parameter sesi, dan sumber lainnya.

Representasi JSON
{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}
Kolom
name

string

Wajib. Nama slot.

type

object (ClassReference)

Wajib. Mendeklarasikan jenis data slot ini.

required

boolean

Opsional. Menunjukkan apakah slot harus diisi sebelum melanjutkan. Slot wajib yang tidak diisi akan memicu dialog yang dapat disesuaikan kepada pengguna.

promptSettings

object (PromptSettings)

Opsional. Mendaftarkan Permintaan untuk berbagai tahap pengisian slot.

commitBehavior

object (CommitBehavior)

Opsional. Perilaku commit yang terkait dengan slot.

config

value (Value format)

Opsional. Konfigurasi tambahan terkait dengan slot yang digunakan untuk mengisi slot. Format konfigurasi bersifat khusus untuk jenis slot. Referensi resource ke parameter sesi atau pengguna dapat ditambahkan ke konfigurasi ini. Konfigurasi ini diperlukan untuk mengisi slot yang terkait dengan transaksi dan engagement pengguna.

Contoh: Untuk slot jenis actions.type.CompletePurchaseValue, konfigurasi berikut mengusulkan urutan produk digital dengan referensi ke parameter sesi yang ditentukan klien userSelectedSkuId:

{ "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } }

defaultValue

object (DefaultValue)

Opsional. Konfigurasi untuk mengisi nilai default untuk slot ini.

PromptSettings

Satu tempat di mana perintah slot ditentukan.

Representasi JSON
{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}
Kolom
initialPrompt

object (EventHandler)

Minta nilai slot itu sendiri. Contoh: "Berapa ukuran yang Anda inginkan?"

noMatchPrompt1

object (EventHandler)

Perintah untuk diberikan saat input pengguna tidak cocok dengan jenis nilai yang diharapkan untuk slot untuk pertama kalinya. Contoh: "Maaf, saya tidak mengerti".

noMatchPrompt2

object (EventHandler)

Perintah untuk diberikan saat input pengguna tidak cocok dengan jenis nilai yang diharapkan untuk slot untuk kedua kalinya. Contoh: "Maaf, saya tidak mengerti".

noMatchFinalPrompt

object (EventHandler)

Perintah untuk diberikan saat input pengguna tidak cocok dengan jenis nilai yang diharapkan untuk slot untuk terakhir kalinya. Contoh: "Maaf, saya tidak mengerti".

noInputPrompt1

object (EventHandler)

Perintah untuk memberi saat pengguna tidak memberikan input untuk pertama kalinya. Contoh: "Maaf, saya tidak mengerti".

noInputPrompt2

object (EventHandler)

Perintah untuk memberi saat pengguna tidak memberikan input untuk kedua kalinya. Contoh: "Maaf, saya tidak mengerti".

noInputFinalPrompt

object (EventHandler)

Perintah untuk memberi izin saat pengguna tidak memberikan input untuk terakhir kalinya. Contoh: "Maaf, saya tidak mengerti".

CommitBehavior

Pesan yang menjelaskan perilaku commit yang terkait dengan slot setelah berhasil diisi.

Representasi JSON
{
  "writeSessionParam": string
}
Kolom
writeSessionParam

string

Parameter sesi yang akan menulis nilai slot setelah diisi. Perhatikan bahwa jalur bertingkat saat ini tidak didukung. "$$" digunakan untuk menulis nilai slot ke parameter sesi yang memiliki nama yang sama dengan slot. Misalnya: writeSessionParam = "fruit" sesuai dengan "$session.params.fruit". writeSessionParam = "ticket" sesuai dengan "$session.params.ticket".

DefaultValue

Konfigurasi untuk mengisi nilai default untuk slot ini.

Representasi JSON
{
  "sessionParam": string,
  "constant": value
}
Kolom
sessionParam

string

Opsional. Parameter sesi yang akan digunakan untuk melakukan inisialisasi nilai slot, jika memiliki nilai yang tidak kosong. Jenis nilai harus cocok dengan jenis slot. Perhatikan bahwa jalur bertingkat saat ini tidak didukung. Misalnya: sessionParam = "fruit" sesuai dengan $session.params.fruit. sessionParam = "ticket" sesuai dengan $session.params.ticket.

constant

value (Value format)

Opsional. Nilai default konstan untuk slot. Ini hanya akan digunakan jika nilai untuk slot ini tidak diisi melalui sessionParam. Jenis untuk nilai ini harus cocok dengan jenis slot.

DataFiles

Wrapper untuk file data berulang. Kolom berulang tidak boleh ada di salah satu dari kolom tersebut.

Representasi JSON
{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}
Kolom
dataFiles[]

object (DataFile)

Beberapa file data.

DataFile

Menampilkan satu file yang berisi data tidak terstruktur. Contohnya mencakup file gambar, file audio, dan kode sumber fungsi cloud.

Representasi JSON
{
  "filePath": string,
  "contentType": string,
  "payload": string
}
Kolom
filePath

string

Jalur relatif file data dari root project dalam struktur file SDK. Jalur file yang diizinkan: - Gambar: resources/images/{multiple directories}?/{ImageName}.{extension} - Audio: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - Kode Fungsi Cloud Inline: webhooks/{WebhookName}.zip Ekstensi yang diizinkan: - Gambar: png, jpg, jpeg - Audio: mp3, mpeg - Fungsi Cloud Inline: zip

contentType

string

Wajib. Jenis konten aset ini. Contoh: text/html. Jenis konten harus mematuhi spesifikasi (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). Fungsi cloud harus dalam format zip dan jenis kontennya harus application/zip;zip_type=cloud_function. Parameter zip_type menunjukkan bahwa zip tersebut ditujukan untuk fungsi cloud.

payload

string (bytes format)

Konten file data. Contohnya adalah byte mentah yang berisi gambar, file audio, atau format zip cloud function. Ada batas ketat 10 MB untuk ukuran payload.

String berenkode base64.