Method: properties.runRealtimeReport

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

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

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

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

पाथ पैरामीटर

पैरामीटर
property

string

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

उदाहरण: property/1234

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

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

JSON के काेड में दिखाना
{
  "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 से दी जाती है.

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

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

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

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

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

metricHeaders[]

object (MetricHeader)

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

rows[]

object (Row)

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

totals[]

object (Row)

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

maximums[]

object (Row)

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

minimums[]

object (Row)

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

rowCount

integer

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

propertyQuota

object (PropertyQuota)

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

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

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

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