Method: properties.runRealtimeReport

इससे, आपकी प्रॉपर्टी के रीयलटाइम इवेंट डेटा की मनमुताबिक रिपोर्ट बनाई जाती है. इवेंट, Google Analytics को भेजे जाने के कुछ सेकंड बाद, रीयलटाइम रिपोर्ट में दिखने लगते हैं. रीयलटाइम रिपोर्ट में, इवेंट और इस्तेमाल का डेटा दिखाया जाता है. यह डेटा, मौजूदा समय से लेकर 30 मिनट पहले तक का होता है. Google Analytics 360 प्रॉपर्टी के लिए, यह डेटा 60 मिनट पहले तक का हो सकता है.

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

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

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

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

पाथ पैरामीटर

पैरामीटर
property

string

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

उदाहरण: properties/1234

अनुरोध का मुख्य हिस्सा

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

JSON के काेड में दिखाना 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
फ़ील्ड
dimensions[]

object (Dimension)

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

object (Metric)

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

object (FilterExpression)

डाइमेंशन का फ़िल्टर क्लॉज़. इस फ़िल्टर में मेट्रिक का इस्तेमाल नहीं किया जा सकता.
metricFilter

object (FilterExpression)

मेट्रिक का फ़िल्टर क्लॉज़. यह एग्रीगेशन के बाद के फ़ेज़ में लागू होता है. यह SQL के having-clause की तरह होता है. इस फ़िल्टर में डाइमेंशन का इस्तेमाल नहीं किया जा सकता.
limit

string (int64 format)

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

अगर डाइमेंशन की वैल्यू, limit से कम हैं, तो एपीआई, अनुरोध की गई limit से कम पंक्तियां भी लौटा सकता है. उदाहरण के लिए, country डाइमेंशन के लिए 300 से कम वैल्यू हो सकती हैं. इसलिए, सिर्फ़ country के बारे में रिपोर्ट करते समय, आपको 300 से ज़्यादा पंक्तियां नहीं मिल सकतीं. भले ही, आपने limit की वैल्यू ज़्यादा सेट की हो.
metricAggregations[]

enum (MetricAggregation)

मेट्रिक का एग्रीगेशन. एग्रीगेट की गई मेट्रिक वैल्यू, उन पंक्तियों में दिखेंगी जहां dimensionValues को "RESERVED_(MetricAggregation)" पर सेट किया गया है.
orderBys[]

object (OrderBy)

इससे यह तय होता है कि जवाब में पंक्तियों को किस क्रम में दिखाया जाए.
returnPropertyQuota

boolean

इससे यह तय होता है कि इस Google Analytics प्रॉपर्टी के रीयलटाइम कोटे की मौजूदा स्थिति दिखाई जाए या नहीं. कोटा, PropertyQuota में दिखाया जाता है.
minuteRanges[]

object (MinuteRange)

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

जवाब का मुख्य हिस्सा

यह किसी अनुरोध के लिए, रीयलटाइम रिपोर्ट की टेबल होती है.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
फ़ील्ड
dimensionHeaders[]

object (DimensionHeader)

यह डाइमेंशन वाले कॉलम के बारे में बताता है. पंक्तियों में मौजूद डाइमेंशन की संख्या और डाइमेंशन हेडर की संख्या और क्रम एक जैसा होता है.
metricHeaders[]

object (MetricHeader)

यह मेट्रिक वाले कॉलम के बारे में बताता है. पंक्तियों में मौजूद मेट्रिक की संख्या और मेट्रिक हेडर की संख्या और क्रम एक जैसा होता है.
rows[]

object (Row)

रिपोर्ट में, डाइमेंशन वैल्यू के कॉम्बिनेशन और मेट्रिक वैल्यू की पंक्तियां.
totals[]

object (Row)

अगर अनुरोध किया गया है, तो मेट्रिक की कुल वैल्यू.
maximums[]

object (Row)

अगर अनुरोध किया गया है, तो मेट्रिक की ज़्यादा से ज़्यादा वैल्यू.
minimums[]

object (Row)

