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)

मेट्रिक का फ़िल्टर क्लॉज़. यह एसक्यूएल 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)

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