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 पर सेट करता है; पहला अनुरोध, पहली 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 पंक्तियां दिखाएगा.

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

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

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

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

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)

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

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,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
फ़ील्ड
dataLossFromOtherRow

boolean

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

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

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

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

schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

currencyCode

string

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

मुद्रा के कोड, 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) से स्ट्रिंग के तौर पर फ़ॉर्मैट किया गया; उदाहरण के लिए "अमेरिका/New_York" या "एशिया/टोक्यो" में साइन इन करने का विकल्प चुना है.

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

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

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