جرِّب خادم MCP لخدمة "إحصاءات Google". يمكنك تثبيت التطبيق من
GitHub والاطّلاع على
الإعلان لمعرفة المزيد من التفاصيل.
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 و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eWebhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server.\u003c/p\u003e\n"],["\u003cp\u003eThese notifications are project-specific and include a JSON payload with operation details and a timestamp.\u003c/p\u003e\n"],["\u003cp\u003eThe webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification.\u003c/p\u003e\n"],["\u003cp\u003eWhen receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for Google Cloud Functions is provided through an ID token representing the service account \u003ccode\u003egoogle-analytics-audience-export@system.gserviceaccount.com\u003c/code\u003e, while other webhook servers can ignore this token.\u003c/p\u003e\n"]]],["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"],null,["# WebhookNotification\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nConfigures a long-running operation resource to send a webhook notification from the Google Analytics Data API to your webhook server when the resource updates.\n\nNotification configurations contain private values \\& are only visible to your GCP project. Different GCP projects may attach different webhook notifications to the same long-running operation resource.\n\n| JSON representation |\n|---------------------------------------------------|\n| ``` { \"uri\": string, \"channelToken\": string } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `uri` | `string` Optional. The web address that will receive the webhook notification. This address will receive POST requests as the state of the long running operation resource changes. The POST request will contain both a JSON version of the long running operation resource in the body and a `sentTimestamp` field. The sent timestamp will specify the unix microseconds since the epoch that the request was sent; this lets you identify replayed notifications. An example URI is `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`. The URI must use HTTPS and point to a site with a valid SSL certificate on the web server. The URI must have a maximum string length of 128 characters \\& use only the allowlisted characters from [RFC 1738](https://www.rfc-editor.org/rfc/rfc1738). When your webhook server receives a notification, it is expected to reply with an HTTP response status code of 200 within 5 seconds. A URI is required to use webhook notifications. Requests to this webhook server will contain an ID token authenticating the service account `google-analytics-audience-export@system.gserviceaccount.com`. To learn more about ID tokens, see \u003chttps://cloud.google.com/docs/authentication/token-types#id\u003e. For Google Cloud Functions, this lets you configure your function to require authentication. In Cloud IAM, you will need to grant the service account permissions to the Cloud Run Invoker (`roles/run.invoker`) \\& Cloud Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook post request to pass Google Cloud Functions authentication. This API can send webhook notifications to arbitrary URIs; for webhook servers other than Google Cloud Functions, this ID token in the authorization bearer header should be ignored if it is not needed. |\n| `channel``Token` | `string` Optional. The channel token is an arbitrary string value and must have a maximum string length of 64 characters. Channel tokens allow you to verify the source of a webhook notification. This guards against the message being spoofed. The channel token will be specified in the `X-Goog-Channel-Token` HTTP header of the webhook POST request. A channel token is not required to use webhook notifications. |"]]
