ทรัพยากร: ตัวแทน
เอนทิตีเชิงสนทนาที่แสดงถึงแบรนด์
การแสดง JSON |
---|
{ "name": string, "displayName": string, // Union field |
ช่อง | |
---|---|
name |
ตัวระบุที่ไม่ซ้ำกันของ Agent อ่านอย่างเดียว กำหนดโดยแพลตฟอร์ม |
displayName |
ต้องระบุ ชื่อที่ Agent แสดงให้ผู้ใช้เห็น ยาวไม่เกิน 100 อักขระ ไม่สามารถแก้ไขได้หลังจากยืนยันตัวแทนแล้ว |
ฟิลด์การรวม ต้องระบุ |
|
businessMessagesAgent |
ข้อมูลตัวแทนโดยละเอียดสำหรับ Business Messages |
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 ชม. วันพฤหัสบดี - วันศุกร์ * 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 รายการ |
Type
ประเภทของคำถามในแบบสำรวจ
Enum | |
---|---|
TYPE_UNSPECIFIED |
ไม่ทราบประเภทคำถามในแบบสำรวจ |
GOOGLE_STANDARD_QUESTION |
คำถามในแบบสำรวจมาตรฐานของ Google |
GOOGLE_TEMPLATE_QUESTION |
คำถามแบบสำรวจเทมเพลตที่ Google มีให้ |
PARTNER_CUSTOM_QUESTION |
คำถามแบบสำรวจที่ปรับแต่งโดยพาร์ทเนอร์ |
SurveyResponse
เนื้อหาสําหรับคําตอบของคําถามในแบบสํารวจ
การแสดง JSON |
---|
{ "content": string, "postbackData": string } |
ช่อง | |
---|---|
content |
ต้องระบุ ข้อความที่แสดงในแบบสำรวจและส่งกลับไปยังตัวแทนเมื่อผู้ใช้แตะที่ตัวแทน สูงสุด 35 อักขระ |
postbackData |
สตริงที่ Agent ได้รับเมื่อผู้ใช้แตะคำตอบของคำถาม |
วิธีการ |
|
---|---|
|
สร้างตัวแทนใหม่เพื่อเป็นตัวแทนแบรนด์ |
|
ลบตัวแทน |
|
รับข้อมูลเกี่ยวกับตัวแทน |
|
รับข้อมูลการเปิดใช้งานของตัวแทน |
|
รับข้อมูลการยืนยันสำหรับตัวแทน |
|
แสดงตัวแทนทั้งหมดที่เชื่อมโยงกับแบรนด์ |
|
อัปเดตข้อมูลเกี่ยวกับตัวแทน |
|
เริ่มกระบวนการเปิดใช้งานสำหรับตัวแทน |
|
เริ่มการยืนยันข้อมูลทางธุรกิจให้กับตัวแทน |
|
อัปเดตข้อมูลการเปิดใช้สำหรับตัวแทน |
|
อัปเดตสถานะการยืนยันของตัวแทน |