Method: runReport

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

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

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

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

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

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

JSON के काेड में दिखाना
{
  "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)

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

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