Method: analytics.agentPerformances.list

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

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

בקשת HTTP

GET https://businesscommunications.googleapis.com/v1/analytics/agentPerformances

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים

פרמטרים
`pageSize`	`integer` אופציונלי. מציינים את המספר המקסימלי של התוצאות שיוחזרו על ידי השרת. השרת יכול להגביל עוד יותר את המספר המקסימלי של התוצאות שמוחזרות בדף אחד. אם הערך של pageSize הוא 0, השרת יחליט כמה תוצאות להחזיר. הערך המקסימלי של pageSize הוא 1,000.
`pageToken`	`string` אופציונלי. הערך של nextPageToken שמוחזר מבקשת List קודמת, אם יש כזה.

pageSize

integer

אופציונלי. מציינים את המספר המקסימלי של התוצאות שיוחזרו על ידי השרת. השרת יכול להגביל עוד יותר את המספר המקסימלי של התוצאות שמוחזרות בדף אחד. אם הערך של pageSize הוא 0, השרת יחליט כמה תוצאות להחזיר. הערך המקסימלי של pageSize הוא 1,000.

pageToken

string

אופציונלי. הערך של nextPageToken שמוחזר מבקשת List קודמת, אם יש כזה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

מחזירה רשימה של ביצועי סוכנים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON
{ "agentPerformances": [ { object (`AgentPerformance`) } ], "nextPageToken": string }

שדות

שדות
`agentPerformances[]`	`object (AgentPerformance)` רשימה של ביצועי נציגים.
`nextPageToken`	`string` אופציונלי. אסימון העימוד לאחזור של דף התוצאות הבא. אם הערך הוא "", המשמעות היא שאין תוצאות נוספות לבקשה.

agentPerformances[]

object (AgentPerformance)

רשימה של ביצועי נציגים.

nextPageToken

string

אופציונלי. אסימון העימוד לאחזור של דף התוצאות הבא. אם הערך הוא "", המשמעות היא שאין תוצאות נוספות לבקשה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

https://www.googleapis.com/auth/businesscommunications

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

AgentPerformance

מדדי ביצועים של סוכן במדינה.

ייצוג ב-JSON

ייצוג ב-JSON
{ "name": string, "displayName": string, "countryCode": string, "agentUseCase": enum (`AgentUseCase`), "reputation": enum (`Reputation`), "trafficLimit": integer, "metricsPeriodEndTime": string, "spamTrendDays7": enum (`TrendDirection`), "spamTrendDays28": enum (`TrendDirection`), "agentUnsubscribeReasonMetricsDays7": { object (`AgentUnsubscribeReasonMetrics`) }, "agentUnsubscribeReasonMetricsDays28": { object (`AgentUnsubscribeReasonMetrics`) } }

{
  "name": string,
  "displayName": string,
  "countryCode": string,
  "agentUseCase": enum (AgentUseCase),
  "reputation": enum (Reputation),
  "trafficLimit": integer,
  "metricsPeriodEndTime": string,
  "spamTrendDays7": enum (TrendDirection),
  "spamTrendDays28": enum (TrendDirection),
  "agentUnsubscribeReasonMetricsDays7": {
    object (AgentUnsubscribeReasonMetrics)
  },
  "agentUnsubscribeReasonMetricsDays28": {
    object (AgentUnsubscribeReasonMetrics)
  }
}

שדות
`name`	`string` המזהה הייחודי של הסוכן. מוגדר על ידי הפלטפורמה.
`displayName`	`string` חובה. השם שהנציג מציג למשתמשים. ‫40 תווים לכל היותר. אי אפשר לשנות את ההגדרה הזו אחרי אימות הנציג.
`countryCode`	`string` מאפיין המדינה של מדדי הביצועים שצוינו. קוד המדינה צריך להיות בפורמט ISO 3166 Alpha-2. לדוגמה, "US" לארצות הברית של אמריקה.
`agentUseCase`	`enum (AgentUseCase)` תרחיש השימוש של הנציג
`reputation`	`enum (Reputation)` המוניטין של הסוכן במדינה הנתונה.
`trafficLimit`	`integer` ההגבלה על תעבורת הנתונים של הסוכן (מספר ההודעות למשתמש בחודש) במדינה הנתונה. אם הסוכן לא כפוף למגבלות תנועה, הערך לא יוגדר.
`metricsPeriodEndTime`	`string (Timestamp format)` חותמת הזמן שמייצגת את סוף התקופה שעבורה חושבו המדדים. החישוב של המדדים, כולל המוניטין, מבוסס על נתונים עד חותמת הזמן הזו. חותמת הזמן הזו היא חצות האחרון לפי שעון החוף המערבי בארה"ב. הערה: בגלל העיבוד היומי שמתבצע אחרי חצות לפי שעון החוף הפסיפי (PT), יכול להיות שהמדדים לא יתעדכנו עד כמה שעות אחרי חצות לפי שעון החוף הפסיפי. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: `"2014-10-02T15:01:23Z"`, ‏ `"2014-10-02T15:01:23.045123456Z"` או `"2014-10-02T15:01:23+05:30"`.
`spamTrendDays7`	`enum (TrendDirection)` מגמת הספאם לתקופה של 7 ימים.
`spamTrendDays28`	`enum (TrendDirection)` מגמת הספאם לתקופה של 28 ימים.
`agentUnsubscribeReasonMetricsDays7`	`object (AgentUnsubscribeReasonMetrics)` מדדים של סיבות להסרת סוכן במהלך תקופה של 7 ימים.
`agentUnsubscribeReasonMetricsDays28`	`object (AgentUnsubscribeReasonMetrics)` מדדים של סיבות לביטול הרשמה לסוכן לתקופה של 28 ימים.

מוניטין

המוניטין של הסוכן במדינה הנתונה.

טיפוסים בני מנייה (enum)
`REPUTATION_UNSPECIFIED`	מוניטין לא מוגדר.
`LOW`	מוניטין נמוך.
`MEDIUM`	מוניטין בינוני. זוהי הרמה שמוגדרת כברירת מחדל.
`HIGH`	מוניטין גבוה.

TrendDirection

מוצג השינוי במדד מסוים במהלך תקופה נתונה.

טיפוסים בני מנייה (enum)
`TREND_DIRECTION_UNSPECIFIED`	כיוון המגמה לא צוין.
`DOWN`	המגמה היא ירידה.
`NEUTRAL`	המגמה לא השתנתה.
`UP`	המגמה היא עלייה.

AgentUnsubscribeReasonMetrics

מדדים של סיבות להסרת סוכן מרשימת התפוצה בתקופה נתונה.

ייצוג ב-JSON
{ "notSignedUpPercentage": integer, "tooManyMessagesPercentage": integer, "noLongerInterestedPercentage": integer, "spamPercentage": integer, "otherPercentage": integer }

שדות
`notSignedUpPercentage`	`integer` אחוז המשתמשים שבחרו באפשרות 'לא נרשמתי' כסיבה להסרת ההרשמה.
`tooManyMessagesPercentage`	`integer` אחוז המשתמשים שבחרו באפשרות 'יותר מדי הודעות' כסיבה לביטול ההרשמה.
`noLongerInterestedPercentage`	`integer` אחוז המשתמשים שבחרו באפשרות 'לא מעניין אותי יותר' כסיבה לביטול המינוי.
`spamPercentage`	`integer` אחוז המשתמשים שבחרו באפשרות 'ספאם' כסיבה לביטול ההרשמה.
`otherPercentage`	`integer` אחוז המשתמשים שבחרו באפשרות 'אחר' כסיבה לביטול המינוי.