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 Knowledge Graph, אם יש כזה.
authorizationConfig

object (AuthorizationConfig)

זה שינוי אופציונלי. הגדרות הרשאה לתמיכה ב-OAuth.
nonLocalConfig

object (NonLocalConfig)

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

object (SurveyConfig)

זה שינוי אופציונלי. הגדרה להפעלת סקרים בהתאמה אישית.

BusinessMessagesEntryPointConfig

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

ייצוג 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 (שעון קיץ, החוף המערבי בארה"ב) בימים שני עד רביעי * 10:00 עד 14:00 (שעון החוף המערבי בארה"ב) בימים חמישי עד שישי * 15:00 עד 18:00 (שעון קיץ, החוף המערבי בארה"ב) * 10:00 עד 14:00 (שעון קיץ, החוף המערבי בארה"ב)

אם יש פערים בזמינות, למשל אם לא צוינה זמינות ביום ראשון, העברת ההודעות לא תהיה זמינה במועדים האלה.

שעות הפעילות של הבוט לא משפיעות על הזמינות. נציגי בוטים תמיד מציגים הודעת פתיחה, ואילו נציגים שיש להם גם הגדרות אנושיות וגם נציגים של בוטים מביאים בחשבון רק נציגים אנושיים כשהם מגדירים את הזמינות.

ייצוג 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

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

חובה. רשימת האפשרויות ליצירת קשר הזמינות עבור כתובת ה-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 לכל היותר.

סוג

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

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

המחרוזת שהסוכן מקבל כשהמשתמש מקיש על התשובה לשאלה.

שיטות

create

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

delete

 מחיקת הנציג.

get

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

getLaunch

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

getVerification

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

list

 בתיבת הדו-שיח הזו מפורטים כל הנציגים שמשויכים למותג מסוים.

patch

 קבלת עדכונים בקשר לנציג.

requestLaunch

 התחלת תהליך ההשקה של הנציג.

requestVerification

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

updateLaunch

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

updateVerification

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