अगर अनुरोध किया गया है, तो मेट्रिक की कम से कम वैल्यू.
rowCount

integer

क्वेरी के नतीजे में पंक्तियों की कुल संख्या. rowCount, जवाब में लौटाई गई पंक्तियों की संख्या और limit अनुरोध पैरामीटर से अलग होता है. उदाहरण के लिए, अगर कोई क्वेरी 175 पंक्तियां लौटाती है और एपीआई अनुरोध में limit की वैल्यू 50 है, तो जवाब में rowCount की वैल्यू 175 होगी. हालांकि, इसमें सिर्फ़ 50 पंक्तियां होंगी.
propertyQuota

object (PropertyQuota)

यह Google Analytics प्रॉपर्टी के रीयलटाइम कोटे की स्थिति है. इसमें इस अनुरोध को भी शामिल किया गया है.
kind

string

इससे पता चलता है कि यह मैसेज किस तरह का संसाधन है. यह kind हमेशा "analyticsData#runRealtimeReport" स्ट्रिंग होती है. यह JSON में, जवाब के टाइप के बीच अंतर करने में मददगार होती है.

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

इसके लिए, इनमें से किसी एक OAuth अनुमति की ज़रूरत होती है:

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

MinuteRange

यह लगातार मिनट का सेट होता है: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. दो मिनट रेंज तक के अनुरोध किए जा सकते हैं.

JSON के काेड में दिखाना 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
फ़ील्ड
name

string

इससे, इस मिनट रेंज को कोई नाम असाइन किया जाता है. रिपोर्ट के जवाब में, डाइमेंशन dateRange की वैल्यू यह नाम होती है. अगर इसे सेट किया जाता है, तो यह date_range_ या RESERVED_ से शुरू नहीं हो सकता. अगर इसे सेट नहीं किया जाता है, तो मिनट रेंज को अनुरोध में, शून्य पर आधारित इंडेक्स के हिसाब से नाम दिया जाता है: date_range_0, date_range_1 वगैरह.
startMinutesAgo

integer

यह क्वेरी के लिए, शामिल किया जाने वाला शुरुआती मिनट है. यह मौजूदा समय से पहले के मिनटों की संख्या के तौर पर दिखाया जाता है. उदाहरण के लिए, "startMinutesAgo": 29 का मतलब है कि रिपोर्ट में, 29 मिनट पहले और उसके बाद का इवेंट डेटा शामिल होना चाहिए. यह endMinutesAgo के बाद का नहीं हो सकता.

अगर इसे तय नहीं किया जाता है, तो startMinutesAgo की डिफ़ॉल्ट वैल्यू 29 होती है. Analytics की स्टैंडर्ड प्रॉपर्टी, पिछले 30 मिनट तक के इवेंट डेटा का अनुरोध कर सकती हैं (startMinutesAgo <= 29). वहीं, Analytics 360 की प्रॉपर्टी, पिछले 60 मिनट तक के इवेंट डेटा का अनुरोध कर सकती हैं (startMinutesAgo <= 59).
endMinutesAgo

integer

यह क्वेरी के लिए, शामिल किया जाने वाला आखिरी मिनट है. यह मौजूदा समय से पहले के मिनटों की संख्या के तौर पर दिखाया जाता है. यह startMinutesAgo से पहले का नहीं हो सकता. उदाहरण के लिए, "endMinutesAgo": 15 का मतलब है कि रिपोर्ट में, 15 मिनट पहले तक का इवेंट डेटा शामिल होना चाहिए.

अगर इसे तय नहीं किया जाता है, तो endMinutesAgo की डिफ़ॉल्ट वैल्यू 0 होती है. Analytics की स्टैंडर्ड प्रॉपर्टी, पिछले 30 मिनट के इवेंट डेटा में से किसी भी मिनट का अनुरोध कर सकती हैं (endMinutesAgo <= 29). वहीं, Analytics 360 की प्रॉपर्टी, पिछले 60 मिनट के इवेंट डेटा में से किसी भी मिनट का अनुरोध कर सकती हैं (endMinutesAgo <= 59).