Method: properties.batchRunPivotReports

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

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

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

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

पाथ पैरामीटर

पैरामीटर
property

string

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

उदाहरण: property/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 की GA4 प्रॉपर्टी आइडेंटिफ़ायर, जिसके इवेंट ट्रैक किए जाते हैं. यूआरएल पाथ में बताया गया है, मुख्य हिस्से में नहीं. ज़्यादा जानने के लिए देखें कि आपका प्रॉपर्टी आईडी कहां मिलेगा. बैच में किए गए अनुरोध में, इस प्रॉपर्टी की जानकारी नहीं होनी चाहिए या बैच-लेवल की प्रॉपर्टी के हिसाब से होनी चाहिए.

उदाहरण: property/1234

dimensions[]

object (Dimension)

अनुरोध किए गए डाइमेंशन. तय किए गए सभी डाइमेंशन का इस्तेमाल इनमें से किसी एक के लिए किया जाना चाहिए: डाइमेंशनएक्सप्रेशन, डाइमेंशन फ़िल्टर, पिवट, ऑर्डर बाय.

metrics[]

object (Metric)

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

dateRanges[]

object (DateRange)

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

pivots[]

object (Pivot)

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

dimensionFilter

object (FilterExpression)

डाइमेंशन का फ़िल्टर क्लॉज़. इस फ़िल्टर में उपयोग करने के लिए आयामों का अनुरोध किया जाना चाहिए. इस फ़िल्टर में मीट्रिक का उपयोग नहीं किया जा सकता.

metricFilter

object (FilterExpression)

मेट्रिक का फ़िल्टर क्लॉज़. एसक्यूएल के 'क्लॉज़' की तरह, पोस्ट एग्रीगेशन फ़ेज़ पर लागू किया जाता है. इस फ़िल्टर में मेट्रिक का इस्तेमाल करने के लिए अनुरोध करना ज़रूरी है. इस फ़िल्टर में आयाम का उपयोग नहीं किया जा सकता है.

currencyCode

string

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

cohortSpec

object (CohortSpec)

इस अनुरोध से जुड़ा एक जैसे उपयोगकर्ताओं का ग्रुप. अगर 'समानता रखने वाले लोगों' के अनुरोध में कोई समानता रखने वाले लोग शामिल हैं आयाम मौजूद होना चाहिए.

keepEmptyRows

boolean

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

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

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

returnPropertyQuota

boolean

यह टॉगल करता है कि इस Analytics प्रॉपर्टी के कोटा की मौजूदा स्थिति को लौटाना है या नहीं. कोटा की जानकारी, PropertyQuota से दी जाती है.

comparisons[]

object (Comparison)

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