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)

मेट्रिक का एग्रीगेशन. एग्रीगेट की गई मेट्रिक वैल्यू उन पंक्तियों में दिखेंगी जहां डाइमेंशन वैल्यू "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)

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

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

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

अनुमति के दायरे

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

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