WebhookNotification

تضبط موردًا لعملية طويلة الأمد لإرسال إشعار الردّ التلقائي على الويب من Google Analytics Data API إلى خادم الردّ التلقائي على الويب عند تعديل المورد.

تحتوي إعدادات الإشعارات على قيم خاصة لن تكون مرئية إلا لمشروع Google Cloud Platform. قد تُرفِق مشاريع Google Cloud Platform المختلفة إشعارات مختلفة للردّ التلقائي على الويب بمورد العملية نفسه على المدى الطويل.

تمثيل JSON 
{
  "uri": string,
  "channelToken": string
}
الحقول
uri

string

اختياريّ. عنوان الويب الذي سيتلقى إشعار الردّ التلقائي على الويب. سيتلقّى هذا العنوان طلبات POST عندما تتغيّر حالة موارد العملية الطويلة الأمد. سيحتوي طلب POST على إصدار JSON لمورد العملية الذي يعمل لفترة طويلة في النص الأساسي وحقل sentTimestamp. سيحدِّد الطابع الزمني المُرسَل وحدات ميكروثانية في نظام التشغيل Unix منذ الفترة التي تم إرسال الطلب فيها. يتيح لك تحديد الإشعارات التي تمت إعادة تشغيلها.

مثال على معرّف الموارد المنتظم (URI) هو https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

يجب أن يستخدم معرِّف الموارد المنتظم (URI) بروتوكول HTTPS ويوجّه المستخدمين إلى موقع إلكتروني يحتوي على شهادة طبقة مقابس آمنة (SSL) صالحة على خادم الويب. يجب أن يتكون معرف الموارد المنتظم (URI) من 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، يتيح لك ذلك ضبط وظيفتك لطلب المصادقة. في Cloud IAM، عليك منح أذونات حساب الخدمة إلى "مُصدر تشغيل السحابة الإلكترونية" (roles/run.invoker). أدوار مرسِل خدمة Cloud Functions (roles/cloudfunctions.invoker) في طلب إرسال الردّ التلقائي على الويب من أجل اجتياز مصادقة Google Cloud Functions. ويمكن لواجهة برمجة التطبيقات هذه إرسال إشعارات الرد التلقائي على الويب إلى معرّفات الموارد المنتظمة (URI) العشوائية. بالنسبة إلى خوادم الرد التلقائي على الويب بخلاف Google Cloud Functions، يجب تجاهل الرمز المميّز للمعرّف في عنوان حامل التفويض إذا لم يكن مطلوبًا.
channelToken

string

اختياريّ. الرمز المميّز للقناة هو قيمة سلسلة عشوائية ويجب أن يتكوّن من 64 حرفًا بحدّ أقصى لطول السلسلة. تسمح لك الرموز المميّزة للقناة بالتحقّق من مصدر إشعار الردّ التلقائي على الويب. ويوفر هذا الحماية ضد انتحال الرسالة. سيتم تحديد الرمز المميّز للقناة في عنوان HTTP X-Goog-Channel-Token لطلب POST للردّ التلقائي على الويب.

لا حاجة إلى رمز مميّز للقناة من أجل استخدام إشعارات الردّ التلقائي على الويب.