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 प्रॉपर्टी आइडेंटिफ़ायर, जिसके इवेंट ट्रैक किए जाते हैं. यूआरएल पाथ में बताया गया है, मुख्य हिस्से में नहीं. ज़्यादा जानने के लिए देखें कि आपका प्रॉपर्टी आईडी कहां मिलेगा.

उदाहरण: property/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)

मेट्रिक का फ़िल्टर क्लॉज़. एसक्यूएल के 'क्लॉज़' की तरह, पोस्ट एग्रीगेशन फ़ेज़ पर लागू किया जाता है. इस फ़िल्टर में आयाम का उपयोग नहीं किया जा सकता है.
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 मिनट की एक मिनट की रेंज का इस्तेमाल किया जाएगा. अगर मिनट की एक से ज़्यादा सीमाओं का अनुरोध किया जाता है, तो जवाब वाली हर पंक्ति में शून्य पर आधारित मिनट की सीमा का इंडेक्स होगा. अगर दो मिनट की सीमाएं ओवरलैप होती हैं, तो ओवरलैप होने वाले मिनट का इवेंट डेटा, दोनों मिनट की सीमाओं की जवाब वाली लाइनों में शामिल कर लिया जाता है.

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

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

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

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)

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