WebhookNotification

यह नीति लंबे समय तक चलने वाले ऑपरेशन संसाधन को कॉन्फ़िगर करती है, ताकि संसाधन अपडेट होने पर यह Google Analytics Data API से आपके वेबहुक सर्वर पर सूचना भेज सके.

सूचना के कॉन्फ़िगरेशन में निजी वैल्यू होती हैं और ये सिर्फ़ आपके GCP प्रोजेक्ट में दिखती हैं. GCP के अलग-अलग प्रोजेक्ट, लंबे समय तक चलने वाले एक ही ऑपरेशन संसाधन में अलग-अलग वेबहुक सूचनाएं अटैच कर सकते हैं.

जेएसओएन के काेड में दिखाना 
{
  "uri": string,
  "channelToken": string
}
फ़ील्ड
uri

string

ज़रूरी नहीं. वह वेब पता जिस पर वेबहुक सूचना मिलेगी. लंबे समय तक चलने वाली कार्रवाई के संसाधन में बदलाव होने पर, इस पते को पोस्ट अनुरोध मिलेंगे. पोस्ट अनुरोध में, मुख्य भाग में लंबे समय तक चलने वाली कार्रवाई के संसाधन के JSON वर्शन और sentTimestamp फ़ील्ड, दोनों शामिल होंगे. भेजा गया टाइमस्टैंप, अनुरोध भेजे जाने के epoch के बाद के यूनिक्स माइक्रोसेकंड के बारे में बताता है. इसकी मदद से, फिर से चलाई गई सूचनाओं की पहचान की जा सकती है.

यूआरआई का उदाहरण https://us-central1-example-project-id.cloudfunctions.net/example-function-1 है.

यूआरआई को एचटीटीपीएस का इस्तेमाल करना चाहिए और वेब सर्वर पर मान्य एसएसएल सर्टिफ़िकेट वाली साइट पर ले जाना चाहिए. यूआरआई की स्ट्रिंग, ज़्यादा से ज़्यादा 128 वर्णों की होनी चाहिए. साथ ही, इसमें आरएफ़सी 1738 से, अनुमति वाली सूची में शामिल वर्णों का ही इस्तेमाल किया जाना चाहिए.

जब आपके वेबहुक सर्वर को कोई सूचना मिलती है, तो वह पांच सेकंड के अंदर जवाब में 200 का एचटीटीपी रिस्पॉन्स स्टेटस कोड भेज देता है.

वेबहुक सूचनाओं का इस्तेमाल करने के लिए यूआरआई ज़रूरी है.

इस वेबहुक सर्वर के अनुरोधों में एक आईडी टोकन शामिल होगा, जो सेवा खाते google-analytics-audience-export@system.gserviceaccount.com की पुष्टि करेगा. आईडी टोकन के बारे में ज़्यादा जानने के लिए, https://cloud.google.com/docs/authentication/token-types#id देखें. Google Cloud Functions के लिए, यह आपको अपना फ़ंक्शन कॉन्फ़िगर करने की सुविधा देता है, ताकि पुष्टि करने की ज़रूरत हो. Cloud IAM में, आपको Cloud Run Invoker (roles/run.invoker) और Cloud Functions Invoker (roles/cloudfunctions.invoker) की भूमिकाओं के लिए, सेवा खाते की अनुमतियां देनी होंगी, ताकि वेबहुक पोस्ट अनुरोध Google Cloud Functions की पुष्टि करने की प्रोसेस को पास कर सके. यह एपीआई, आर्बिट्रेरी यूआरआई को वेबहुक सूचनाएं भेज सकता है. Google Cloud Functions के अलावा दूसरे वेबहुक सर्वर के लिए, अगर अनुमति देने वाले हेडर में इस आईडी टोकन की ज़रूरत नहीं है, तो इसे अनदेखा किया जाना चाहिए.
channelToken

string

ज़रूरी नहीं. चैनल टोकन, एक आर्बिट्रेरी स्ट्रिंग वैल्यू है. साथ ही, स्ट्रिंग की लंबाई 64 वर्णों से ज़्यादा नहीं होनी चाहिए. चैनल टोकन की मदद से, वेबहुक सूचना के सोर्स की पुष्टि की जा सकती है. यह मैसेज को स्पूफ़ किए जाने से बचाता है. चैनल टोकन, वेबहुक पोस्ट अनुरोध के X-Goog-Channel-Token एचटीटीपी हेडर में दिखाया जाएगा.

वेबहुक सूचनाओं का इस्तेमाल करने के लिए, चैनल टोकन की ज़रूरत नहीं होती है.