Tasks की बुनियादी बातों की शिकायत करें

रिपोर्ट टास्क की मदद से, 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 तरीके को कॉल करें. ये पैरामीटर ज़रूरी हैं:

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

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

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"
  }
}