इस गाइड में, ऑडियंस एक्सपोर्ट करने के अनुरोधों के स्टेटस के बारे में एसिंक्रोनस सूचनाएं पाने के लिए, वेबहुक का इस्तेमाल करने का तरीका बताया गया है. यह सुविधा, Data API के सिर्फ़ v1alpha वर्शन में उपलब्ध है.
वेबहुक सूचनाएं Google Analytics Data API की एक अडवांस सुविधा है. ऑडियंस एक्सपोर्ट करने की सुविधा के बारे में जानने के लिए, ऑडियंस एक्सपोर्ट करना लेख पढ़ें.
वेबहुक के बिना, आपको यह जानने के लिए समय-समय पर एपीआई को पोल करना होगा कि कोई अनुरोध कब पूरा हुआ.
Cloud Run का इस्तेमाल करके, वेबहुक ऐप्लिकेशन का सैंपल बनाना
Google Cloud का इस्तेमाल करके, वेबहुक ऐप्लिकेशन का सैंपल बनाया जा सकता है. इसके लिए, क्विकस्टार्ट: Cloud Run पर सैंपल सेवा डिप्लॉय करना ट्यूटोरियल देखें.
अगर आपको सैंपल सेवा को POST वेबहुक सूचना के अनुरोधों को सुनने की अनुमति देनी है, तो क्विकस्टार्ट ट्यूटोरियल की index.js फ़ाइल को इस कोड से बदलें:
import express from 'express';
const app = express();
app.use(express.json());
app.post('/', (req, res) => {
const channelToken = req.get('X-Goog-Channel-Token');
const bodyJson = JSON.stringify(req.body);
console.log(`channel token: ${channelToken}`);
console.log(`notification body: ${bodyJson}`);
res.sendStatus(200);
});
const port = parseInt(process.env.PORT) || 8080;
app.listen(port, () => {
console.log(`helloworld: listening on port ${port}`);
});
POST अनुरोध के तौर पर भेजी गई हर आने वाली वेबहुक सूचना के लिए, यह कोड वेबहुक सूचना के JSON बॉडी और चैनल टोकन की वैल्यू को प्रिंट करता है. साथ ही, यह बताता है कि ऑपरेशन पूरा हो गया है. इसके लिए, यह एचटीटीपी कोड 200 दिखाता है.
Cloud Run के क्विकस्टार्ट ट्यूटोरियल को पूरा करने और gcloud run deploy कमांड का इस्तेमाल करके, वेबहुक ऐप्लिकेशन को डिप्लॉय करने के बाद, उस यूआरएल को सेव करें जहां आपकी सेवा डिप्लॉय की गई है.
सेवा का यूआरएल, कंसोल में दिखता है. उदाहरण के लिए:
Service URL: https://webhooks-test-abcdef-uc.a.run.app
यह सर्वर सूचना का यूआरआई है. यहां आपका ऐप्लिकेशन, Google Analytics से मिलने वाली वेबहुक सूचनाओं को सुनता है.
ऑडियंस की सूची बनाना और वेबहुक सूचनाएं चालू करना
वेबहुक सूचनाओं का अनुरोध करने के लिए, webhookNotification
ऑब्जेक्ट में ये वैल्यू डालें:
सर्वर सूचना का यूआरआई, जिसमें वह वेब पता शामिल है जिस पर वेबहुक सूचनाएं मिलेंगी.
(ज़रूरी नहीं) एक आर्बिट्ररी स्ट्रिंग
channelTokenताकि मैसेज को स्पूफ़ होने से बचाया जा सके. वेबहुक के POST अनुरोध केX-Goog-Channel-Tokenएचटीटीपी हेडर में,channelTokenडालें.
वेबहुक का इस्तेमाल करके, अनुरोध का एक सैंपल यहां दिया गया है:
एचटीटीपी अनुरोध
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/audienceLists
{
"webhookNotification": {
"uri": "https://webhooks-test-abcdef-uc.a.run.app",
"channelToken": "123456"
},
"audience": "properties/1234567/audiences/12345",
"dimensions": [
{
"dimensionName": "deviceId"
}
]
}
audienceLists.create तरीके से मिलने वाले जवाब में, webhookNotification शामिल होता है. इससे पुष्टि होती है कि तय किया गया वेबहुक, पांच सेकंड से कम समय में जवाब देने में कामयाब रहा.
जवाब का एक सैंपल यहां दिया गया है:
एचटीटीपी रिस्पॉन्स
{
"response": {
"@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceList",
"name": "properties/1234567/audienceLists/123",
"audience": "properties/1234567/audiences/12345",
"audienceDisplayName": "Purchasers",
"dimensions": [
{
"dimensionName": "deviceId"
}
],
"state": "ACTIVE",
"beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
"creationQuotaTokensCharged": 51,
"rowCount": 13956,
"percentageCompleted": 100,
"webhookNotification": {
"uri": "https://webhooks-test-abcdef-uc.a.run.app",
"channelToken": "123456"
}
}
}
अगर कोई वेबहुक जवाब नहीं देता है या आपने सेवा का गलत यूआरएल दिया है, तो इसके बजाय गड़बड़ी का मैसेज दिखता है.
गड़बड़ी का एक उदाहरण यहां दिया गया है, जो आपको मिल सकता है:
{
"error": {
"code": 400,
"message": "Expected response code of 200 from webhook URI but instead
'404' was received.",
"status": "INVALID_ARGUMENT"
}
}
वेबहुक सूचनाएं प्रोसेस करना
वेबहुक सेवा के लिए POST अनुरोध के बॉडी में,
लंबे समय तक चलने वाले ऑपरेशन के संसाधन
का JSON वर्शन और sentTimestamp फ़ील्ड, दोनों शामिल होते हैं. भेजे गए टाइमस्टैंप में, Unix epoch टाइम को माइक्रोसेकंड में दिखाया जाता है. इससे पता चलता है कि अनुरोध कब भेजा गया था. इस टाइमस्टैंप का इस्तेमाल करके, दोबारा भेजी गई सूचनाओं की पहचान की जा सकती है.
ऑडियंस की सूची बनाते समय, वेबहुक को एक या दो POST अनुरोध भेजे जाते हैं:
- पहला POST अनुरोध तुरंत भेजा जाता है. इसमें, नई बनाई गई ऑडियंस की सूची,
CREATINGस्थिति में दिखती है. अगर वेबहुक को भेजा गया पहला अनुरोध पूरा नहीं होता है, तोaudienceLists.createऑपरेशन एक गड़बड़ी दिखाता है. साथ ही, वेबहुक के काम न करने की वजह भी बताता है. - ऑडियंस की सूची बन जाने के बाद, दूसरा POST अनुरोध भेजा जाता है. ऑडियंस की सूची,
ACTIVEयाFAILEDस्थिति में पहुंचने पर, सूची बनाने की प्रक्रिया पूरी हो जाती है.
ऑडियंस की सूची के लिए पहली सूचना का एक उदाहरण यहां दिया गया है. यह सूचना, CREATING स्थिति में है:
{
"sentTimestamp":"1718261355692983",
"name": "properties/1234567/audienceLists/123",
"audience": "properties/1234567/audiences/12345",
"audienceDisplayName":"Purchasers",
"dimensions":[{"dimensionName":"deviceId"}],
"state":"CREATING",
"beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
"creationQuotaTokensCharged":0,
"rowCount":0,
"percentageCompleted":0,
"webhookNotification":
{
"uri": "https://webhooks-test-abcdef-uc.a.run.app",
"channelToken":"123456"
}
}
ऑडियंस की सूची के लिए दूसरी सूचना का एक उदाहरण यहां दिया गया है. यह सूचना, ACTIVE स्थिति में है:
{
"sentTimestamp":"1718261355692983",
"name": "properties/1234567/audienceLists/123",
"audience": "properties/1234567/audiences/12345",
"audienceDisplayName":"Purchasers",
"dimensions":[{"dimensionName":"deviceId"}],
"state":"ACTIVE",
"beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
"creationQuotaTokensCharged":68,
"rowCount":13956,
"percentageCompleted":100,
"webhookNotification":
{
"uri": "https://webhooks-test-abcdef-uc.a.run.app",
"channelToken":"123456"
}
}
दूसरी सूचना से पुष्टि होती है कि ऑडियंस की सूची बन गई है और यह
तरीके का इस्तेमाल करके, इससे क्वेरी की जा सकती है.audienceLists.query