ऑडियंस की सूचियों के लिए, वेबहुक की सूचनाएं पाएं

इस गाइड में, वेबुक का इस्तेमाल करके, ऑडियंस एक्सपोर्ट करने के अनुरोधों की स्थिति के बारे में एसिंक्रोनस सूचनाएं पाने का तरीका बताया गया है. यह सुविधा सिर्फ़ 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 अनुरोध भेजे जाते हैं:

  1. पहला POST अनुरोध तुरंत भेजा जाता है. इसमें नई बनाई गई ऑडियंस की सूची को CREATING स्थिति में दिखाया जाता है. अगर वेबहुक को भेजा गया पहला अनुरोध पूरा नहीं होता है, तो audienceLists.create ऑपरेशन से गड़बड़ी और वेबहुक के काम न करने की जानकारी मिलती है.
  2. दूसरा 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 मेथड का इस्तेमाल करके क्वेरी करने के लिए तैयार है.

audienceLists.create तरीके को कॉल करने के बाद वेबहुक की जांच करने के लिए, अपने Cloud Run वेबहुक ऐप्लिकेशन के लॉग की जांच करें. साथ ही, Google Analytics से भेजी गई हर सूचना का JSON बॉडी देखें.