Method: properties.batchRunPivotReports

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

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

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

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

पाथ पैरामीटर

पैरामीटर
property

string

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

उदाहरण: properties/1234

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

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

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

object (RunPivotReportRequest)

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

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

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

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

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

object (RunPivotReportResponse)

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

string

इससे पता चलता है कि यह मैसेज किस तरह का रिसॉर्स है. इस kind की वैल्यू हमेशा "analyticsData#batchRunPivotReports" होती है. JSON में, जवाब के टाइप के बीच अंतर करने के लिए यह फ़ील्ड काम का है.

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

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

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

RunPivotReportRequest

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

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

string

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

उदाहरण: properties/1234
dimensions[]

object (Dimension)

अनुरोध किए गए डाइमेंशन. डिफ़ाइन किए गए सभी डाइमेंशन का इस्तेमाल, इनमें से किसी एक के लिए किया जाना चाहिए: dimensionExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

अनुरोध की गई मेट्रिक. कम से कम एक मेट्रिक की वैल्यू सबमिट करना ज़रूरी है. डिफ़ाइन की गई सभी मेट्रिक का इस्तेमाल, इनमें से किसी एक के लिए किया जाना चाहिए: metric_expression, metricFilter, orderBys.
dateRanges[]

object (DateRange)

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

object (Pivot)

इससे पता चलता है कि रिपोर्ट के डाइमेंशन, कॉलम या लाइनों में किस फ़ॉर्मैट में दिखेंगे. सभी पिवट में मौजूद fieldNames (डाइमेंशन के नाम) का यूनियन, डाइमेंशन में डिफ़ाइन किए गए डाइमेंशन के नामों का सबसेट होना चाहिए. कोई भी दो पिवट, एक ही डाइमेंशन शेयर नहीं कर सकते. कोई डाइमेंशन सिर्फ़ तब दिखता है, जब वह पिवट में शामिल हो.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

मेट्रिक का फ़िल्टर क्लॉज़. यह पोस्ट एग्रीगेशन फ़ेज़ पर लागू होता है. यह SQL के having-clause की तरह होता है. इस फ़िल्टर में इस्तेमाल की जाने वाली मेट्रिक के लिए अनुरोध करना ज़रूरी है. इस फ़िल्टर में डाइमेंशन का इस्तेमाल नहीं किया जा सकता.
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 फ़ील्ड और comparisons डाइमेंशन, दोनों की वैल्यू सबमिट करना ज़रूरी है.