WebhookNotification

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

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

JSON के काेड में दिखाना 
{
  "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) और Google Cloud Functions की पुष्टि को पास करने के लिए, वेबहुक पोस्ट अनुरोध के लिए Cloud Functions Invoker (roles/cloudfunctions.invoker) की भूमिकाएं. यह एपीआई, आर्बिट्रेरी यूआरआई को वेबहुक सूचनाएं भेज सकता है; Google Cloud Functions के अलावा, अन्य वेबहुक सर्वर के लिए, अनुमति देने वाले बियरर हेडर में मौजूद इस आईडी टोकन की ज़रूरत न होने पर इसे अनदेखा किया जाना चाहिए.
channelToken

string

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

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