Method: properties.batchRunReports

एक बैच में कई रिपोर्ट दिखाता है. सभी रिपोर्ट, एक ही Google Analytics प्रॉपर्टी के लिए होनी चाहिए.

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

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

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

पाथ पैरामीटर

पैरामीटर
property

string

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

उदाहरण: properties/1234

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

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

JSON के काेड में दिखाना 
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
फ़ील्ड
requests[]

object (RunReportRequest)

अलग-अलग अनुरोध. हर अनुरोध के लिए, रिपोर्ट का अलग जवाब मिलता है. बैच में भेजे जाने वाले हर अनुरोध में, ज़्यादा से ज़्यादा पांच अनुरोध शामिल किए जा सकते हैं.

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

बैच में मिले जवाब में कई रिपोर्ट शामिल होती हैं.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
फ़ील्ड
reports[]

object (RunReportResponse)

अलग-अलग जवाब. हर जवाब के लिए, रिपोर्ट का अलग अनुरोध होता है.
kind

string

इससे पता चलता है कि यह मैसेज किस तरह का संसाधन है. यह kind हमेशा "analyticsData#batchRunReports" स्ट्रिंग होती है. JSON में, जवाब के टाइप के बीच अंतर करने के लिए यह काम की होती है.

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

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

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

RunReportRequest

यह रिपोर्ट जनरेट करने का अनुरोध है.

JSON के काेड में दिखाना 
{
  "property": string,
  "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)
    }
  ]
}
फ़ील्ड
property

string

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

उदाहरण: properties/1234
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 फ़ील्ड की ज़रूरत होती है.