टास्क की रिपोर्टिंग की बुनियादी बातें

रिपोर्ट टास्क का इस्तेमाल करके, Google Analytics इवेंट डेटा की कस्टम रिपोर्ट बनाने के लिए, लंबे समय तक चलने वाला एसिंक्रोनस अनुरोध शुरू किया जा सकता है.

इस अनुरोध से जनरेट हुई रिपोर्ट टास्क रिसॉर्स का इस्तेमाल करके, Google Analytics प्रॉपर्टी के 'सिर्फ़ देखें' ऐक्सेस वाले सभी उपयोगकर्ता, पसंद के मुताबिक बनाई गई रिपोर्ट ऐक्सेस कर सकते हैं.

कस्टम रिपोर्ट तैयार होने के बाद, 72 घंटे तक उपलब्ध रहेगी. इस अवधि के बाद, रिपोर्ट टास्क का संसाधन और उसका कॉन्टेंट अपने-आप मिट जाएगा.

रिपोर्ट बनाने का टास्क

Google Analytics Data API v1, रिपोर्ट टास्क बनाने के लिए एसिंक्रोनस अप्रोच का इस्तेमाल करता है. रिपोर्ट टास्क बनाने के लिए, सबसे पहले reportTasks.create तरीके का अनुरोध करना ज़रूरी है. इसके बाद, जनरेट की गई कस्टम रिपोर्ट को वापस पाने के लिए, reportTasks.query तरीके का इस्तेमाल किया जाता है.

इसके अलावा, किसी रिपोर्ट टास्क के कॉन्फ़िगरेशन मेटाडेटा को वापस पाने के लिए, reportTasks.get का इस्तेमाल किया जा सकता है. साथ ही, किसी प्रॉपर्टी के सभी रिपोर्ट टास्क की सूची बनाने के लिए, reportTasks.list का इस्तेमाल किया जा सकता है.

रिपोर्टिंग इकाई चुनें

Data API v1 के सभी तरीकों के लिए, यूआरएल अनुरोध के पाथ में Google Analytics प्रॉपर्टी आइडेंटिफ़ायर को properties/GA_PROPERTY_ID के तौर पर तय करना ज़रूरी है. जैसे:

  POST  https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks

यह रिपोर्ट, Google Analytics इवेंट के उस डेटा के आधार पर जनरेट होती है जिसे चुनी गई Google Analytics प्रॉपर्टी में इकट्ठा किया गया है.

अगर Data API क्लाइंट लाइब्रेरी में से किसी एक का इस्तेमाल किया जा रहा है, तो अनुरोध यूआरएल पाथ में मैन्युअल तरीके से बदलाव करने की ज़रूरत नहीं है. ज़्यादातर एपीआई क्लाइंट, property पैरामीटर उपलब्ध कराते हैं. इसके लिए, properties/GA_PROPERTY_ID के फ़ॉर्म में स्ट्रिंग की ज़रूरत होती है. क्लाइंट लाइब्रेरी इस्तेमाल करने के उदाहरणों के लिए, क्विक स्टार्ट गाइड देखें.

रिपोर्ट टास्क बनाने का अनुरोध करना

रिपोर्ट टास्क बनाने के लिए, अनुरोध में ReportTask ऑब्जेक्ट का इस्तेमाल करके, reportTasks.create तरीके को कॉल करें. ये पैरामीटर ज़रूरी हैं:

  • reportDefinition यह फ़ील्ड, कस्टम रिपोर्ट की डेफ़िनिशन के बारे में बताता है. इस पैरामीटर का स्ट्रक्चर, कोर रिपोर्टिंग के तरीकों में इस्तेमाल किए गए रिपोर्ट डेफ़िनिशन के जैसा होता है.

रिपोर्ट टास्क बनाने के अनुरोध का उदाहरण:

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

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks
{
  "reportDefinition": {
    "dateRanges": [{ "startDate": "2024-05-01"", "endDate": "2024-05-15" }],
    "dimensions": [{ "name": "country" }],
    "metrics": [{ "name": "activeUsers" }]
  }
}

reportTasks.create तरीके से मिले जवाब में, name फ़ील्ड में ReportTask का नाम होता है. जैसे, properties/1234567/reportTasks/123. इसका इस्तेमाल बाद की क्वेरी में किया जा सकता है, ताकि रिपोर्ट टास्क की स्थिति पता चल सके और नतीजे के तौर पर मिली रिपोर्ट को वापस पाया जा सके.

एचटीटीपी रिस्पॉन्स

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.ReportTask",
    "name": "properties/1234567/reportTasks/123",
    "reportDefinition": {
      "dimensions": [
        {
          "name": "country"
        }
      ],
      "metrics": [
        {
          "name": "activeUsers"
        }
      ],
      "dateRanges": [
        {
          "startDate": "2024-05-01",
          "endDate": "2024-05-15"
        }
      ]
    },
    "reportMetadata": {
      "state": "CREATING",
      "beginCreatingTime": "2024-05-16T00:00:01.133612336Z"
    }
  }
}

रिपोर्ट टास्क के तैयार होने की स्थिति पाना

reportTasks.create कॉल के बाद, रिपोर्ट जनरेट होने में कुछ मिनट लग सकते हैं. reportTasks.get तरीके को कॉल करके, रिपोर्ट टास्क की स्थिति के बारे में जानकारी पाई जा सकती है.

रिपोर्ट टास्क के बारे में बताने के लिए, reportTasks.create से मिले जवाब में मौजूद रिपोर्ट टास्क का नाम (जैसे, properties/1234567/reportTasks/123) इस्तेमाल करें.

उदाहरण:

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

GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123

रिपोर्ट टास्क के तैयार होने की स्थिति, जवाब के state फ़ील्ड में दिखती है. रिपोर्ट जनरेट होने के बाद, रिपोर्ट टास्क की स्थिति CREATING से बदलकर ACTIVE हो जाती है.

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

एचटीटीपी रिस्पॉन्स

{
  "reportDefinition": {
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ],
    "dateRanges": [
      {
        "startDate": "2024-05-01",
        "endDate": "2024-05-15"
      }
    ]
  },
  "reportMetadata": {
    "state": "ACTIVE",
    "beginCreatingTime": "2024-05-16T00:00:01.133612336Z",
    "creationQuotaTokensCharged": 6,
    "taskRowCount": 167,
    "errorMessage": "",
    "totalRowCount": 167
  }
}

reportTasks.list तरीके का इस्तेमाल करके, रिपोर्ट से जुड़े सभी टास्क की स्थिति पता लगाई जा सकती है.

जनरेट की गई रिपोर्ट वापस पाना

reportTasks.create तरीके का इस्तेमाल करके बनाई गई रिपोर्ट का टास्क जनरेट होने पर, reportTasks.query तरीके को कॉल करें और रिपोर्ट के टास्क का नाम बताएं. जैसे, properties/1234567/reportTasks/123.

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

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123:query

अगर रिपोर्ट तैयार है, तो जनरेट की गई रिपोर्ट वाला जवाब दिखाया जाता है:

एचटीटीपी रिस्पॉन्स

{
  "dimensionHeaders": [
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [

...

  ],
  "rowCount": 167,
  "metadata": {
    "currencyCode": "USD",
    "timeZone": "America/Los_Angeles"
  }
}