Method: properties.reportTasks.query

रिपोर्ट टास्क का कॉन्टेंट वापस लाता है. reportTasks.create का अनुरोध करने के बाद, रिपोर्ट के `ACTIVE` होने पर उसका कॉन्टेंट वापस लाया जा सकता है. अगर रिपोर्ट टास्क की स्थिति ACTIVE नहीं है, तो यह तरीका गड़बड़ी वाला मान लौटाएगा. क्वेरी के जवाब में, रिपोर्ट की टेबल वाली लाइन और कॉलम की वैल्यू दिखेंगी.

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

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

पाथ पैरामीटर

पैरामीटर
name

string

ज़रूरी है. रिपोर्ट के सोर्स का नाम. फ़ॉर्मैट: properties/{property}/reportTasks/{report}

अनुरोध का मुख्य हिस्सा

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

JSON के काेड में दिखाना 
{
  "offset": string,
  "limit": string
}
फ़ील्ड
offset

string (int64 format)

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

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

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

string (int64 format)

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

अगर limit के मुकाबले डाइमेंशन की वैल्यू कम हैं, तो एपीआई, अनुरोध की गई limit से कम लाइनें भी वापस ला सकता है. QueryReportTaskRequest के लिए उपलब्ध लाइनों की संख्या, उससे जुड़े ReportTask की सीमा से भी सीमित होती है. कोई क्वेरी, ज़्यादा से ज़्यादा ReportTask.limit लाइनें वापस ला सकती है. उदाहरण के लिए, अगर ReportTask की सीमा 1,000 है, तो offset=900 और limit=500 के साथ reportTasks.query का अनुरोध करने पर, ज़्यादा से ज़्यादा 100 लाइनें वापस लाई जाएंगी.

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

जवाब का मुख्य हिस्सा

रिपोर्ट टास्क से जुड़ा रिपोर्ट का कॉन्टेंट.

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

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

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

क्वेरी के नतीजे में लाइनों की कुल संख्या.
metadata

object (ResponseMetaData)

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

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

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

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