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

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

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

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

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

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

इसके अलावा, विज्ञापनों और reportTasks.get किसी रिपोर्ट टास्क का कॉन्फ़िगरेशन मेटाडेटा फिर से पाने के लिए और reportTasks.list का इस्तेमाल करें.

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

Data API v1 के सभी तरीकों के लिए, Google Analytics प्रॉपर्टी आइडेंटिफ़ायर URL अनुरोध पथ के अंदर इस रूप में दर्ज की जानी चाहिए: 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 के रूप में होगा. उदाहरणों के लिए आसानी से सिखाने वाली गाइड देखें क्लाइंट लाइब्रेरी का इस्तेमाल करने के बारे में बताया गया है.

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

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

  • 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 तरीका.

रिपोर्ट टास्क के नाम का इस्तेमाल करें (जैसे कि properties/1234567/reportTasks/123) आपको यह बताने के लिए reportTasks.create जवाब से मिला है टास्क की शिकायत करें.

उदाहरण:

एचटीटीपी अनुरोध
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"
  }
}