Method: properties.runReport

इससे, आपके Google Analytics इवेंट डेटा की मनमुताबिक रिपोर्ट बनाई जाती है. रिपोर्ट में, Google Analytics के ट्रैकिंग कोड से इकट्ठा किए गए डेटा से हासिल किए गए आंकड़े शामिल होते हैं. एपीआई से मिला डेटा, टेबल के तौर पर होता है. इसमें अनुरोध किए गए डाइमेंशन और मेट्रिक के कॉलम शामिल होते हैं. मेट्रिक, आपकी प्रॉपर्टी पर उपयोगकर्ता की गतिविधि के अलग-अलग मेज़रमेंट होते हैं. जैसे, सक्रिय उपयोगकर्ता या इवेंट की संख्या. डाइमेंशन, कुछ सामान्य शर्तों के आधार पर मेट्रिक को तोड़ते हैं. जैसे, देश या इवेंट का नाम.

अनुरोध बनाने और जवाबों को समझने के बारे में जानकारी पाने के लिए, रिपोर्ट बनाना लेख पढ़ें.

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

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

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

पाथ पैरामीटर

पैरामीटर
property

string

यह Google Analytics की उस प्रॉपर्टी का आइडेंटिफ़ायर है जिसके इवेंट ट्रैक किए जाते हैं. यह यूआरएल पाथ में दिया जाता है, न कि मुख्य हिस्से में. ज़्यादा जानने के लिए, प्रॉपर्टी आईडी ढूंढने का तरीका देखें. बैच अनुरोध में, इस प्रॉपर्टी की वैल्यू या तो तय नहीं की जानी चाहिए या बैच-लेवल की प्रॉपर्टी के मुताबिक होनी चाहिए.

उदाहरण: properties/1234

अनुरोध का मुख्य हिस्सा

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
फ़ील्ड
dimensions[]

object (Dimension)

अनुरोध किए गए और दिखाए गए डाइमेंशन.
metrics[]

object (Metric)

अनुरोध की गई और दिखाई गई मेट्रिक.
dateRanges[]

object (DateRange)

डेटा की वे तारीख की सीमाएं जिन्हें पढ़ना है. अगर तारीख की एक से ज़्यादा सीमाओं का अनुरोध किया जाता है, तो जवाब की हर पंक्ति में, शून्य पर आधारित तारीख की सीमा का इंडेक्स शामिल होगा. अगर तारीख की दो सीमाएं ओवरलैप होती हैं, तो ओवरलैप होने वाले दिनों का इवेंट डेटा, तारीख की दोनों सीमाओं के लिए जवाब की पंक्तियों में शामिल किया जाता है. कोहॉर्ट के अनुरोध में, इस dateRanges की वैल्यू तय नहीं की जानी चाहिए.
dimensionFilter

object (FilterExpression)

डाइमेंशन फ़िल्टर की मदद से, रिपोर्ट में सिर्फ़ डाइमेंशन की खास वैल्यू का अनुरोध किया जा सकता है. उदाहरणों के लिए, डाइमेंशन फ़िल्टर की बुनियादी बातें देखें. इस फ़िल्टर में मेट्रिक का इस्तेमाल नहीं किया जा सकता.
metricFilter

object (FilterExpression)

मेट्रिक का फ़िल्टर क्लॉज़. यह रिपोर्ट की पंक्तियों को एग्रीगेट करने के बाद लागू किया जाता है. यह SQL के having-clause की तरह होता है. इस फ़िल्टर में डाइमेंशन का इस्तेमाल नहीं किया जा सकता.
offset

string (int64 format)

शुरू होने वाली पंक्ति की संख्या. पहली पंक्ति को पंक्ति 0 के तौर पर गिना जाता है.

पेज पर नंबर डालने के दौरान, पहले अनुरोध में ऑफ़सेट की वैल्यू तय नहीं की जाती. इसके अलावा, ऑफ़सेट की वैल्यू 0 पर सेट की जाती है. पहले अनुरोध में, पंक्तियों की पहली limit वैल्यू दिखती है. दूसरे अनुरोध में, ऑफ़सेट की वैल्यू पहले अनुरोध की limit वैल्यू पर सेट की जाती है. दूसरे अनुरोध में, पंक्तियों की दूसरी limit वैल्यू दिखती है.

