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

रिपोर्ट टास्क का इस्तेमाल करके, लंबे समय तक चलने वाला एसिंक्रोनस अनुरोध शुरू किया जा सकता है. इससे, 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 फ़ील्ड, जिसमें कस्टम रिपोर्ट की परिभाषा दी गई है. इस पैरामीटर का स्ट्रक्चर, Core Reporting के तरीकों में इस्तेमाल की गई रिपोर्ट की परिभाषा से मिलता-जुलता है.

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

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

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 फ़ील्ड में रिपोर्ट टास्क का नाम शामिल होता है. जैसे, 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"
  }
}

अगले चरण