Method: properties.reportTasks.query

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

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

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

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

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

पैरामीटर
name

string

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

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

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

जेएसओएन के काेड में दिखाना
{
  "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 है, तो ऑफ़सेट=900 और लिमिट=500 वाली reportTasks.query अनुरोध के लिए, ज़्यादा से ज़्यादा 100 लाइनें दिखाई जाएंगी.

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

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

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

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

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

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

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

जवाब के मेटाडेटा में, शिकायत के कॉन्टेंट के बारे में ज़्यादा जानकारी शामिल है.

जेएसओएन के काेड में दिखाना
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
फ़ील्ड
dataLossFromOtherRow

boolean

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

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

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

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

schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

currencyCode

string

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

मुद्रा के कोड, 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

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

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

object (ActiveMetricRestriction)

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

ActiveMetricRestriction

रिपोर्ट बनाने के लिए सक्रिय रूप से प्रतिबंधित मेट्रिक.

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

enum (RestrictedMetricType)

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

metricName

string

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

RestrictedMetricType

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

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