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

ต้องระบุ ชื่อที่ Agent แสดงให้ผู้ใช้เห็น ยาวไม่เกิน 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))

ต้องระบุ การตั้งค่าการสนทนาของตัวแทน ซึ่งแมปกับภาษาแล้ว ภาษาจะแสดงด้วยแท็กภาษา 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 ชม. วันพฤหัสบดี - วันศุกร์ * 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

DayOfWeek

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

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

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

การแสดง 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 รายการ

Type

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

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

 อัปเดตสถานะการยืนยันของตัวแทน