पेज पर नंबर डालने के इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज पर नंबर डालना लेख पढ़ें.
limit

string (int64 format)

कितनी पंक्तियां लौटानी हैं, इसे बताने वाली संख्या. अगर इसकी वैल्यू तय नहीं की जाती है, तो 10,000 पंक्तियां लौटाई जाती हैं. एपीआई, हर अनुरोध के लिए ज़्यादा से ज़्यादा 2,50,000 पंक्तियां लौटाता है. भले ही, आपने कितनी भी पंक्तियों का अनुरोध किया हो. limit की वैल्यू पॉज़िटिव होनी चाहिए.

अगर limit की वैल्यू के बराबर डाइमेंशन वैल्यू नहीं हैं, तो एपीआई, अनुरोध की गई limit से कम पंक्तियां भी लौटा सकता है. उदाहरण के लिए, country डाइमेंशन के लिए 300 से कम संभावित वैल्यू हैं. इसलिए, सिर्फ़ country पर रिपोर्ट करते समय, आपको 300 से ज़्यादा पंक्तियां नहीं मिल सकतीं. भले ही, आपने limit की वैल्यू ज़्यादा सेट की हो.

पेज पर नंबर डालने के इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज पर नंबर डालना लेख पढ़ें.
metricAggregations[]

enum (MetricAggregation)

मेट्रिक का एग्रीगेशन. एग्रीगेट की गई मेट्रिक वैल्यू, उन पंक्तियों में दिखेंगी जहां dimensionValues की वैल्यू "RESERVED_(MetricAggregation)" पर सेट है. तुलनाओं और तारीख की एक से ज़्यादा सीमाओं वाले एग्रीगेट, तारीख की सीमाओं के आधार पर एग्रीगेट किए जाएंगे.
orderBys[]

object (OrderBy)

इससे यह तय होता है कि जवाब में पंक्तियों को किस क्रम में दिखाया जाए. तुलनाओं और तारीख की एक से ज़्यादा सीमाओं वाले अनुरोधों पर, तुलनाओं के आधार पर क्रम लागू किया जाएगा.
currencyCode

string

ISO4217 फ़ॉर्मैट में मुद्रा का कोड. जैसे, "AED", "USD", "JPY". अगर यह फ़ील्ड खाली है, तो रिपोर्ट में प्रॉपर्टी की डिफ़ॉल्ट मुद्रा का इस्तेमाल किया जाता है.
cohortSpec

object (CohortSpec)

इस अनुरोध से जुड़ा कोहॉर्ट ग्रुप. अगर अनुरोध में कोहॉर्ट ग्रुप शामिल है, तो 'कोहॉर्ट' डाइमेंशन मौजूद होना चाहिए.
keepEmptyRows

boolean

अगर इसकी वैल्यू 'गलत' है या इसकी वैल्यू तय नहीं की गई है, तो ऐसी हर पंक्ति नहीं दिखाई जाएगी जिसमें सभी मेट्रिक की वैल्यू 0 है. अगर इसकी वैल्यू 'सही' है, तो ये पंक्तियां तब दिखाई जाएंगी, जब इन्हें किसी फ़िल्टर की मदद से अलग से नहीं हटाया गया हो.

keepEmptyRows की इस सेटिंग के बावजूद, रिपोर्ट में सिर्फ़ Google Analytics प्रॉपर्टी से रिकॉर्ड किया गया डेटा दिखाया जा सकता है.

उदाहरण के लिए, अगर कोई प्रॉपर्टी कभी भी purchase इवेंट लॉग नहीं करती है, तो eventName डाइमेंशन और eventCount मेट्रिक के लिए क्वेरी में, eventName: "purchase" और eventCount: 0 वाली पंक्ति नहीं दिखेगी.
returnPropertyQuota

boolean

इससे यह तय होता है कि Google Analytics की इस प्रॉपर्टी के मौजूदा कोटे की जानकारी दिखानी है या नहीं. कोटा, PropertyQuota में दिखता है.
comparisons[]

object (Comparison)

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

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में RunReportResponse का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

इसके लिए, OAuth की इनमें से किसी एक अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics