REST Resource: brands.agents

Resource: Agen

Entitas percakapan yang mewakili sebuah brand.

Representasi JSON 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
Kolom
name

string

ID unik agen.

Hanya baca. Ditentukan oleh platform.
displayName

string

Wajib. Nama yang ditampilkan agen kepada pengguna. Maksimum 100 karakter.

Tidak dapat diubah setelah verifikasi agen.

Kolom union detail_info. Berisi kolom yang diperlukan untuk produk tertentu.

Wajib. detail_info hanya dapat berupa salah satu dari yang berikut:
businessMessagesAgent

object (BusinessMessagesAgent)

Informasi agen mendetail untuk Business Messages.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Informasi agen mendetail untuk RCS Business Messaging.

BusinessMessagesAgent

Informasi agen khusus untuk Business Messages.

Representasi JSON 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
Kolom
logoUrl

string

Opsional. URL logo yang tersedia secara publik untuk agen. Maksimum 50 KB.

Tidak dapat diubah setelah verifikasi agen.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Opsional. Daftar konfigurasi titik entri.

Tidak dapat diubah setelah verifikasi agen.
conversationalSettings

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

Wajib. Setelan percakapan untuk agen, dipetakan ke lokalitas. Lokalitas direpresentasikan dengan tag bahasa IETF BCP 47 yang diformat dengan baik.

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

string

Wajib. Lokalitas default untuk agen. Harus cocok dengan lokalitas yang ditentukan dalam conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Wajib. Informasi interaksi agen utama. Digunakan saat pengguna memulai percakapan.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Opsional. Informasi interaksi agen tambahan. Memungkinkan agen mendukung beberapa jenis interaksi.
customAgentId

string

Opsional. ID yang ditentukan partner untuk agen. ID diteruskan bersama semua pesan yang dikirim ke agen.
agentTestUrl
(deprecated)

string

Hanya output. URL untuk menguji pengalaman percakapan agen.

Ditentukan oleh platform.
testUrls[]

object (TestUrl)

Hanya output. URL untuk menguji pengalaman percakapan agen.

Ditentukan oleh platform.
phone

object (Phone)

Opsional. Nomor telepon yang akan ditampilkan agen. Jika tidak ditentukan, agen akan menampilkan nomor telepon untuk merek yang ada di Pustaka Pengetahuan Google, jika ada.
authorizationConfig

object (AuthorizationConfig)

Opsional. Konfigurasi otorisasi untuk dukungan OAuth.
nonLocalConfig

object (NonLocalConfig)

Opsional. Konfigurasi untuk titik entri non-lokal.
surveyConfig

object (SurveyConfig)

Opsional. Konfigurasi untuk mengaktifkan survei kustom.

BusinessMessagesEntryPointConfig

Konfigurasi titik entri untuk agen.

Representasi JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Kolom
allowedEntryPoint

enum (EntryPoint)

Wajib. Google memunculkan agen yang dapat ditampilkan.

EntryPoint

Google memunculkan agen yang 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 (InteractionType),

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
Kolom
interactionType

enum (InteractionType)

Wajib. Jenis interaksi yang didukung oleh agen.
Kolom union representative. Info mendetail untuk jenis konfigurasi. Wajib. representative hanya ada berupa salah satu diantara berikut:
botRepresentative

object (BotRepresentative)

Detail perwakilan bot.
humanRepresentative

object (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 (MessagingAvailability)
  }
}
Kolom
botMessagingAvailability

object (MessagingAvailability)

Wajib. Ketersediaan fitur pesan bot.

MessagingAvailability

Jam tersedianya pesan setiap hari dalam seminggu. Anda dapat mengelompokkan jam selama beberapa hari bersama-sama. 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 ketersediaan yang tidak ditentukan pada hari Minggu, pesan tidak akan tersedia selama waktu 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 (Hours)
    }
  ]
}
Kolom
hours[]

object (Hours)

Wajib. Jam ketersediaan fitur pesan.

Jam

Rentang jam saat fitur pesan tersedia.

Representasi JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Kolom
startTime

object (TimeOfDay)

Wajib. Waktu mulai untuk setiap hari dalam rentang hari dalam seminggu.
endTime

object (TimeOfDay)

Wajib. Waktu berakhir untuk setiap hari dalam rentang hari dalam seminggu.
timeZone

string

Wajib. Zona waktu IANA untuk jam. Misalnya, "America/Los_Angeles".
startDay

