रिपोर्ट टास्क का इस्तेमाल करके, लंबे समय से चल रहे एसिंक्रोनस अनुरोध को शुरू किया जा सकता है. इससे Google Analytics इवेंट डेटा की कस्टमाइज़ की गई रिपोर्ट बनाई जा सकती है.
इस अनुरोध से जनरेट किए गए रिपोर्ट टास्क का इस्तेमाल, सभी उपयोगकर्ताओं के लिए पसंद के मुताबिक बनाई गई रिपोर्ट ऐक्सेस करने के लिए किया जा सकता है. इसके लिए, आपके पास Google Analytics प्रॉपर्टी का पढ़ने का ऐक्सेस होना चाहिए.
कस्टम रिपोर्ट तैयार होने के 72 घंटे बाद तक उपलब्ध रहेगी. इस समयावधि के बाद, रिपोर्ट से जुड़े टास्क के रिसॉर्स और उसका कॉन्टेंट अपने-आप मिट जाएगा.
एक रिपोर्ट टास्क बनाएं
Google Analytics Data API v1, रिपोर्ट टास्क बनाने के लिए एसिंक्रोनस तरीके का इस्तेमाल करता है. सबसे पहले, रिपोर्ट टास्क बनाने के लिए, reportTasks.create
तरीके का अनुरोध करना ज़रूरी है. इसके बाद, जनरेट की गई कस्टमाइज़ की गई रिपोर्ट को वापस पाने के लिए, reportTasks.query
तरीके का इस्तेमाल किया जाता है.
इसके अलावा, किसी खास रिपोर्ट टास्क का कॉन्फ़िगरेशन मेटाडेटा वापस पाने के लिए, reportTasks.get
का इस्तेमाल किया जा सकता है. साथ ही, किसी प्रॉपर्टी के सभी रिपोर्ट टास्क की सूची बनाने के लिए, reportTasks.list
का इस्तेमाल किया जा सकता है.
कोई रिपोर्टिंग इकाई चुनें
Data API v1 के सभी तरीकों के लिए, यूआरएल अनुरोध पाथ में Google Analytics 4 प्रॉपर्टी आइडेंटिफ़ायर की जानकारी, properties/GA4_PROPERTY_ID
के तौर पर देनी होगी. जैसे:
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA4_PROPERTY_ID/reportTasks
रिपोर्ट, किसी खास Google Analytics 4 प्रॉपर्टी में इकट्ठा किए गए Google Analytics इवेंट डेटा के आधार पर जनरेट की जाती है.
अगर Data API क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो अनुरोध के यूआरएल पाथ में मैन्युअल तरीके से बदलाव करने की ज़रूरत नहीं है.
ज़्यादातर एपीआई क्लाइंट ऐसा property
पैरामीटर देते हैं जो properties/GA4_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"
}
}