Method: properties.runReport

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

अनुरोध तैयार करने और जवाबों को समझने की गाइड के लिए, रिपोर्ट बनाना देखें.

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

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

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

पाथ के पैरामीटर

पैरामीटर
property

string

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

उदाहरण: प्रॉपर्टीज़/1234

अनुरोध का मुख्य भाग

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

जेएसओएन के काेड में दिखाना 
{
  "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
}
फ़ील्ड
dimensions[]

object (Dimension)

अनुरोध किए गए और दिखाए गए डाइमेंशन.
metrics[]

object (Metric)

अनुरोध की गई और दिखाई गई मेट्रिक.
dateRanges[]

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

मेट्रिक का फ़िल्टर क्लॉज़. रिपोर्ट की पंक्तियों को इकट्ठा करने के बाद लागू किया जाता है. यह एसक्यूएल के क्लॉज़ की तरह ही होता है. इस फ़िल्टर में डाइमेंशन का इस्तेमाल नहीं किया जा सकता.
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)

मेट्रिक का एग्रीगेशन. एग्रीगेट की गई मेट्रिक वैल्यू उन लाइनों में दिखेंगी जहां डाइमेंशन वैल्यू "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 के तौर पर दिखाया जाता है.

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

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

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

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

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