Method: properties.reportTasks.query

रिपोर्ट टास्क का कॉन्टेंट वापस लाता है. reportTasks.create का अनुरोध करने के बाद, रिपोर्ट चालू होने पर, रिपोर्ट का कॉन्टेंट वापस पाया जा सकता है. अगर रिपोर्ट टास्क की स्थिति 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 की संख्या और उनके क्रम, पंक्तियों में मौजूद डाइमेंशन से मेल खाते हैं.
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

ResponseMetaData

रिपोर्ट के कॉन्टेंट के बारे में ज़्यादा जानकारी देने वाला रिस्पॉन्स मेटाडेटा.

JSON के काेड में दिखाना 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
फ़ील्ड
dataLossFromOtherRow

boolean

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

मेटाडेटा पैरामीटर dataLossFromOtherRow, रिपोर्ट में इस्तेमाल की गई एग्रीगेट की गई डेटा टेबल के आधार पर पॉप्युलेट होता है. रिपोर्ट में मौजूद फ़िल्टर और सीमाओं के बावजूद, पैरामीटर में डेटा सही तरीके से भर जाएगा.

उदाहरण के लिए, रिपोर्ट से (अन्य) लाइन को हटाया जा सकता है, क्योंकि अनुरोध में sessionSource = google पर फ़िल्टर है. अगर इस रिपोर्ट को जनरेट करने के लिए इस्तेमाल किए गए इनपुट एग्रीगेट डेटा में, किसी दूसरी लाइन का डेटा मौजूद था, तो यह पैरामीटर अब भी पॉप्युलेट होगा.

ज़्यादा जानने के लिए, (अन्य) लाइन और डेटा सैंपलिंग के बारे में जानकारी देखें.
samplingMetadatas[]

object (SamplingMetadata)

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

हालांकि, अगर नतीजों को सैंपल नहीं किया जाता है, तो इस फ़ील्ड की जानकारी नहीं दी जाएगी.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

इस रिपोर्ट को बनाते समय, स्कीमा से जुड़ी पाबंदियों के बारे में जानकारी देता है. ज़्यादा जानने के लिए, ऐक्सेस और डेटा के इस्तेमाल से जुड़ी पाबंदियों को मैनेज करना लेख पढ़ें.
currencyCode

string

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

मुद्रा कोड, ISO 4217 स्टैंडर्ड (https://en.wikipedia.org/wiki/ISO_4217) में बताई गई मुद्रा के टाइप की स्ट्रिंग कोडिंग होती है. उदाहरण के लिए, "USD", "EUR", "JPY". ज़्यादा जानने के लिए, https://support.google.com/analytics/answer/9796179 पर जाएं.
timeZone

string

प्रॉपर्टी का मौजूदा टाइमज़ोन. इसका इस्तेमाल, hour और minute जैसे समय-आधारित डाइमेंशन को समझने के लिए किया जाता है. आईएएनए टाइम ज़ोन डेटाबेस (https://www.iana.org/time-zones) से स्ट्रिंग के तौर पर फ़ॉर्मैट किया गया. उदाहरण के लिए, "America/New_York" या "Asia/Tokyo".
emptyReason

string

अगर कोई वजह नहीं दी गई है, तो रिपोर्ट में कोई डेटा नहीं दिखेगा.
subjectToThresholding

boolean

अगर subjectToThresholding सही है, तो इस रिपोर्ट में थ्रेशोल्ड लागू होता है. साथ ही, इसमें सिर्फ़ वह डेटा दिखता है जो इकट्ठा होने के कम से कम थ्रेशोल्ड तक पहुंच जाता है. ऐसा हो सकता है कि किसी अनुरोध पर थ्रेशोल्ड लागू हो और रिपोर्ट में कोई डेटा न हो. ऐसा तब होता है, जब सारा डेटा थ्रेशोल्ड से ज़्यादा हो. ज़्यादा जानने के लिए, डेटा थ्रेशोल्ड और डेमोग्राफ़िक्स और दिलचस्पी के बारे में जानकारी देखें.

SchemaRestrictionResponse

इस रिपोर्ट को बनाते समय, स्कीमा से जुड़ी पाबंदियां लागू की गई हैं. ज़्यादा जानने के लिए, ऐक्सेस और डेटा के इस्तेमाल से जुड़ी पाबंदियों को मैनेज करना लेख पढ़ें.

JSON के काेड में दिखाना 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
फ़ील्ड
activeMetricRestrictions[]

object (ActiveMetricRestriction)

रिपोर्ट बनाते समय लागू की गई सभी पाबंदियां. उदाहरण के लिए, purchaseRevenue में हमेशा पाबंदी का टाइप REVENUE_DATA होता है. हालांकि, जवाब देने पर पाबंदी सिर्फ़ तब लागू होती है, जब उपयोगकर्ता की कस्टम भूमिका में REVENUE_DATA का ऐक्सेस न हो.

ActiveMetricRestriction

रिपोर्ट बनाते समय, जिस मेट्रिक पर पाबंदी लगी हो.

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

enum (RestrictedMetricType)

इस मेट्रिक पर पाबंदी लगाने की वजह.
metricName

string

पाबंदी वाली मेट्रिक का नाम.

RestrictedMetricType

डेटा की कैटगरी, जिन्हें आपको कुछ Google Analytics प्रॉपर्टी पर देखने से रोका जा सकता है.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED टाइप की जानकारी नहीं है.
COST_DATA लागत की मेट्रिक, जैसे कि adCost.
REVENUE_DATA रेवेन्यू की मेट्रिक, जैसे कि purchaseRevenue.