Method: properties.runRealtimeReport

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

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

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

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

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

पैरामीटर
property

string

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

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

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

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

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

object (Dimension)

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

metrics[]

object (Metric)

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

limit

string (int64 format)

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

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

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

metricAggregations[]

enum (MetricAggregation)

मेट्रिक का एग्रीगेशन. एग्रीगेट की गई मेट्रिक वैल्यू उन लाइनों में दिखेंगी जहां डाइमेंशन वैल्यू "RESERVED_(Metricएग्रीगेशन)" पर सेट होती हैं.

orderBys[]

object (OrderBy)

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

returnPropertyQuota

boolean

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
फ़ील्ड
dimensionHeaders[]

object (DimensionHeader)

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

metricHeaders[]

object (MetricHeader)

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

rows[]

object (Row)

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

totals[]

object (Row)

अनुरोध किए जाने पर, मेट्रिक की कुल वैल्यू.

maximums[]

object (Row)

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

minimums[]

object (Row)

अनुरोध किए जाने पर, मेट्रिक की कम से कम वैल्यू.

rowCount

integer

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

propertyQuota

object (PropertyQuota)

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

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

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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