enum (DayOfWeek)

Wajib. Hari mulai.
endDay

enum (DayOfWeek)

Wajib. Hari akhir. Termasuk hari yang ditentukan.

TimeOfDay

Merepresentasikan 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

integer

Jam dalam format 24 jam. Harus antara 0 hingga 23. API dapat memilih untuk mengizinkan nilai "24:00:00" untuk skenario seperti jam tutup bisnis.
minutes

integer

Menit dalam jam. Harus antara 0 hingga 59.
seconds

integer

Detik dari menit. Biasanya harus antara 0 hingga 59. API dapat mengizinkan nilai 60 jika memungkinkan kabisat-detik.
nanos

integer

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 (MessagingAvailability)
  }
}
Kolom
humanMessagingAvailability

object (MessagingAvailability)

Wajib. Ketersediaan fitur pesan manusia.

AuthorizationConfig

Detail konfigurasi untuk mendukung OAuth di Business Messages.

Representasi JSON 
{
  "endpointUrl": string
}
Kolom
endpointUrl

string

URL endpoint tempat pengguna login.

NonLocalConfig

Konfigurasi untuk mengaktifkan titik entri non-lokal.

Representasi JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Kolom
contactOption

object (ContactOption)

Wajib. Informasi kontak untuk agen, yang ditampilkan dengan tombol pesan.
enabledDomains[]

string

Wajib. Domain yang akan diaktifkan untuk titik entri sitelink.
phoneNumber

object (Phone)

Wajib. Nomor telepon agen. Mengganti kolom phone untuk percakapan yang dimulai dari titik entri non-lokal. Nomor telepon ini akan digunakan untuk semua wilayah yang dikonfigurasi.
callDeflectionPhoneNumbers[]

object (Phone)

Wajib. Daftar nomor telepon untuk pengalihan panggilan.
regionCodes[]

string

Wajib. Daftar kode wilayah CLDR untuk negara tempat agen diizinkan meluncurkan NON_LOCAL titik entri. Diperlukan untuk titik entri NON_LOCAL.

ContactOption

Detail kontak yang ditampilkan selain tombol pesan.

Representasi JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Kolom
url

string

Wajib. URL yang menyediakan opsi kontak.
options[]

enum (Option)

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 FAQ.
TWITTER Opsi Twitter.
WHATSAPP Opsi WhatsApp.

SurveyConfig

Detail konfigurasi untuk mendukung pertanyaan survei yang disesuaikan.

Representasi JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Kolom
templateQuestionIds[]

string

Daftar ID pertanyaan template untuk pertanyaan template yang disertakan dalam survei.
customSurveys

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

Pertanyaan survei kustom untuk agen, dipetakan ke sebuah lokalitas. Lokalitas direpresentasikan dengan tag bahasa IETF BCP 47 yang diformat dengan baik.

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

CustomSurveyConfig

Konfigurasi survei kustom untuk agen.

Representasi JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Kolom
customQuestions[]

object (SurveyQuestion)

Daftar pertanyaan kustom.

SurveyQuestion

Konten terperinci dari setiap pertanyaan survei.

Representasi JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Kolom
name

string

Wajib. ID unik pertanyaan.
questionType

enum (Type)

Hanya output. Jenis pertanyaan.
questionContent

string

Wajib. Konten pertanyaan. Dibatasi hingga 200 karakter untuk pertanyaan kustom.
responseOptions[]

object (SurveyResponse)

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 Pertanyaan survei template 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

string

Wajib. Teks yang ditampilkan dalam survei dan dikirim kembali ke agen saat pengguna mengetuknya. Maksimum 35 karakter.
postbackData

string

String yang diterima agen saat pengguna mengetuk respons pertanyaan.

RcsBusinessMessagingAgent

Informasi agen yang secara khusus terkait dengan RCS Business Messaging.

Representasi JSON 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
Kolom
description

string

Wajib. Deskripsi agen yang dapat dilihat oleh pengguna. Maksimum 100 karakter.
logoUri

string

Wajib. URL logo yang tersedia secara publik untuk agen. Maksimum 50 KB.

Tidak dapat diubah setelah verifikasi agen.
heroUri

string

Wajib. URL banner besar yang tersedia secara publik untuk agen. Maksimum 200 KB.

Tidak dapat diubah setelah verifikasi agen.
phoneNumbers[]

object (PhoneEntry)

