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

המזהה הייחודי של הנציג.

קריאה בלבד. מוגדר על ידי הפלטפורמה.
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 של הלוגו של הנציג זמינה לכולם. עד 50KB.

אי אפשר לשנות את ההגדרות אחרי אימות הנציג.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

אפשרות. רשימת ההגדרות של נקודת הכניסה

אי אפשר לשנות את ההגדרות אחרי אימות הנציג.
conversationalSettings

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

חובה. הגדרות השיחה של נציג התמיכה, ממופות ללוקאל. הלוקאל מיוצג על ידי תג שפה בפורמט IETF BCP 47 שמוגדר היטב.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }
defaultLocale

string

חובה. לוקאל ברירת המחדל של הנציג. חייב להתאים ללוקאל שמוגדר ב-conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

חובה. פרטי האינטראקציה של הנציג הראשי. משמש כשמשתמש יוזם שיחה.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

אפשרות. מידע נוסף על האינטראקציה עם הנציג. הסוכן יכול לתמוך בכמה סוגים של אינטראקציות.
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

ההגדרה של נקודת הכניסה לנציג.

ייצוג JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
שדות
allowedEntryPoint

enum (EntryPoint)

חובה. הפלטפורמות של Google שבהן אפשר להציג את הנציג.

EntryPoint

הפלטפורמות של Google שבהן אפשר להציג את הנציג.

טיפוסים בני מנייה (enums)
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

סוג האינטראקציה שנתמכת על ידי הנציג.

טיפוסים בני מנייה (enums)
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.

DayOfWeek

מייצג את היום בשבוע.

טיפוסים בני מנייה (enums)
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

חובה. דומיינים שיש להפעיל עבור נקודת הכניסה של קישורי ה-Sitelink.
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)

חובה. רשימת האפשרויות הזמינות ליצירת קשר עבור כתובת האתר שצוינה.

אפשרות

אפשרויות ליצירת קשר.

טיפוסים בני מנייה (enums)
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.

תיאור

סוג השאלה בסקר.

טיפוסים בני מנייה (enums)
TYPE_UNSPECIFIED סוג השאלה לא ידוע בסקר.
GOOGLE_STANDARD_QUESTION שאלת סקר רגילה של Google.
GOOGLE_TEMPLATE_QUESTION תבנית של שאלת סקר ש-Google סיפקה.
PARTNER_CUSTOM_QUESTION שאלת סקר בהתאמה אישית של שותף.

SurveyResponse

התוכן של התשובה לשאלה בסקר.

ייצוג JSON 
{
  "content": string,
  "postbackData": string
}
שדות
content

string

חובה. הטקסט שמוצג בסקר ונשלח לנציג כשהמשתמש מקיש עליו. 35 תווים לכל היותר.
postbackData

string

המחרוזת שהנציג מקבל כשהמשתמש מקיש על התשובה לשאלה.

שיטות

create

 יצירת נציג חדש לייצוג מותג.

delete

 מחיקת נציג.

get

 קבלת מידע על נציג תמיכה.

getLaunch

 קבלת פרטי ההפעלה של נציג.

getVerification

 הפונקציה מקבלת את פרטי האימות של נציג.

list

 כל הנציגים שמשויכים למותג מסוים.

patch

 עדכון מידע על נציג.

requestLaunch

 התחלת תהליך ההפעלה של נציג.

requestVerification

 מתחיל את אימות פרטי העסק של הנציג.

updateLaunch

 עדכון פרטי ההפעלה של הנציג.

updateVerification

 עדכון מצב האימות של הנציג.