Method: runReport

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

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

POST https://analyticsdata.googleapis.com/v1alpha:runReport

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

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

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

जेएसओएन के काेड में दिखाना
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
फ़ील्ड
entity

object (Entity)

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

dimensions[]

object (Dimension)

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

metrics[]

object (Metric)

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

dateRanges[]

object (DateRange)

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

offset

string (int64 format)

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

limit

string (int64 format)

दिखाई जाने वाली पंक्तियों की संख्या. अगर limit पैरामीटर तय नहीं किया जाता है, तो 10,000 लाइनें दिखती हैं. एपीआई हर अनुरोध में ज़्यादा से ज़्यादा 1,00,000 लाइनें दिखाता है, चाहे आपने कितनी भी लाइनें मांगी हों.

metricAggregations[]

enum (MetricAggregation)

मेट्रिक का एग्रीगेशन. एग्रीगेट की गई मेट्रिक वैल्यू उन लाइनों में दिखेंगी जहां डाइमेंशन वैल्यू "RESERVED_(Metricएग्रीगेशन)" पर सेट होती हैं.

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

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

orderBys[]

object (OrderBy)

इससे पता चलता है कि रिस्पॉन्स में पंक्तियों को किस क्रम में लगाया जाता है.

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

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

returnPropertyQuota

boolean

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

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

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

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

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

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