WebhookNotification
यह लंबे समय तक चलने वाले ऑपरेशन के रिसॉर्स को कॉन्फ़िगर करता है, ताकि रिसॉर्स अपडेट होने पर, Google Analytics Data API से आपके वेबहुक सर्वर पर वेबहुक सूचना भेजी जा सके.
सूचना कॉन्फ़िगरेशन में निजी वैल्यू होती हैं और ये सिर्फ़ आपके GCP प्रोजेक्ट को दिखती हैं. अलग-अलग GCP प्रोजेक्ट, लंबे समय तक चलने वाले एक ही ऑपरेशन रिसॉर्स में अलग-अलग वेबहुक सूचनाएं अटैच कर सकते हैं.
| JSON के काेड में दिखाना |
{
"uri": string,
"channelToken": string
} |
| फ़ील्ड |
uri |
string
ज़रूरी नहीं. वह वेब पता जिस पर वेबहुक सूचना मिलेगी. लंबे समय तक चलने वाले ऑपरेशन के रिसॉर्स की स्थिति में बदलाव होने पर, इस पते पर POST अनुरोध मिलेंगे. POST अनुरोध में, बॉडी में लंबे समय तक चलने वाले ऑपरेशन रिसॉर्स का JSON वर्शन और sentTimestamp फ़ील्ड, दोनों शामिल होंगे. भेजे गए टाइमस्टैंप से, अनुरोध भेजे जाने के बाद के यूनिक्स माइक्रोसेकंड की जानकारी मिलेगी. इससे, आपको फिर से चलने वाली सूचनाओं की पहचान करने में मदद मिलेगी. यूआरआई का एक उदाहरण https://us-central1-example-project-id.cloudfunctions.net/example-function-1 है. यूआरआई में एचटीटीपीएस का इस्तेमाल किया जाना चाहिए. साथ ही, यह वेब सर्वर पर मान्य एसएसएल सर्टिफ़िकेट वाली साइट पर ले जाना चाहिए. यूआरआई की स्ट्रिंग में ज़्यादा से ज़्यादा 128 वर्ण होने चाहिए. साथ ही, इसमें सिर्फ़ RFC 1738 में बताए गए वर्ण इस्तेमाल किए जाने चाहिए. जब आपके वेबहुक सर्वर को सूचना मिलती है, तो उसे पांच सेकंड के अंदर एचटीटीपी रिस्पॉन्स स्टेटस कोड 200 के साथ जवाब देना चाहिए. वेबहुक सूचनाओं का इस्तेमाल करने के लिए, यूआरआई डालना ज़रूरी है. इस वेबहुक सर्वर के अनुरोधों में, सेवा खाते google-analytics-audience-export@system.gserviceaccount.com की पुष्टि करने वाला आईडी टोकन शामिल होगा. आईडी टोकन के बारे में ज़्यादा जानने के लिए, https://cloud.google.com/docs/authentication/token-types#id पर जाएं. Google Cloud Functions के लिए, इससे अपने फ़ंक्शन को पुष्टि करने की ज़रूरत के हिसाब से कॉन्फ़िगर किया जा सकता है. Google Cloud Functions की पुष्टि करने के लिए, आपको Cloud IAM में webhook पोस्ट अनुरोध के लिए, Cloud Run Invoker (roles/run.invoker) और Cloud Functions Invoker (roles/cloudfunctions.invoker) की भूमिकाओं को सेवा खाते की अनुमतियां देनी होंगी. यह एपीआई, किसी भी यूआरआई पर वेबहुक सूचनाएं भेज सकता है. Google Cloud Functions के अलावा, दूसरे वेबहुक सर्वर के लिए, अनुमति देने वाले हेडर में मौजूद इस आईडी टोकन को अनदेखा किया जाना चाहिए. हालांकि, ऐसा तब ही करना चाहिए, जब इसकी ज़रूरत न हो.
|
channelToken |
string
ज़रूरी नहीं. चैनल टोकन, कोई भी स्ट्रिंग वैल्यू हो सकती है. साथ ही, स्ट्रिंग की लंबाई ज़्यादा से ज़्यादा 64 वर्ण होनी चाहिए. चैनल टोकन की मदद से, वेबहुक सूचना के सोर्स की पुष्टि की जा सकती है. इससे, मैसेज के स्पूफ होने से बचा जा सकता है. चैनल टोकन, वेबहुक पोस्ट अनुरोध के X-Goog-Channel-Token एचटीटीपी हेडर में बताया जाएगा. वेबहुक सूचनाओं का इस्तेमाल करने के लिए, चैनल टोकन की ज़रूरत नहीं है.
|
जब तक कुछ अलग से न बताया जाए, तब तक इस पेज की सामग्री को Creative Commons Attribution 4.0 License के तहत और कोड के नमूनों को Apache 2.0 License के तहत लाइसेंस मिला है. ज़्यादा जानकारी के लिए, Google Developers साइट नीतियां देखें. Oracle और/या इससे जुड़ी हुई कंपनियों का, Java एक रजिस्टर किया हुआ ट्रेडमार्क है.
आखिरी बार 2024-11-20 (UTC) को अपडेट किया गया.
[null,null,["आखिरी बार 2024-11-20 (UTC) को अपडेट किया गया."],[[["Webhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server."],["These notifications are project-specific and include a JSON payload with operation details and a timestamp."],["The webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification."],["When receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds."],["Authentication for Google Cloud Functions is provided through an ID token representing the service account `google-analytics-audience-export@system.gserviceaccount.com`, while other webhook servers can ignore this token."]]],["This document outlines the configuration for webhook notifications from the Google Analytics Data API. You can set up a webhook server (`uri`) to receive POST requests containing long-running operation resource updates in JSON format, along with a `sentTimestamp`. The `uri` must be HTTPS with a valid SSL certificate and is required for webhook notifications. Optionally, use a `channelToken` for source verification, which is included in the `X-Goog-Channel-Token` header. Notifications will include an ID token for authentication.\n"]]
