Method: analytics.agentPerformances.list

تعرِض هذه القائمة بيانات أداء الوكيل التي يمكن للمتصل الوصول إليها.

تمثّل كل نتيجة مقاييس الأداء لوكيل معيّن في بلد معيّن. إذا لم يتوفّر لدى الوكيل بيانات كافية لبلد معيّن، لن يتم عرض سجلّ الأداء لهذا الزوج من الوكيل والبلد.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات طلب البحث

المعلمات
pageSize

integer

اختياريّ. حدِّد الحد الأقصى لعدد النتائج التي سيعرضها الخادم. يمكن للخادم تقليل الحد الأقصى لعدد النتائج المعروضة في صفحة واحدة. إذا كانت قيمة `pageSize` هي 0، سيحدّد الخادم عدد النتائج التي سيتم عرضها. الحد الأقصى لقيمة `pageSize` هو 1000.
pageToken

string

اختياريّ. قيمة `nextPageToken` التي تم عرضها من طلب `List` سابق، إن توفّرت

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

تعرِض هذه القائمة أداء الوكلاء.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
الحقول
agentPerformances[]

object (AgentPerformance)

قائمة بأداء الوكلاء
nextPageToken

string

اختياريّ. رمز الترقيم لاسترداد الصفحة التالية من النتائج إذا كانت القيمة ""، يعني ذلك أنّه ما مِن نتائج أخرى للطلب.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

AgentPerformance

مقاييس أداء الوكيل في بلد معيّن

تمثيل 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

الحقل مطلوب. الاسم الذي يعرضه الوكيل للمستخدمين الحد الأقصى 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 يومًا

السمعة

سمعة الوكيل في البلد المحدّد

عمليات التعداد
REPUTATION_UNSPECIFIED سمعة غير محدّدة
LOW سمعة منخفضة هذه هي السمعة التلقائية.
MEDIUM سمعة متوسطة
HIGH سمعة عالية

TrendDirection

يوضّح هذا الحقل كيفية تغيُّر مقياس معيّن خلال فترة معيّنة.

عمليات التعداد
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

النسبة المئوية للمستخدمين الذين اختاروا "غير ذلك" كسبب لإلغاء الاشتراك