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)

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

string (int64 format)

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

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

enum (MetricAggregation)

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

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

object (MetricHeader)

मेट्रिक कॉलम के बारे में जानकारी देता है. MetricHeaders की संख्या और MetricHeaders का क्रम, लाइनों में मौजूद मेट्रिक से मेल खाता है.
rows[]

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

क्वेरी के नतीजे में लाइनों की कुल संख्या. rowCount, रिस्पॉन्स में दिखाई गई लाइनों की संख्या और limit अनुरोध पैरामीटर से अलग होता है. उदाहरण के लिए, अगर कोई क्वेरी 175 लाइनें दिखाती है और एपीआई अनुरोध में 50 की limit शामिल है, तो जवाब में 175 की rowCount होगी, लेकिन सिर्फ़ 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) का अनुरोध कर सकती हैं. वहीं, 360 Analytics प्रॉपर्टी, पिछले 60 मिनट के इवेंट डेटा (startMinutesAgo <= 59) का अनुरोध कर सकती हैं.
endMinutesAgo

integer

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

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