Resource: Agen
Entitas percakapan yang mewakili brand.
Representasi JSON |
---|
{ "name": string, "displayName": string, // Union field |
Kolom | |
---|---|
name |
ID unik agen. Hanya baca. Ditentukan oleh platform. |
displayName |
Wajib. Nama yang ditampilkan agen kepada pengguna. Maksimum 100 karakter. Tidak dapat diubah setelah verifikasi agen. |
Kolom union Wajib. |
|
businessMessagesAgent |
Informasi agen mendetail untuk Business Messages. |
BusinessMessagesAgent
Informasi agen khusus untuk Business Messages.
Representasi JSON |
---|
{ "logoUrl": string, "entryPointConfigs": [ { object ( |
Kolom | |
---|---|
logoUrl |
Opsional. URL logo yang tersedia secara publik untuk agen. Maksimum 50 KB. Tidak dapat diubah setelah verifikasi agen. |
entryPointConfigs[] |
Opsional. Daftar konfigurasi titik entri. Tidak dapat diubah setelah verifikasi agen. |
conversationalSettings |
Wajib. Setelan percakapan untuk agen, dipetakan ke lokal. Lokalitas direpresentasikan oleh tag bahasa IETF BCP 47 yang diformat dengan baik. Objek yang berisi daftar pasangan |
defaultLocale |
Wajib. Lokalitas default untuk agen. Harus cocok dengan lokalitas yang ditentukan di |
primaryAgentInteraction |
Wajib. Informasi interaksi agen utama. Digunakan saat pengguna memulai percakapan. |
additionalAgentInteractions[] |
Opsional. Informasi interaksi agen tambahan. Memungkinkan agen mendukung beberapa jenis interaksi. |
customAgentId |
Opsional. ID yang ditentukan partner untuk agen. ID diteruskan bersama semua pesan yang dikirim ke agen. |
agentTestUrl |
Hanya output. URL untuk menguji pengalaman percakapan agen. Ditentukan oleh platform. |
testUrls[] |
Hanya output. URL untuk menguji pengalaman percakapan agen. Ditentukan oleh platform. |
phone |
Opsional. Nomor telepon yang akan ditampilkan oleh agen. Jika tidak ditentukan, agen akan menampilkan nomor telepon untuk merek yang ditemukan dalam Pustaka Pengetahuan Google, jika ada. |
authorizationConfig |
Opsional. Konfigurasi otorisasi untuk dukungan OAuth. |
nonLocalConfig |
Opsional. Konfigurasi untuk titik entri non-lokal. |
surveyConfig |
Opsional. Konfigurasi untuk mengaktifkan survei kustom. |
BusinessMessagesEntryPointConfig
Konfigurasi titik entri untuk agen.
Representasi JSON |
---|
{
"allowedEntryPoint": enum ( |
Kolom | |
---|---|
allowedEntryPoint |
Wajib. Google memunculkan agen tempat agen dapat ditampilkan. |
EntryPoint
Google memunculkan agen tempat agen dapat ditampilkan.
Enum | |
---|---|
ENTRY_POINT_UNSPECIFIED |
Titik entri tidak ditentukan. |
LOCATION |
Aktifkan lokasi untuk agen ini. |
NON_LOCAL |
Aktifkan Business Messages untuk titik entri non-lokal. |
SupportedAgentInteraction
Interaksi yang didukung oleh agen.
Representasi JSON |
---|
{ "interactionType": enum ( |
Kolom | |
---|---|
interactionType |
Wajib. Jenis interaksi yang didukung oleh agen. |
Kolom union representative . Info terperinci untuk jenis konfigurasi. Wajib. representative hanya ada berupa salah satu diantara berikut: |
|
botRepresentative |
Detail perwakilan bot. |
humanRepresentative |
Detail perwakilan manusia. |
InteractionType
Jenis interaksi yang didukung untuk agen.
Enum | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Interaksi tidak ditentukan. |
BOT |
Interaksi bot. |
HUMAN |
Interaksi manusia. |
BotRepresentative
Detail untuk perwakilan bot.
Representasi JSON |
---|
{
"botMessagingAvailability": {
object ( |
Kolom | |
---|---|
botMessagingAvailability |
Wajib. Ketersediaan fitur pesan bot. |
MessagingAvailability
Jam tersedianya fitur pesan. Anda dapat mengelompokkan jam buka selama beberapa hari. Misalnya, * 08.00–16.00 PDT Senin–Rabu * 10.00–14.00 PDT Kamis–Jumat * 15.00–18.00 PDT Kamis–Jumat * 10.00–14.00 PDT Sabtu–Sabtu
Jika ada kesenjangan ketersediaan, seperti tidak ada ketersediaan yang ditentukan pada hari Minggu, pesan tidak akan tersedia selama selisih tersebut.
Jam bot tidak berpengaruh pada ketersediaan. Agen khusus bot selalu menampilkan pesan selamat datang, sedangkan agen dengan setelan perwakilan manusia dan bot hanya mempertimbangkan perwakilan manusia saat menentukan ketersediaan.
Representasi JSON |
---|
{
"hours": [
{
object ( |
Kolom | |
---|---|
hours[] |
Wajib. Jam ketersediaan fitur pesan. |
Jam
Rentang jam saat fitur pesan tersedia.
Representasi JSON |
---|
{ "startTime": { object ( |
Kolom | |
---|---|
startTime |
Wajib. Waktu mulai untuk setiap hari dalam rentang hari. |
endTime |
Wajib. Waktu berakhir untuk setiap hari dalam rentang hari. |
timeZone |
Wajib. Zona waktu IANA untuk jam. Misalnya, "Amerika/Los_Angeles". |
startDay |
Wajib. Hari mulai. |
endDay |
Wajib. Hari akhir. Menyertakan hari yang ditentukan. |
TimeOfDay
Mewakili waktu. Tanggal dan zona waktu tidak signifikan atau ditentukan di tempat lain. API dapat memilih untuk mengizinkan detik kabisat. Jenis terkait adalah google.type.Date
dan google.protobuf.Timestamp
.
Representasi JSON |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Kolom | |
---|---|
hours |
Jam dalam format 24 jam. Harus dari 0 hingga 23. API dapat memilih untuk mengizinkan nilai "24:00:00" untuk skenario seperti jam tutup bisnis. |
minutes |
Menit dalam jam. Harus dari 0 hingga 59. |
seconds |
Detik menit dari waktu. Biasanya harus antara 0 hingga 59. API dapat mengizinkan nilai 60 jika memungkinkan kabisat-detik. |
nanos |
Pecahan detik dalam nanodetik. Harus dari 0 hingga 999.999.999. |
DayOfWeek
Merepresentasikan hari dalam seminggu.
Enum | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
Hari dalam seminggu tidak ditentukan. |
MONDAY |
Senin |
TUESDAY |
Selasa |
WEDNESDAY |
Rabu |
THURSDAY |
Kamis |
FRIDAY |
Jumat |
SATURDAY |
Sabtu |
SUNDAY |
Minggu |
HumanRepresentative
Detail untuk perwakilan manusia.
Representasi JSON |
---|
{
"humanMessagingAvailability": {
object ( |
Kolom | |
---|---|
humanMessagingAvailability |
Wajib. Ketersediaan fitur pesan manusia. |
AuthorizationConfig
Detail konfigurasi untuk mendukung OAuth di Business Messages.
Representasi JSON |
---|
{ "endpointUrl": string } |
Kolom | |
---|---|
endpointUrl |
URL endpoint tempat pengguna login. |
NonLocalConfig
Konfigurasi untuk mengaktifkan titik entri non-lokal.
Representasi JSON |
---|
{ "contactOption": { object ( |
Kolom | |
---|---|
contactOption |
Wajib. Informasi kontak untuk agen, yang ditampilkan dengan tombol pesan. |
enabledDomains[] |
Wajib. Domain yang akan diaktifkan untuk titik entri sitelink. |
phoneNumber |
Wajib. Nomor telepon agen. Mengganti kolom |
callDeflectionPhoneNumbers[] |
Wajib. Daftar nomor telepon untuk pengalihan panggilan. |
regionCodes[] |
Wajib. Daftar kode wilayah CLDR untuk negara tempat agen diizinkan untuk meluncurkan titik entri |
ContactOption
Detail kontak ditampilkan selain tombol pesan.
Representasi JSON |
---|
{
"url": string,
"options": [
enum ( |
Kolom | |
---|---|
url |
Wajib. URL yang menyediakan opsi kontak. |
options[] |
Wajib. Daftar opsi kontak yang tersedia untuk URL yang ditentukan. |
Opsi
Opsi kontak.
Enum | |
---|---|
OPTION_UNSPECIFIED |
Belum ditetapkan |
WEB_CHAT |
Opsi Chat Web. |
PHONE |
Opsi telepon. |
EMAIL |
Opsi email. |
FAQS |
opsi FAQ. |
TWITTER |
Opsi Twitter. |
WHATSAPP |
Opsi WhatsApp. |
SurveyConfig
Detail konfigurasi untuk mendukung pertanyaan survei yang disesuaikan.
Representasi JSON |
---|
{
"templateQuestionIds": [
string
],
"customSurveys": {
string: {
object ( |
Kolom | |
---|---|
templateQuestionIds[] |
Daftar ID pertanyaan template untuk pertanyaan template yang disertakan dalam survei. |
customSurveys |
Pertanyaan survei kustom untuk agen, dipetakan ke lokalitas. Lokalitas direpresentasikan oleh tag bahasa IETF BCP 47 yang diformat dengan baik. Objek yang berisi daftar pasangan |
CustomSurveyConfig
Konfigurasi survei kustom untuk agen.
Representasi JSON |
---|
{
"customQuestions": [
{
object ( |
Kolom | |
---|---|
customQuestions[] |
Daftar pertanyaan kustom. |
SurveyQuestion
Konten terperinci dari setiap pertanyaan survei.
Representasi JSON |
---|
{ "name": string, "questionType": enum ( |
Kolom | |
---|---|
name |
Wajib. ID unik pertanyaan. |
questionType |
Hanya output. Jenis pertanyaan. |
questionContent |
Wajib. Konten pertanyaan. Dibatasi hingga 200 karakter untuk pertanyaan kustom. |
responseOptions[] |
Wajib. Daftar respons yang ditampilkan bersama pertanyaan. Maksimum 12. |
Jenis
Jenis pertanyaan survei.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Jenis pertanyaan survei tidak diketahui. |
GOOGLE_STANDARD_QUESTION |
Pertanyaan survei standar Google. |
GOOGLE_TEMPLATE_QUESTION |
Template pertanyaan survei yang disediakan Google. |
PARTNER_CUSTOM_QUESTION |
Pertanyaan survei yang disesuaikan partner. |
SurveyResponse
Konten untuk respons pertanyaan survei.
Representasi JSON |
---|
{ "content": string, "postbackData": string } |
Kolom | |
---|---|
content |
Wajib. Teks yang ditampilkan di survei dan dikirim kembali ke agen saat pengguna mengetuknya. Maksimum 35 karakter. |
postbackData |
String yang diterima agen saat pengguna mengetuk respons pertanyaan. |
Metode |
|
---|---|
|
Membuat agen baru untuk mewakili brand. |
|
Menghapus agen. |
|
Mendapatkan informasi tentang agen. |
|
Mendapatkan informasi peluncuran untuk agen. |
|
Mendapatkan informasi verifikasi untuk agen. |
|
Mencantumkan semua agen yang terkait dengan merek. |
|
Memperbarui informasi tentang agen. |
|
Memulai proses peluncuran untuk agen. |
|
Memulai verifikasi informasi bisnis untuk agen. |
|
Memperbarui informasi peluncuran untuk agen. |
|
Memperbarui status verifikasi untuk agen. |