Method: properties.runRealtimeReport

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

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

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

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

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

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

पैरामीटर
property

string

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

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

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

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

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

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

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)

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

returnPropertyQuota

boolean

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

minuteRanges[]

object (MinuteRange)

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

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

किसी अनुरोध से जुड़े रिस्पॉन्स वाले रीयल टाइम रिपोर्ट की टेबल.

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

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

डाइमेंशन कॉलम की जानकारी देता है. डाइमेंशनHeaders की संख्या और आयामHeaders का क्रम, पंक्तियों में मौजूद डाइमेंशन से मेल खाता है.

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)

इस 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. अनुरोध ज़्यादा से ज़्यादा दो मिनट की रेंज में किए जा सकते हैं.

जेएसओएन के काेड में दिखाना
{
  "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 की स्टैंडर्ड प्रॉपर्टी, पिछले 30 मिनट के इवेंट डेटा (endMinutesAgo <= 29) के किसी भी मिनट का अनुरोध कर सकती हैं. वहीं, 360 Analytics प्रॉपर्टी, पिछले 60 मिनट के इवेंट डेटा (endMinutesAgo <= 59) के किसी भी मिनट में अनुरोध कर सकती हैं.