Method: analytics.agentPerformances.list

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

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

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

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

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

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

पैरामीटर
pageSize

integer

ज़रूरी नहीं. सर्वर से मिलने वाले नतीजों की ज़्यादा से ज़्यादा संख्या तय करें. सर्वर, एक पेज पर दिखाए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या को और भी सीमित कर सकता है. अगर pageSize की वैल्यू 0 है, तो सर्वर यह तय करेगा कि कितने नतीजे दिखाए जाएं. ज़्यादा से ज़्यादा 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 ऐल्फ़ा-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

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