Wajib. Nomor telepon yang terkait dengan agen.
emails[]

object (EmailEntry)

Opsional. Alamat email yang terkait dengan agen.
websites[]

object (WebEntry)

Opsional. Situs yang terkait dengan agen. Maksimal 3.
privacy

object (WebEntry)

Wajib. Kebijakan privasi yang terkait dengan agen.
termsConditions

object (WebEntry)

Wajib. Persyaratan dan ketentuan yang terkait dengan agen.
color

string

Wajib. Warna tema agen yang dapat dilihat oleh pengguna dalam format heksadesimal. Misalnya, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Wajib. Konfigurasi penagihan untuk agen.
agentUseCase

enum (AgentUseCase)

Opsional. Kasus penggunaan bot.
hostingRegion

enum (HostingRegion)

Wajib. Wilayah hosting untuk agen.

PhoneEntry

Nomor telepon yang terkait dengan agen.

Representasi JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Kolom
phoneNumber

object (Phone)

Wajib. Nomor telepon dalam format E.164. Misalnya, +12223334444.
label

string

Wajib. Label untuk nomor telepon.

EmailEntry

Email yang terkait dengan agen.

Representasi JSON 
{
  "address": string,
  "label": string
}
Kolom
address

string

Wajib. Alamat email.
label

string

Wajib. Label untuk alamat email.

WebEntry

Resource berbasis web yang terkait dengan agen.

Representasi JSON 
{
  "uri": string,
  "label": string
}
Kolom
uri

string

Wajib. URI yang dapat diakses secara publik terkait dengan agen. Harus menggunakan protokol HTTP atau HTTPS.
label

string

Opsional. Label untuk URI.

RcsBusinessMessagingAgentBillingConfig

Konfigurasi penagihan untuk agen.

Representasi JSON 
{
  "billingCategory": enum (BillingCategory)
}
Kolom
billingCategory

enum (BillingCategory)

Kategori penagihan untuk agen.

BillingCategory

Kategori penagihan yang didukung.

Enum
BILLING_CATEGORY_UNSPECIFIED Kategori tidak ditentukan.
CONVERSATIONAL_LEGACY Kategori lama untuk mendukung konfigurasi penagihan agen yang ada.
CONVERSATIONAL Dirancang untuk sesi yang lebih lama dan lebih kompleks di mana pengguna dan brand bertukar pesan.
SINGLE_MESSAGE Mengganti SMS dengan pengalaman pesan yang lebih kaya. Tidak pernah ditagih sebagai CONVERSATIONAL.
BASIC_MESSAGE Model penagihan mirip dengan SMS. Tidak pernah ditagih sebagai CONVERSATIONAL.

AgentUseCase

Jenis kasus penggunaan agen yang digunakan dalam penyimpanan.

Enum
AGENT_USE_CASE_UNSPECIFIED Kasus penggunaan tidak ditentukan.
TRANSACTIONAL Agen yang hanya mengirim pesan penting, diperlukan, dan mendesak.
PROMOTIONAL Agen yang mengirimkan pesan penjualan, pemasaran, dan promosi. Jenis default.
OTP Agen yang hanya mengirim {i>password<i} sekali pakai.
MULTI_USE Agen yang memiliki beberapa kasus penggunaan.

HostingRegion

Kemungkinan wilayah hosting untuk agen, digunakan untuk merutekan pesan P2A ke server regional dengan benar.

Enum
HOSTING_REGION_UNSPECIFIED Wilayah hosting belum ditetapkan.
NORTH_AMERICA Amerika Utara.
EUROPE Eropa.
ASIA_PACIFIC Asia Pasifik.

Metode

create

 Membuat agen baru untuk mewakili brand.

delete
(deprecated)

 Tidak digunakan lagi: penghapusan agen tidak digunakan lagi.

get

 Mendapatkan informasi tentang agen.

getLaunch

 Mendapatkan informasi peluncuran untuk agen.

getVerification

 Mendapatkan informasi verifikasi untuk agen.

list

 Mencantumkan semua agen yang terkait dengan sebuah merek.

patch

 Memperbarui informasi tentang agen.

requestLaunch

 Memulai proses peluncuran untuk agen.

requestVerification

 Memulai verifikasi informasi bisnis untuk agen.

updateLaunch

 Memperbarui informasi peluncuran untuk agen.

updateVerification

 Memperbarui status verifikasi untuk agen.