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

  • 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 फ़ील्ड (जैसे कि 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"
  }
}