Method: analytics.agentPerformances.list

इससे एजेंट की परफ़ॉर्मेंस का वह डेटा दिखता है जिसे कॉल करने वाला व्यक्ति ऐक्सेस कर सकता है.

हर नतीजे में, किसी खास देश में किसी एजेंट की परफ़ॉर्मेंस मेट्रिक दिखती हैं. अगर किसी देश के लिए किसी एजेंट के पास ज़रूरत के मुताबिक डेटा नहीं है, तो उस एजेंट और देश के लिए परफ़ॉर्मेंस का कोई रिकॉर्ड नहीं दिखाया जाता.

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

ज़रूरी नहीं. सर्वर के लिए, ज़्यादा से ज़्यादा नतीजों की संख्या तय करें. सर्वर, हर पेज पर दिखाए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या को और भी सीमित कर सकता है. अगर pageSize की वैल्यू 0 है, तो सर्वर यह तय करेगा कि कितने नतीजे दिखाए जाएं. pageSize की ज़्यादा से ज़्यादा वैल्यू 1,000 हो सकती है.
pageToken

string

ज़रूरी नहीं. पिछली सूची के अनुरोध के जवाब में मिला nextPageToken वैल्यू (अगर कोई हो).

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

इससे एजेंट की परफ़ॉर्मेंस की सूची दिखती है.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है:

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)

वह टाइमस्टैंप जिससे उस अवधि के खत्म होने का पता चलता है जिसके लिए मेट्रिक कैलकुलेट की गई थीं. प्रतिष्ठा के साथ-साथ अन्य मेट्रिक, इस टाइमस्टैंप तक के डेटा के आधार पर कैलकुलेट की जाती हैं. यह टाइमस्टैंप, पैसिफ़िक समय (पीटी) के हिसाब से सबसे हाल ही की आधी रात का है.

यह आरएफ़सी 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)

सात दिनों की अवधि के लिए स्पैम का रुझान.
spamTrendDays28

enum (TrendDirection)

28 दिनों की अवधि के लिए स्पैम का रुझान.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

सात दिनों की अवधि के लिए, एजेंट की सदस्यता रद्द करने की वजह से जुड़ी मेट्रिक.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

28 दिनों की अवधि के लिए, एजेंट की सदस्यता रद्द करने की वजह से जुड़ी मेट्रिक.

प्रतिष्ठा

दिए गए देश में एजेंट की प्रतिष्ठा.

Enums
REPUTATION_UNSPECIFIED प्रतिष्ठा की जानकारी नहीं दी गई है.
LOW कम प्रतिष्ठा. यह डिफ़ॉल्ट प्रतिष्ठा है.
MEDIUM कुछ प्रतिष्ठा.
HIGH ज़्यादा प्रतिष्ठा.

TrendDirection

इससे पता चलता है कि किसी तय अवधि में, किसी मेट्रिक में कितना बदलाव हुआ है.

Enums
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

उन उपयोगकर्ताओं का प्रतिशत जिन्होंने सदस्यता रद्द करने की वजह के तौर पर "कोई और वजह" को चुना.