Method: properties.runReport

इसकी मदद से, आपके Google Analytics इवेंट डेटा की मनमुताबिक रिपोर्ट बनाई जाती है. रिपोर्ट में, Google Analytics ट्रैकिंग कोड से इकट्ठा किए गए डेटा से मिली अहम जानकारी शामिल होती है. एपीआई से मिला डेटा, टेबल के तौर पर होता है. इसमें अनुरोध किए गए डाइमेंशन और मेट्रिक के लिए कॉलम होते हैं. मेट्रिक, आपकी प्रॉपर्टी पर उपयोगकर्ता की गतिविधि के अलग-अलग मेज़रमेंट होते हैं. जैसे, सक्रिय उपयोगकर्ता या इवेंट की संख्या. डाइमेंशन, कुछ सामान्य शर्तों के आधार पर मेट्रिक को अलग-अलग कैटगरी में बांटते हैं. जैसे, देश या इवेंट का नाम.

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

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

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

पाथ पैरामीटर

पैरामीटर
property

string

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

उदाहरण: properties/1234

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

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

JSON के काेड में दिखाना 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
फ़ील्ड
dimensions[]

object (Dimension)

ज़रूरी नहीं. अनुरोध किए गए और दिखाए गए डाइमेंशन.
metrics[]

object (Metric)

ज़रूरी नहीं. अनुरोध की गई और दिखाई गई मेट्रिक.
dateRanges[]

object (DateRange)

ज़रूरी नहीं. पढ़ने के लिए डेटा की तारीख की सीमाएं. अगर तारीख की एक से ज़्यादा सीमाओं का अनुरोध किया जाता है, तो जवाब की हर लाइन में, तारीख की सीमा का इंडेक्स होगा. यह इंडेक्स, शून्य से शुरू होगा. अगर तारीख की दो सीमाएं एक-दूसरे से ओवरलैप होती हैं, तो ओवरलैप होने वाले दिनों का इवेंट डेटा, तारीख की दोनों सीमाओं के लिए जवाब की पंक्तियों में शामिल किया जाता है. कोहॉर्ट के अनुरोध में, इस dateRanges को तय नहीं किया जाना चाहिए.
dimensionFilter

object (FilterExpression)

ज़रूरी नहीं. डाइमेंशन फ़िल्टर की मदद से, रिपोर्ट में सिर्फ़ कुछ डाइमेंशन वैल्यू के लिए अनुरोध किया जा सकता है. ज़्यादा जानने के लिए, उदाहरणों के साथ डाइमेंशन फ़िल्टर की बुनियादी बातें लेख पढ़ें. इस फ़िल्टर में मेट्रिक का इस्तेमाल नहीं किया जा सकता.
metricFilter

object (FilterExpression)

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

string (int64 format)

ज़रूरी नहीं. शुरू होने वाली पंक्ति की संख्या. पहली लाइन को लाइन 0 के तौर पर गिना जाता है.

पेजिंग करते समय, पहले अनुरोध में ऑफ़सेट के बारे में नहीं बताया जाता है. इसके अलावा, ऑफ़सेट को 0 पर सेट किया जाता है. पहले अनुरोध में, पहली limit पंक्तियां दिखती हैं. दूसरे अनुरोध में, पहले अनुरोध के limit को ऑफ़सेट के तौर पर सेट किया जाता है. इससे, दूसरे अनुरोध में लाइनों का दूसरा limit दिखता है.

पेज नंबर डालने वाले इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज नंबर डालना लेख पढ़ें.
limit

string (int64 format)

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

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

पेज नंबर डालने वाले इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज नंबर डालना लेख पढ़ें.
metricAggregations[]

enum (MetricAggregation)

ज़रूरी नहीं. मेट्रिक का एग्रीगेशन. एग्रीगेट की गई मेट्रिक वैल्यू, उन पंक्तियों में दिखेंगी जहां dimensionValues को "RESERVED_(MetricAggregation)" पर सेट किया गया है. तुलना और तारीख की कई सीमाओं वाले एग्रीगेट, तारीख की सीमाओं के आधार पर एग्रीगेट किए जाएंगे.
orderBys[]

object (OrderBy)

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

string

ज़रूरी नहीं. आईएसओ4217 फ़ॉर्मैट में मुद्रा कोड, जैसे कि "AED", "USD", "JPY". अगर यह फ़ील्ड खाली है, तो रिपोर्ट में प्रॉपर्टी की डिफ़ॉल्ट मुद्रा का इस्तेमाल किया जाता है.
cohortSpec

object (CohortSpec)

