Method: properties.runReport

यह विकल्प आपके Google Analytics इवेंट डेटा की, पसंद के मुताबिक बनाई गई रिपोर्ट दिखाता है. रिपोर्ट में Google Analytics ट्रैकिंग कोड से इकट्ठा किए गए डेटा से मिले आंकड़े होते हैं. एपीआई से मिला डेटा, अनुरोध किए गए डाइमेंशन और मेट्रिक के कॉलम के साथ टेबल के तौर पर होता है. मेट्रिक, आपकी प्रॉपर्टी पर उपयोगकर्ता की गतिविधि का अलग-अलग मेज़रमेंट होती हैं. जैसे, सक्रिय उपयोगकर्ता या इवेंट की संख्या. डाइमेंशन, देश या इवेंट का नाम जैसी कुछ सामान्य शर्तों के हिसाब से मेट्रिक को बांटते हैं.

अनुरोधों का निर्माण करने और जवाबों को समझने के लिए, रिपोर्ट बनाना देखें.

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

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

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

पाथ पैरामीटर

पैरामीटर
property

string

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

उदाहरण: property/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)

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

string (int64 format)

शुरुआती पंक्ति की पंक्तियों की संख्या. पहली लाइन को शून्य के तौर पर गिना जाता है.

पेजिंग करते समय, पहला अनुरोध ऑफ़सेट की जानकारी नहीं देता है; या इसके बराबर, ऑफ़सेट को 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_(Metricएग्रीगेशन)" पर सेट किया गया है.
orderBys[]

object (OrderBy)

इससे पता चलता है कि रिस्पॉन्स में पंक्तियों को किस तरह क्रम से लगाया जाता है.
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)

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

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

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

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

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

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