WebhookNotification
يتمّ ضبط مورد عملية طويلة الأمد لإرسال إشعار webhook من Google Analytics Data API إلى خادم webhook عند تعديل المورد.
تحتوي إعدادات الإشعارات على قيم خاصة ولا تظهر إلا لمشروعك على Google Cloud Platform. قد تُرفِق مشاريع Google Cloud Platform المختلفة إشعارات webhook مختلفة بمصدر العملية التي تستغرق وقتًا طويلاً نفسه.
| تمثيل JSON |
{
"uri": string,
"channelToken": string
} |
| الحقول |
uri |
string
اختيارية: عنوان الويب الذي سيتلقّى إشعار webhook. سيتلقّى هذا العنوان طلبات POST عند تغيُّر حالة مورد العملية التي تستغرق وقتًا طويلاً. سيتضمّن طلب POST نسخة JSON من مورد العملية التي تستغرق وقتًا طويلاً في النصّ وحقل sentTimestamp. سيحدِّد الطابع الزمني المُرسَل ميكرو ثوانٍ نظام التشغيل Unix منذ بداية الفترة التي تم إرسال الطلب فيها، ما يتيح لك تحديد الإشعارات التي تم إعادة تشغيلها. مثال على عنوان URL هو https://us-central1-example-project-id.cloudfunctions.net/example-function-1. يجب أن يستخدم معرّف الموارد المنتظم (URI) بروتوكول HTTPS وأن يشير إلى موقع إلكتروني لديه شهادة طبقة المقابس الآمنة (SSL) صالحة على خادم الويب. يجب ألا يزيد طول سلسلة عنوان URL عن 128 حرفًا، ويجب استخدام الأحرف المسموح بها فقط من RFC 1738. عندما يتلقّى خادم وحدات الربط بالويب إشعارًا، من المتوقّع أن يردّ برمز حالة استجابة HTTP 200 في غضون 5 ثوانٍ. يجب إدخال معرّف موارد منتظم (URI) لاستخدام إشعارات طلبات الويب. ستتضمّن الطلبات المرسَلة إلى خادم وحدات الربط هذه رمز تعريف يُثبت هوية حساب الخدمة google-analytics-audience-export@system.gserviceaccount.com. للمزيد من المعلومات عن رموز التعريف، يُرجى الاطّلاع على https://cloud.google.com/docs/authentication/token-types#id. بالنسبة إلى Google Cloud Functions، يتيح لك ذلك ضبط الدالة لتطلب المصادقة. في Cloud IAM، عليك منح أذونات حساب الخدمة لدورَي "مُشغِّل Cloud Run" (roles/run.invoker) و"مُشغِّل Cloud Functions" (roles/cloudfunctions.invoker) لطلب نشر وحدات الويب لتجاوز مصادقة Google Cloud Functions. يمكن لواجهة برمجة التطبيقات هذه إرسال إشعارات وحدات الربط لصفحات الويب إلى عناوين URL عشوائية. بالنسبة إلى خوادم وحدات الربط لصفحات الويب غير Google Cloud Functions، يجب تجاهل رمز التعريف هذا في عنوان حامل الإذن إذا لم يكن مطلوبًا.
|
channelToken |
string
اختيارية: رمز قناة YouTube هو قيمة سلسلة عشوائية يجب ألا يزيد طولها عن 64 حرفًا. تتيح لك الرموز المميّزة للقناة التحقّق من مصدر إشعار webhook. ويساعد ذلك في حماية الرسالة من الانتحال. سيتم تحديد رمز مميّز للقناة في عنوان HTTP X-Goog-Channel-Token لطلب POST الخاص بالردّ التلقائي على الويب. لا يلزم توفّر رمز مميّز للقناة لاستخدام إشعارات طلبات الويب.
|
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-20 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-11-20 (حسب التوقيت العالمي المتفَّق عليه)"],[[["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."]]],[]]