ज़रूरी नहीं. इस अनुरोध से जुड़ा कोहॉर्ट ग्रुप. अगर अनुरोध में एक जैसे उपयोगकर्ताओं का ग्रुप है, तो 'कोहॉर्ट' डाइमेंशन मौजूद होना चाहिए.
keepEmptyRows

boolean

ज़रूरी नहीं. अगर यह विकल्प 'गलत' पर सेट है या इसकी जानकारी नहीं दी गई है, तो ऐसी हर लाइन को नहीं दिखाया जाएगा जिसमें सभी मेट्रिक की वैल्यू 0 के बराबर है. अगर यह वैल्यू सही है, तो इन लाइनों को तब तक नहीं हटाया जाएगा, जब तक कि इन्हें फ़िल्टर करके अलग से न हटाया जाए.

इस keepEmptyRows सेटिंग के बावजूद, रिपोर्ट में सिर्फ़ Google Analytics प्रॉपर्टी से रिकॉर्ड किया गया डेटा दिखाया जा सकता है.

उदाहरण के लिए, अगर कोई प्रॉपर्टी कभी purchase इवेंट लॉग नहीं करती है, तो eventName डाइमेंशन और eventCount मेट्रिक के लिए क्वेरी में, eventName: "purchase" और eventCount: 0 वाली लाइन नहीं होगी.
returnPropertyQuota

boolean

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

object (Comparison)

ज़रूरी नहीं. तुलनाओं का कॉन्फ़िगरेशन, जिनके लिए अनुरोध किया गया है और जिन्हें दिखाया गया है. जवाब में तुलना करने वाला कॉलम पाने के लिए, अनुरोध में सिर्फ़ तुलना फ़ील्ड की ज़रूरत होती है.
conversionSpec

object (ConversionSpec)

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

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

अनुरोध के हिसाब से जवाब की रिपोर्ट वाली टेबल.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
फ़ील्ड
dimensionHeaders[]

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

अनुरोध करने पर, मेट्रिक की कुल वैल्यू.
maximums[]

object (Row)

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

object (Row)

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

integer

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

पेज नंबर डालने वाले इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज नंबर डालना लेख पढ़ें.
metadata

object (ResponseMetaData)

रिपोर्ट का मेटाडेटा.
propertyQuota

object (PropertyQuota)

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

string

इससे पता चलता है कि यह मैसेज किस तरह का संसाधन है. यह kind हमेशा "analyticsData#runReport" स्ट्रिंग होती है. JSON में जवाब के टाइप के बीच अंतर करने के लिए यह पैरामीटर काम का है.
nextPageToken

string

यह एक टोकन है. इसका इस्तेमाल pageToken के तौर पर किया जा सकता है, ताकि अगला पेज वापस पाया जा सके. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होता.

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

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

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

तुलना

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

JSON के काेड में दिखाना 
{
  "name": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of mutually exclusive fields.
}
फ़ील्ड
name

string

हर तुलना के लिए, जवाब में अलग-अलग लाइनें दिखती हैं. जवाब में, इस तुलना की पहचान इस नाम से की जाती है. अगर नाम नहीं दिया गया है, तो हम सेव की गई तुलनाओं के डिसप्ले नेम का इस्तेमाल करेंगे.
यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
dimensionFilter

object (FilterExpression)

बेसिक तुलना.
comparison

string

तुलना के संसाधन नाम से पहचानी गई, सेव की गई तुलना. उदाहरण के लिए, 'comparisons/1234'.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

ConversionSpec

यह कुकी, कन्वर्ज़न रिपोर्टिंग को कंट्रोल करती है.

JSON के काेड में दिखाना 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
फ़ील्ड
conversionActions[]

string

रिपोर्ट में शामिल किए जाने वाले कन्वर्ज़न ऐक्शन आईडी. अगर यह फ़ील्ड खाली है, तो सभी कन्वर्ज़न शामिल किए जाते हैं. मान्य कन्वर्ज़न ऐक्शन आईडी, properties.getMetadata तरीके के जवाब में conversions सूची में मौजूद conversionAction फ़ील्ड से वापस पाए जा सकते हैं. उदाहरण के लिए, 'conversionActions/1234'.
attributionModel

enum (AttributionModel)

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

AttributionModel

कन्वर्ज़न रिपोर्ट में इस्तेमाल किया जाने वाला एट्रिब्यूशन मॉडल

Enums
ATTRIBUTION_MODEL_UNSPECIFIED एट्रिब्यूशन मॉडल की जानकारी नहीं दी गई है.
DATA_DRIVEN एट्रिब्यूशन, पेड और ऑर्गैनिक डेटा-ड्रिवन मॉडल पर आधारित था
LAST_CLICK एट्रिब्यूशन, पेड और ऑर्गैनिक चैनलों पर लास्ट क्लिक मॉडल के आधार पर किया गया था