REST Resource: brands.agents

แหล่งข้อมูล: ตัวแทน

เอนทิตีการสนทนาซึ่งแสดงถึงแบรนด์

การแสดง JSON 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  }
  // End of list of possible types for union field detail_info.
}
ช่อง
name

string

ตัวระบุที่ไม่ซ้ำกันของ Agent

อ่านอย่างเดียว แพลตฟอร์มเป็นผู้กำหนด
displayName

string

ต้องระบุ ชื่อของตัวแทนที่แสดงต่อผู้ใช้ ยาวไม่เกิน 100 อักขระ

ไม่สามารถแก้ไขได้หลังจากยืนยันตัวแทนแล้ว

ช่องการรวม detail_info มีฟิลด์ที่จำเป็นสำหรับผลิตภัณฑ์นั้นๆ

ต้องระบุ detail_info ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
businessMessagesAgent

object (BusinessMessagesAgent)

ข้อมูลตัวแทนโดยละเอียดสำหรับ Business Messages

BusinessMessagesAgent

ข้อมูลตัวแทนสําหรับ Business Messages โดยเฉพาะ

การแสดง 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)
  }
}
ช่อง
logoUrl

string

ไม่บังคับ URL ของโลโก้ที่เผยแพร่ต่อสาธารณะสำหรับตัวแทน ขนาดสูงสุด 50 KB

ไม่สามารถแก้ไขได้หลังจากยืนยันตัวแทนแล้ว
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

ไม่บังคับ รายการการกำหนดค่าจุดแรกเข้า

ไม่สามารถแก้ไขได้หลังจากยืนยันตัวแทนแล้ว
conversationalSettings

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

ต้องระบุ การตั้งค่าการสนทนาสำหรับ Agent ที่แมปกับภาษา ภาษาจะแสดงด้วยแท็กภาษา IETF BCP 47 ที่มีรูปแบบถูกต้อง

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
defaultLocale

string

ต้องระบุ ภาษาเริ่มต้นสำหรับ Agent ต้องตรงกับภาษาที่กำหนดไว้ใน conversationalSettings
primaryAgentInteraction

object (SupportedAgentInteraction)

ต้องระบุ ข้อมูลการโต้ตอบกับตัวแทนหลัก ใช้เมื่อผู้ใช้เริ่มการสนทนา
additionalAgentInteractions[]

object (SupportedAgentInteraction)

ไม่บังคับ ข้อมูลเพิ่มเติมเกี่ยวกับการโต้ตอบกับตัวแทน ทำให้ Agent รองรับการโต้ตอบหลายประเภท
customAgentId

string

ไม่บังคับ ตัวระบุที่พาร์ทเนอร์ระบุสำหรับตัวแทน ระบบจะส่งตัวระบุไปพร้อมกับข้อความทั้งหมดที่ส่งไปยังตัวแทน
agentTestUrl
(deprecated)

string

เอาต์พุตเท่านั้น URL สำหรับทดสอบประสบการณ์การสนทนาของตัวแทน

แพลตฟอร์มเป็นผู้กำหนด
testUrls[]

object (TestUrl)

เอาต์พุตเท่านั้น URL สำหรับการทดสอบประสบการณ์การสนทนาของตัวแทน

แพลตฟอร์มเป็นผู้กำหนด
phone

object (Phone)

ไม่บังคับ หมายเลขโทรศัพท์ที่ตัวแทนจะแสดง หากไม่ระบุ ตัวแทนจะแสดงหมายเลขโทรศัพท์ของแบรนด์ที่พบในกราฟความรู้ของ Google (หากมี)
authorizationConfig

object (AuthorizationConfig)

ไม่บังคับ การกำหนดค่าการให้สิทธิ์สำหรับการรองรับ OAuth
nonLocalConfig

object (NonLocalConfig)

ไม่บังคับ การกำหนดค่าสำหรับจุดแรกเข้านอกเครื่อง
surveyConfig

object (SurveyConfig)

ไม่บังคับ การกำหนดค่าเพื่อเปิดใช้แบบสำรวจที่กำหนดเอง

BusinessMessagesEntryPointConfig

การกำหนดค่าจุดแรกเข้าสำหรับ Agent

การแสดง JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
ช่อง
allowedEntryPoint

enum (EntryPoint)

ต้องระบุ แพลตฟอร์มของ Google ที่เปิดให้ตัวแทนเปิดใช้เพื่อให้ปรากฏ

EntryPoint

แพลตฟอร์มของ Google ที่เปิดให้ตัวแทนเปิดใช้เพื่อให้ปรากฏ

Enum
ENTRY_POINT_UNSPECIFIED จุดแรกเข้าที่ไม่ได้ระบุ
LOCATION เปิดใช้สถานที่ตั้งสำหรับตัวแทนนี้
NON_LOCAL เปิดใช้ Business Messages สำหรับจุดแรกเข้านอกพื้นที่

SupportedAgentInteraction

การโต้ตอบที่ตัวแทนรองรับ

การแสดง 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.
}
ช่อง
interactionType

