แหล่งข้อมูล: ตัวแทน
เอนทิตีการสนทนาที่แสดงถึงแบรนด์
การแสดง JSON |
---|
{ "name": string, "displayName": string, // Union field |
ช่อง | |
---|---|
name |
ตัวระบุที่ไม่ซ้ำกันของ Agent อ่านอย่างเดียว กำหนดตามแพลตฟอร์ม |
displayName |
ต้องระบุ ชื่อที่ Agent แสดงต่อผู้ใช้ ยาวไม่เกิน 100 อักขระ จะแก้ไขไม่ได้หลังจากการยืนยันตัวแทน |
ฟิลด์สหภาพ ต้องระบุ |
|
businessMessagesAgent |
ข้อมูลตัวแทนโดยละเอียดสำหรับ Business Messages |
rcsBusinessMessagingAgent |
ข้อมูลตัวแทนโดยละเอียดสำหรับการรับส่งข้อความทางธุรกิจ RCS |
BusinessMessagesAgent
ข้อมูลตัวแทนสำหรับ Business Messages โดยเฉพาะ
การแสดง JSON |
---|
{ "logoUrl": string, "entryPointConfigs": [ { object ( |
ช่อง | |
---|---|
logoUrl |
ไม่บังคับ URL ของโลโก้ที่พร้อมใช้งานแบบสาธารณะสำหรับตัวแทน สูงสุด 50 KB จะแก้ไขไม่ได้หลังจากการยืนยันตัวแทน |
entryPointConfigs[] |
ไม่บังคับ รายการการกำหนดค่าจุดแรกเข้า จะแก้ไขไม่ได้หลังจากการยืนยันตัวแทน |
conversationalSettings |
ต้องระบุ การตั้งค่าการสนทนาสำหรับตัวแทน แมปกับภาษาแล้ว ภาษาจะแสดงด้วยแท็กภาษา IETF BCP 47 ที่มีรูปแบบถูกต้อง ออบเจ็กต์ที่มีรายการคู่ |
defaultLocale |
ต้องระบุ ภาษาเริ่มต้นสำหรับ Agent ต้องตรงกับภาษาที่กำหนดไว้ใน |
primaryAgentInteraction |
ต้องระบุ ข้อมูลการโต้ตอบของตัวแทนหลัก ใช้เมื่อผู้ใช้เริ่มการสนทนา |
additionalAgentInteractions[] |
ไม่บังคับ ข้อมูลการโต้ตอบกับตัวแทนเพิ่มเติม เปิดใช้ Agent เพื่อรองรับการโต้ตอบหลายประเภท |
customAgentId |
ไม่บังคับ ตัวระบุที่พาร์ทเนอร์ระบุสำหรับตัวแทน ระบบจะส่งตัวระบุไปพร้อมกับข้อความทั้งหมดที่ส่งไปยังตัวแทน |
agentTestUrl |
เอาต์พุตเท่านั้น URL สำหรับการทดสอบประสบการณ์การสนทนาของตัวแทน กำหนดตามแพลตฟอร์ม |
testUrls[] |
เอาต์พุตเท่านั้น URL สำหรับการทดสอบประสบการณ์การสนทนาของตัวแทน กำหนดตามแพลตฟอร์ม |
phone |
ไม่บังคับ หมายเลขโทรศัพท์ที่ตัวแทนจะแสดง หากไม่ระบุ ตัวแทนจะแสดงหมายเลขโทรศัพท์สำหรับแบรนด์ที่พบในกราฟความรู้ของ Google หากมี |
authorizationConfig |
ไม่บังคับ การกำหนดค่าการให้สิทธิ์สำหรับการรองรับ OAuth |
nonLocalConfig |
ไม่บังคับ การกำหนดค่าสำหรับจุดแรกเข้าที่ไม่ได้อยู่ในเครื่อง |
surveyConfig |
ไม่บังคับ การกําหนดค่าเพื่อเปิดใช้แบบสํารวจที่กําหนดเอง |
BusinessMessagesEntryPointConfig
การกำหนดค่าจุดแรกเข้าสำหรับ Agent
การแสดง JSON |
---|
{
"allowedEntryPoint": enum ( |
ช่อง | |
---|---|
allowedEntryPoint |
ต้องระบุ Google จะแสดงคุณสมบัติที่ทำให้ตัวแทนปรากฏ |
EntryPoint
Google จะแสดงคุณสมบัติที่ทำให้ตัวแทนปรากฏ
Enum | |
---|---|
ENTRY_POINT_UNSPECIFIED |
จุดแรกเข้าที่ไม่ระบุ |
LOCATION |
เปิดใช้สถานที่ตั้งสำหรับตัวแทนนี้ |
NON_LOCAL |
เปิดใช้ Business Messages สำหรับจุดแรกเข้านอกพื้นที่ |
SupportedAgentInteraction
การโต้ตอบที่ตัวแทนรองรับ
การแสดง JSON |
---|
{ "interactionType": enum ( |
ช่อง | |
---|---|
interactionType |
ต้องระบุ ประเภทการโต้ตอบที่ตัวแทนรองรับ |
ฟิลด์สหภาพ representative ข้อมูลโดยละเอียดสำหรับประเภทการกำหนดค่า ต้องระบุ representative ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
botRepresentative |
รายละเอียดตัวแทนของบ็อต |
humanRepresentative |
รายละเอียดของเจ้าหน้าที่ตัวแทน |
InteractionType
ประเภทการโต้ตอบที่ตัวแทนรองรับ
Enum | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
การโต้ตอบที่ไม่ระบุ |
BOT |
การโต้ตอบกับบ็อต |
HUMAN |
ปฏิสัมพันธ์ของมนุษย์ |
BotRepresentative
รายละเอียดสำหรับตัวแทนบ็อต
การแสดง JSON |
---|
{
"botMessagingAvailability": {
object ( |
ช่อง | |
---|---|
botMessagingAvailability |
ต้องระบุ ความพร้อมใช้งานการรับส่งข้อความของบ็อต |
MessagingAvailability
ชั่วโมงของแต่ละวันในสัปดาห์ที่รับส่งข้อความได้ คุณจัดกลุ่มเวลาทำการสำหรับหลายวันเข้าด้วยกันได้ เช่น * 08:00–16:00 ชม. PDT วันจันทร์–วันพุธ * 10:00–14:00 ชม. PDT วันพฤหัสบดี-ศุกร์ * 15:00–18:00 ชม. PDT วันพฤหัสบดี–วันศุกร์ * 10:00–14:00 ชม. PDT วันเสาร์ - เสาร์
หากความพร้อมจำหน่ายสินค้ามีช่องว่าง เช่น ไม่ระบุความพร้อมจำหน่ายสินค้าในวันอาทิตย์ การรับส่งข้อความจะใช้งานไม่ได้ในระหว่างช่วงเวลานั้น
เวลาทำการของบ็อตจะไม่ส่งผลต่อความพร้อมใช้งาน ตัวแทนเฉพาะบ็อตจะแสดงข้อความต้อนรับเสมอ ส่วนตัวแทนที่มีการตั้งค่าทั้งที่เป็นเจ้าหน้าที่และบ็อตจะพิจารณาเฉพาะตัวแทนที่เป็นมนุษย์เท่านั้นเมื่อกำหนดความพร้อม
การแสดง JSON |
---|
{
"hours": [
{
object ( |
ช่อง | |
---|---|
hours[] |
ต้องระบุ เวลาที่พร้อมให้บริการรับส่งข้อความ |
เวลาทำการ
ช่วงเวลาให้บริการรับส่งข้อความ
การแสดง JSON |
---|
{ "startTime": { object ( |
ช่อง | |
---|---|
startTime |
ต้องระบุ เวลาเริ่มต้นสำหรับแต่ละวันภายในช่วงวันของสัปดาห์ |
endTime |
ต้องระบุ เวลาสิ้นสุดสำหรับแต่ละวันภายในช่วงวันของสัปดาห์ |
timeZone |
ต้องระบุ เขตเวลา IANA สำหรับเวลาทำการ เช่น "America/Los_Angeles" |
startDay |
ต้องระบุ วันที่เริ่มต้น |
endDay |
ต้องระบุ วันที่สิ้นสุด รวมวันที่ระบุ |
TimeOfDay
แสดงเวลาของวัน วันที่และเขตเวลาไม่มีนัยสำคัญหรือระบุไว้ในที่อื่น API อาจเลือกอนุญาตวินาทีอธิกสุรทิน ประเภทที่เกี่ยวข้องได้แก่ google.type.Date
และ google.protobuf.Timestamp
การแสดง JSON |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
ช่อง | |
---|---|
hours |
ชั่วโมงของวันในรูปแบบ 24 ชั่วโมง ควรอยู่ระหว่าง 0 ถึง 23 API อาจเลือกอนุญาตให้ใช้ค่า "24:00:00" สำหรับสถานการณ์ต่างๆ เช่น เวลาปิดทำการของธุรกิจ |
minutes |
นาทีในชั่วโมงของวัน ต้องอยู่ระหว่าง 0 ถึง 59 |
seconds |
วินาทีของนาทีของเวลา ปกติต้องอยู่ระหว่าง 0 ถึง 59 API อาจอนุญาตค่า 60 หากอนุญาตให้ใช้วินาทีอธิกสุรทิน |
nanos |
เศษส่วนของวินาทีในนาโนวินาที ต้องอยู่ระหว่าง 0 ถึง 999,999,999 |
DayOfWeek
แสดงวันของสัปดาห์
Enum | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
ไม่ได้ระบุวันของสัปดาห์ |
MONDAY |
วันจันทร์ |
TUESDAY |
วันอังคาร |
WEDNESDAY |
วันพุธ |
THURSDAY |
พฤหัสบดี |
FRIDAY |
วันศุกร์ |
SATURDAY |
เสาร์ |
SUNDAY |
วันอาทิตย์ |
HumanRepresentative
รายละเอียดสำหรับตัวแทนที่เป็นมนุษย์
การแสดง JSON |
---|
{
"humanMessagingAvailability": {
object ( |
ช่อง | |
---|---|
humanMessagingAvailability |
ต้องระบุ ความพร้อมให้บริการสำหรับการรับส่งข้อความ |
AuthorizationConfig
รายละเอียดการกำหนดค่าเพื่อรองรับ OAuth ใน Business Messages
การแสดง JSON |
---|
{ "endpointUrl": string } |
ช่อง | |
---|---|
endpointUrl |
URL ปลายทางที่ผู้ใช้เข้าสู่ระบบ |
NonLocalConfig
การกำหนดค่าเพื่อเปิดใช้จุดแรกเข้าที่ไม่ได้อยู่ในเครื่อง
การแสดง JSON |
---|
{ "contactOption": { object ( |
ช่อง | |
---|---|
contactOption |
ต้องระบุ ข้อมูลติดต่อสำหรับตัวแทนที่แสดงพร้อมปุ่มรับส่งข้อความ |
enabledDomains[] |
ต้องระบุ โดเมนที่จะเปิดใช้สำหรับจุดแรกเข้าของไซต์ลิงก์ |
phoneNumber |
ต้องระบุ หมายเลขโทรศัพท์ของตัวแทน ลบล้างช่อง |
callDeflectionPhoneNumbers[] |
ต้องระบุ รายการหมายเลขโทรศัพท์สำหรับการโอนสาย |
regionCodes[] |
ต้องระบุ รายการรหัสภูมิภาค CLDR สําหรับประเทศที่ตัวแทนอนุญาตให้เปิดใช้จุดแรกเข้า |
ContactOption
รายละเอียดการติดต่อที่แสดงเพิ่มเติมจากปุ่มข้อความ
การแสดง JSON |
---|
{
"url": string,
"options": [
enum ( |
ช่อง | |
---|---|
url |
ต้องระบุ URL ที่มีตัวเลือกการติดต่อให้ใช้ |
options[] |
ต้องระบุ รายการตัวเลือกการติดต่อที่พร้อมใช้งานสำหรับ URL ที่ระบุ |
ตัวเลือก
ตัวเลือกการติดต่อ
Enum | |
---|---|
OPTION_UNSPECIFIED |
ไม่ระบุ |
WEB_CHAT |
ตัวเลือกแชทบนเว็บ |
PHONE |
ตัวเลือกโทรศัพท์ |
EMAIL |
ตัวเลือกอีเมล |
FAQS |
ตัวเลือกคำถามที่พบบ่อย |
TWITTER |
ตัวเลือก Twitter |
WHATSAPP |
ตัวเลือก WhatsApp |
SurveyConfig
รายละเอียดการกำหนดค่าเพื่อรองรับคำถามในแบบสำรวจซึ่งปรับให้เหมาะกับคุณ
การแสดง JSON |
---|
{
"templateQuestionIds": [
string
],
"customSurveys": {
string: {
object ( |
ช่อง | |
---|---|
templateQuestionIds[] |
รายการรหัสคำถามของเทมเพลตสำหรับคำถามเกี่ยวกับเทมเพลตที่รวมอยู่ในแบบสำรวจ |
customSurveys |
คำถามในแบบสำรวจที่กำหนดเองสำหรับตัวแทน แมปกับภาษาแล้ว ภาษาจะแสดงด้วยแท็กภาษา IETF BCP 47 ที่มีรูปแบบถูกต้อง ออบเจ็กต์ที่มีรายการคู่ |
CustomSurveyConfig
การกำหนดค่าแบบสำรวจที่กำหนดเองสำหรับตัวแทน
การแสดง JSON |
---|
{
"customQuestions": [
{
object ( |
ช่อง | |
---|---|
customQuestions[] |
รายการคำถามที่กำหนดเอง |
SurveyQuestion
เนื้อหาโดยละเอียดของคำถามแต่ละข้อในแบบสำรวจ
การแสดง JSON |
---|
{ "name": string, "questionType": enum ( |
ช่อง | |
---|---|
name |
ต้องระบุ ตัวระบุที่ไม่ซ้ำกันของคำถาม |
questionType |
เอาต์พุตเท่านั้น ประเภทของคำถาม |
questionContent |
ต้องระบุ เนื้อหาของคำถาม คำถามที่กำหนดเองมีอักขระได้ไม่เกิน 200 ตัว |
responseOptions[] |
ต้องระบุ รายการคำตอบที่แสดงพร้อมคำถาม สูงสุด 12 รายการ |
ประเภท
ประเภทของคำถามในแบบสำรวจ
Enum | |
---|---|
TYPE_UNSPECIFIED |
ประเภทคำถามในแบบสำรวจที่ไม่รู้จัก |
GOOGLE_STANDARD_QUESTION |
คำถามในแบบสำรวจมาตรฐานของ Google |
GOOGLE_TEMPLATE_QUESTION |
คำถามแบบสำรวจเทมเพลตที่ Google มีให้ |
PARTNER_CUSTOM_QUESTION |
คำถามในแบบสำรวจที่พาร์ทเนอร์ปรับแต่ง |
SurveyResponse
เนื้อหาสำหรับการตอบคำถามในแบบสำรวจ
การแสดง JSON |
---|
{ "content": string, "postbackData": string } |
ช่อง | |
---|---|
content |
ต้องระบุ ข้อความที่แสดงในแบบสำรวจและส่งกลับไปยังตัวแทนเมื่อผู้ใช้แตะที่ตัวแทน สูงสุด 35 อักขระ |
postbackData |
สตริงที่ Agent ได้รับเมื่อผู้ใช้แตะคำตอบสำหรับคำถาม |
RcsBusinessMessagingAgent
ข้อมูลตัวแทนที่เกี่ยวข้องกับการรับส่งข้อความทางธุรกิจ RCS โดยเฉพาะ
การแสดง JSON |
---|
{ "description": string, "logoUri": string, "heroUri": string, "phoneNumbers": [ { object ( |
ช่อง | |
---|---|
description |
ต้องระบุ คําอธิบายของ Agent ที่ผู้ใช้มองเห็นได้ ยาวไม่เกิน 100 อักขระ |
logoUri |
ต้องระบุ URL ของโลโก้ที่พร้อมใช้งานแบบสาธารณะสำหรับตัวแทน สูงสุด 50 KB จะแก้ไขไม่ได้หลังจากการยืนยันตัวแทน |
heroUri |
ต้องระบุ URL ของรูปภาพหลักที่พร้อมใช้งานแบบสาธารณะสำหรับตัวแทน สูงสุด 200 KB จะแก้ไขไม่ได้หลังจากการยืนยันตัวแทน |
phoneNumbers[] |
ต้องระบุ หมายเลขโทรศัพท์ที่เชื่อมโยงกับตัวแทน |
emails[] |
ไม่บังคับ อีเมลที่เชื่อมโยงกับตัวแทน |
websites[] |
ไม่บังคับ เว็บไซต์ที่เชื่อมโยงกับตัวแทน สูงสุด 3. |
privacy |
ต้องระบุ นโยบายความเป็นส่วนตัวที่เชื่อมโยงกับตัวแทน |
termsConditions |
ต้องระบุ ข้อกำหนดและเงื่อนไขที่เชื่อมโยงกับตัวแทน |
color |
ต้องระบุ สีธีมของ Agent ที่ผู้ใช้มองเห็นได้ในรูปแบบเลขฐาน 16 เช่น #FF6347 |
billingConfig |
ต้องระบุ การกำหนดค่าการเรียกเก็บเงินสำหรับ Agent |
agentUseCase |
ไม่บังคับ กรณีการใช้งานของบ็อต |
hostingRegion |
ต้องระบุ ภูมิภาคที่โฮสต์สำหรับตัวแทน |
PhoneEntry
หมายเลขโทรศัพท์ที่เชื่อมโยงกับตัวแทน
การแสดง JSON |
---|
{
"phoneNumber": {
object ( |
ช่อง | |
---|---|
phoneNumber |
ต้องระบุ หมายเลขโทรศัพท์ในรูปแบบ E.164 เช่น |
label |
ต้องระบุ ป้ายกำกับสำหรับหมายเลขโทรศัพท์ |
EmailEntry
อีเมลที่เชื่อมโยงกับตัวแทน
การแสดง JSON |
---|
{ "address": string, "label": string } |
ช่อง | |
---|---|
address |
ต้องระบุ อีเมล |
label |
ต้องระบุ ป้ายกำกับสำหรับอีเมล |
WebEntry
ทรัพยากรบนเว็บที่เชื่อมโยงกับ Agent
การแสดง JSON |
---|
{ "uri": string, "label": string } |
ช่อง | |
---|---|
uri |
ต้องระบุ URI ที่เข้าถึงได้แบบสาธารณะซึ่งเชื่อมโยงกับ Agent ต้องใช้โปรโตคอล HTTP หรือ HTTPS |
label |
ไม่บังคับ ป้ายกำกับสำหรับ URI |
RcsBusinessMessagingAgentBillingConfig
การกำหนดค่าการเรียกเก็บเงินสำหรับ Agent
การแสดง JSON |
---|
{
"billingCategory": enum ( |
ช่อง | |
---|---|
billingCategory |
หมวดหมู่การเรียกเก็บเงินของตัวแทน |
BillingCategory
หมวดหมู่การเรียกเก็บเงินที่รองรับ
Enum | |
---|---|
BILLING_CATEGORY_UNSPECIFIED |
ไม่ได้ระบุหมวดหมู่ |
CONVERSATIONAL_LEGACY |
หมวดหมู่เดิมเพื่อรองรับการกำหนดค่าการเรียกเก็บเงินของตัวแทนที่มีอยู่ |
CONVERSATIONAL |
ออกแบบมาสำหรับเซสชันที่ซับซ้อนและยาวนานขึ้น ซึ่งผู้ใช้และแบรนด์แลกเปลี่ยนชุดข้อความกัน |
SINGLE_MESSAGE |
แทนที่ SMS ด้วยประสบการณ์การรับส่งข้อความที่สมบูรณ์ยิ่งขึ้น ไม่เคยเรียกเก็บเงินเป็น CONVERSATIONAL |
BASIC_MESSAGE |
รูปแบบการเรียกเก็บเงินจะคล้ายกับ SMS ไม่เคยเรียกเก็บเงินเป็น CONVERSATIONAL |
AgentUseCase
ประเภท Use Case ของ Agent ที่ใช้ในพื้นที่เก็บข้อมูล
Enum | |
---|---|
AGENT_USE_CASE_UNSPECIFIED |
ไม่ได้ระบุกรณีการใช้งาน |
TRANSACTIONAL |
ตัวแทนที่ส่งข้อความเฉพาะที่สำคัญ จำเป็น และมีเวลาเป็นปัจจัยสำคัญ |
PROMOTIONAL |
ตัวแทนที่ส่งข้อความการขาย การตลาด และโปรโมชัน ประเภทเริ่มต้น |
OTP |
ตัวแทนที่ส่งรหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียว |
MULTI_USE |
ตัวแทนที่มีกรณีการใช้งานหลายกรณี |
HostingRegion
ภูมิภาคโฮสติ้งที่เป็นไปได้สำหรับ Agent ซึ่งใช้สำหรับกำหนดเส้นทางข้อความ P2A ไปยังเซิร์ฟเวอร์ตามภูมิภาคอย่างถูกต้อง
Enum | |
---|---|
HOSTING_REGION_UNSPECIFIED |
ภูมิภาคโฮสติ้งที่ไม่ระบุ |
NORTH_AMERICA |
อเมริกาเหนือ |
EUROPE |
ยุโรป |
ASIA_PACIFIC |
เอเชียแปซิฟิก |
วิธีการ |
|
---|---|
|
สร้างตัวแทนใหม่เพื่อเป็นตัวแทนแบรนด์ |
(deprecated) |
เลิกใช้งานแล้ว: เลิกใช้งานการลบตัวแทนแล้ว |
|
รับข้อมูลเกี่ยวกับตัวแทน |
|
รับข้อมูลการเปิดตัวสำหรับตัวแทน |
|
รับข้อมูลการยืนยันสำหรับตัวแทน |
|
แสดงตัวแทนทั้งหมดที่เชื่อมโยงกับแบรนด์ |
|
อัปเดตข้อมูลเกี่ยวกับตัวแทน |
|
เริ่มกระบวนการเปิดใช้งานสำหรับตัวแทน |
|
เริ่มการยืนยันข้อมูลทางธุรกิจสำหรับตัวแทน |
|
อัปเดตข้อมูลการเปิดใช้สำหรับตัวแทน |
|
อัปเดตสถานะการยืนยันสำหรับตัวแทน |