REST Resource: brands.agents

משאב: Agent

ישות בשיחה שמייצגת מותג.

ייצוג JSON 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // 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.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

מידע מפורט על נציגי התמיכה של RCS Business Messaging.

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)

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

אפשרות

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

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

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

RcsBusinessMessagingAgent

פרטי הנציג שקשורים ספציפית ל-RCS Business Messaging.

ייצוג JSON 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
שדות
description

string

חובה. תיאור הנציג שגלוי למשתמשים. 100 תווים לכל היותר.
logoUri

string

חובה. כתובת ה-URL של הלוגו של הנציג זמינה לכולם. 50KB לכל היותר.

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

string

חובה. כתובת ה-URL של התמונה הראשית (Hero) של הנציג, שזמינה לכולם. עד 200KB.

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

object (PhoneEntry)

חובה. מספרי טלפון שמשויכים לנציג.
emails[]

object (EmailEntry)

זה שינוי אופציונלי. כתובות האימייל שמשויכות לנציג.
websites[]

object (WebEntry)

זה שינוי אופציונלי. אתרים שמשויכים לנציג. 3 לכל היותר.
privacy

object (WebEntry)

חובה. מדיניות הפרטיות שמשויכת לנציג.
termsConditions

object (WebEntry)

חובה. התנאים וההגבלות שקשורים לנציג.
color

string

חובה. צבע העיצוב של הנציג שגלוי למשתמשים בפורמט הקסדצימלי. לדוגמה, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

חובה. הגדרות החיוב של הנציג.
agentUseCase

enum (AgentUseCase)

זה שינוי אופציונלי. תרחיש השימוש של הבוט.
hostingRegion

enum (HostingRegion)

חובה. אזור אירוח של נציג.

PhoneEntry

מספר טלפון שמשויך לנציג.

ייצוג JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
שדות
phoneNumber

object (Phone)

חובה. מספר טלפון בפורמט E.164. לדוגמה, +12223334444.
label

string

חובה. התווית של מספר הטלפון.

EmailEntry

כתובת אימייל שמשויכת לנציג.

ייצוג JSON 
{
  "address": string,
  "label": string
}
שדות
address

string

חובה. כתובת אימייל.
label

string

חובה. התווית של כתובת האימייל.

WebEntry

משאב מבוסס-אינטרנט שמשויך לנציג.

ייצוג JSON 
{
  "uri": string,
  "label": string
}
שדות
uri

string

חובה. מזהה URI גלוי לכולם שמשויך לנציג. חובה להשתמש בפרוטוקול HTTP או HTTPS.
label

string

זה שינוי אופציונלי. תווית של ה-URI.

RcsBusinessMessagingAgentBillingConfig

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

ייצוג JSON 
{
  "billingCategory": enum (BillingCategory)
}
שדות
billingCategory

enum (BillingCategory)

קטגוריית החיוב של הנציג.

BillingCategory

קטגוריות חיוב נתמכות.

טיפוסים בני מנייה (enums)
BILLING_CATEGORY_UNSPECIFIED הקטגוריה לא צוינה.
CONVERSATIONAL_LEGACY קטגוריה מדור קודם לתמיכה בהגדרת החיוב של נציגים קיימים.
CONVERSATIONAL מיועד לסשנים ארוכים ומורכבים יותר שבהם המשתמש והמותג מחליפים סדרה של מסרים.
SINGLE_MESSAGE מחליף את SMS בחוויה עשירה יותר של העברת הודעות. מעולם לא חויבתי בתור CONVERSATIONAL.
BASIC_MESSAGE מודל החיוב דומה ל-SMS. מעולם לא חויבתי בתור CONVERSATIONAL.

AgentUseCase

סוגי התרחישים לדוגמה של הסוכן שבשימוש באחסון.

טיפוסים בני מנייה (enums)
AGENT_USE_CASE_UNSPECIFIED התרחיש לדוגמה לא צוין.
TRANSACTIONAL נציגים ששולחים רק הודעות חיוניות, נחוצות וקשורות לזמן.
PROMOTIONAL נציגים ששולחים הודעות שיווקיות, שיווק וקידום מכירות. סוג ברירת המחדל.
OTP סוכנים ששולחים רק סיסמאות חד-פעמיות.
MULTI_USE נציגים שיש להם כמה תרחישים לדוגמה.

HostingRegion

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

טיפוסים בני מנייה (enums)
HOSTING_REGION_UNSPECIFIED אזור אירוח לא מוגדר.
NORTH_AMERICA בצפון אמריקה.
EUROPE אירופה.
ASIA_PACIFIC אסיה והאוקיינוס השקט.

שיטות

create

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

delete
(deprecated)

 הוצאה משימוש: מחיקת הנציג הוצאה משימוש.

get

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

getLaunch

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

getVerification

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

list

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

patch

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

requestLaunch

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

requestVerification

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

updateLaunch

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

updateVerification

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