enum (InteractionType)

ต้องระบุ ประเภทการโต้ตอบที่ตัวแทนรองรับ
ช่องการรวม representative ข้อมูลโดยละเอียดสำหรับประเภทการกำหนดค่า ต้องระบุ representative ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
botRepresentative

object (BotRepresentative)

รายละเอียดตัวแทนของบ็อต
humanRepresentative

object (HumanRepresentative)

รายละเอียดจากเจ้าหน้าที่

InteractionType

ประเภทการโต้ตอบที่ตัวแทนรองรับ

Enum
INTERACTION_TYPE_UNSPECIFIED การโต้ตอบที่ไม่ระบุ
BOT การโต้ตอบของบ็อต
HUMAN การโต้ตอบกับมนุษย์

BotRepresentative

รายละเอียดสำหรับตัวแทนบ็อต

การแสดง JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
ช่อง
botMessagingAvailability

object (MessagingAvailability)

ต้องระบุ ความพร้อมใช้งานของการรับส่งข้อความของบ็อต

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)
    }
  ]
}
ช่อง
hours[]

object (Hours)

ต้องระบุ จำนวนชั่วโมงของความพร้อมในการรับส่งข้อความ

ชั่วโมง

ช่วงเวลาที่ให้บริการรับส่งข้อความ

การแสดง JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
ช่อง
startTime

object (TimeOfDay)

ต้องระบุ เวลาเริ่มต้นสำหรับแต่ละวันภายในช่วงวันของสัปดาห์
endTime

object (TimeOfDay)

ต้องระบุ เวลาสิ้นสุดสำหรับแต่ละวันภายในช่วงวันของสัปดาห์
timeZone

string

ต้องระบุ เขตเวลา IANA สำหรับชั่วโมง เช่น "America/Los_Angeles"
startDay

enum (DayOfWeek)

ต้องระบุ วันที่เริ่มต้น
endDay

enum (DayOfWeek)

ต้องระบุ วันที่สิ้นสุด รวมวันที่ระบุ

TimeOfDay

แสดงช่วงเวลาของวัน วันที่และเขตเวลาไม่มีความสำคัญหรือมีการระบุไว้ที่อื่น API อาจเลือกอนุญาตการใช้เวลาไม่กี่วินาที ประเภทที่เกี่ยวข้องคือ google.type.Date และ google.protobuf.Timestamp

การแสดง JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
ช่อง
hours

integer

ชั่วโมงของวันในรูปแบบ 24 ชั่วโมง ควรอยู่ในช่วง 0 ถึง 23 API อาจเลือกอนุญาตค่า "24:00:00" สำหรับสถานการณ์ต่างๆ เช่น เวลาปิดทำการ
minutes

integer

นาทีต่อชั่วโมง ต้องอยู่ระหว่าง 0 ถึง 59
seconds

integer

เวลาเป็นวินาที โดยปกติต้องอยู่ระหว่าง 0 ถึง 59 API อาจอนุญาตให้ใช้ค่า 60 หากอนุญาตให้มีวินาทีอธิกวาร
nanos

integer

เศษส่วนของวินาทีในหน่วยนาโนวินาที ต้องมีค่าตั้งแต่ 0 ถึง 999,999,999

วันของสัปดาห์

แสดงวันของสัปดาห์

Enum
DAY_OF_WEEK_UNSPECIFIED ไม่ระบุวันของสัปดาห์
MONDAY วันจันทร์
TUESDAY อังคาร
WEDNESDAY พุธ
THURSDAY พฤหัสบดี
FRIDAY ศุกร์
SATURDAY เสาร์
SUNDAY วันอาทิตย์

HumanRepresentative

รายละเอียดสำหรับตัวแทนที่เป็นมนุษย์

การแสดง JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
ช่อง
humanMessagingAvailability

object (MessagingAvailability)

ต้องระบุ ความพร้อมให้บริการของการรับส่งข้อความโดยเจ้าหน้าที่

AuthorizationConfig

รายละเอียดการกำหนดค่าสำหรับการรองรับ OAuth ใน Business Messages

การแสดง JSON 
{
  "endpointUrl": string
}
ช่อง
endpointUrl

string

URL ปลายทางที่ผู้ใช้เข้าสู่ระบบ

NonLocalConfig

การกำหนดค่าเพื่อเปิดใช้จุดแรกเข้านอกเครื่อง

การแสดง JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
ช่อง
contactOption

object (ContactOption)

ต้องระบุ ข้อมูลติดต่อสำหรับตัวแทนที่แสดงพร้อมปุ่มรับส่งข้อความ
enabledDomains[]

string

ต้องระบุ โดเมนที่จะเปิดใช้สำหรับจุดแรกเข้าของไซต์ลิงก์
phoneNumber

object (Phone)

ต้องระบุ หมายเลขโทรศัพท์ของตัวแทน ลบล้างช่อง phone สำหรับการสนทนาที่เริ่มต้นจากจุดแรกเข้านอกพื้นที่ ระบบจะใช้หมายเลขโทรศัพท์นี้กับภูมิภาคที่กำหนดค่าไว้ทั้งหมด
callDeflectionPhoneNumbers[]

object (Phone)

ต้องระบุ รายการหมายเลขโทรศัพท์สำหรับการเบี่ยงเบนการโทร
regionCodes[]

string

ต้องระบุ รายการรหัสภูมิภาค CLDR สำหรับประเทศที่อนุญาตให้ตัวแทนเปิดใช้จุดแรกเข้า NON_LOCAL จำเป็นสำหรับจุดแรกเข้า NON_LOCAL จุด

ContactOption

รายละเอียดการติดต่อที่แสดงเพิ่มเติมจากปุ่มรับส่งข้อความ

การแสดง JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
ช่อง
url

string

ต้องระบุ URL ที่มีตัวเลือกการติดต่อ
options[]

enum (Option)

ต้องระบุ รายการตัวเลือกการติดต่อที่มีอยู่สำหรับ URL ที่ระบุ

ตัวเลือก

ตัวเลือกการติดต่อ

Enum
OPTION_UNSPECIFIED ไม่ระบุ
WEB_CHAT ตัวเลือกการแชทผ่านเว็บ
PHONE ตัวเลือกโทรศัพท์
EMAIL ตัวเลือกอีเมล
FAQS ตัวเลือกคำถามที่พบบ่อย
TWITTER ตัวเลือก Twitter
WHATSAPP ตัวเลือก WhatsApp

SurveyConfig

รายละเอียดการกำหนดค่าสำหรับการสนับสนุนคำถามในแบบสำรวจที่มีการปรับแต่ง

การแสดง JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
ช่อง
templateQuestionIds[]

string

รายการรหัสคำถามเทมเพลตสำหรับคำถามของเทมเพลตที่รวมอยู่ในแบบสำรวจ
customSurveys

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

คำถามในแบบสำรวจที่กำหนดเองสำหรับตัวแทนที่แมปกับภาษา ภาษาจะแสดงด้วยแท็กภาษา IETF BCP 47 ที่มีรูปแบบถูกต้อง

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

CustomSurveyConfig

การกำหนดค่าแบบสำรวจที่กำหนดเองสำหรับ Agent

การแสดง JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
ช่อง
customQuestions[]

object (SurveyQuestion)

รายการคำถามที่กำหนดเอง

SurveyQuestion

เนื้อหาโดยละเอียดของคำถามในแบบสำรวจแต่ละข้อ

การแสดง JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
ช่อง
name

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันของคำถาม
questionType

enum (Type)

เอาต์พุตเท่านั้น ประเภทของคำถาม
questionContent

string

ต้องระบุ เนื้อหาของคำถาม มีอักขระได้ไม่เกิน 200 ตัวสำหรับคำถามที่กำหนดเอง
responseOptions[]

object (SurveyResponse)

ต้องระบุ รายการคำตอบที่แสดงพร้อมกับคำถาม สูงสุด 12 เครื่อง

ประเภท

ประเภทของคำถามในแบบสำรวจ

Enum
TYPE_UNSPECIFIED ประเภทคำถามในแบบสำรวจที่ไม่รู้จัก
GOOGLE_STANDARD_QUESTION คำถามในแบบสำรวจมาตรฐานของ Google
GOOGLE_TEMPLATE_QUESTION Google ได้ให้เทมเพลตคำถามในแบบสำรวจ
PARTNER_CUSTOM_QUESTION คำถามในแบบสำรวจที่พาร์ทเนอร์กำหนดเอง

SurveyResponse

เนื้อหาสำหรับการตอบคำถามในแบบสำรวจ

การแสดง JSON 
{
  "content": string,
  "postbackData": string
}
ช่อง
content

string

ต้องระบุ ข้อความที่แสดงในแบบสำรวจและส่งกลับให้ตัวแทนเมื่อผู้ใช้แตะที่ตัวแทน สูงสุด 35 อักขระ
postbackData

string

สตริงที่ Agent ได้รับเมื่อผู้ใช้แตะคำตอบของคำถาม

เมธอด

create

 สร้างตัวแทนใหม่เพื่อเป็นตัวแทนแบรนด์

delete

 ลบตัวแทน

get

 ดูข้อมูลเกี่ยวกับตัวแทน

getLaunch

 รับข้อมูลการเปิดใช้สำหรับตัวแทน

getVerification

 รับข้อมูลการยืนยันสำหรับตัวแทน

list

 แสดงตัวแทนทั้งหมดที่เชื่อมโยงกับแบรนด์

patch

 อัปเดตข้อมูลเกี่ยวกับตัวแทน

requestLaunch

 เริ่มกระบวนการเปิดใช้งานสำหรับตัวแทน

requestVerification

 เริ่มการยืนยันข้อมูลธุรกิจสำหรับตัวแทน

updateLaunch

 อัปเดตข้อมูลการเปิดใช้สำหรับตัวแทน

updateVerification

 อัปเดตสถานะการยืนยันสำหรับตัวแทน