سرور MCP را برای Google Analytics امتحان کنید. از
GitHub نصب کنید و برای جزئیات بیشتر به
اطلاعیه مراجعه کنید.
WebhookNotification
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یک منبع عملیات طولانی‌مدت را برای ارسال اعلان وب هوک از Google Analytics Data API به سرور وب هوک شما هنگام به‌روزرسانی منبع پیکربندی می‌کند.
پیکربندی‌های اعلان حاوی مقادیر خصوصی هستند و فقط برای پروژه GCP شما قابل مشاهده هستند. پروژه های مختلف GCP ممکن است اعلان های مختلف وب هوک را به یک منبع عملیات طولانی مدت متصل کنند.
| نمایندگی JSON |
|---|
{
"uri": string,
"channelToken": string
} |
| فیلدها |
|---|
uri | string اختیاری. آدرس وب که اعلان وب هوک را دریافت می کند. با تغییر وضعیت منابع عملیات طولانی مدت، این آدرس درخواست های POST را دریافت می کند. درخواست POST شامل یک نسخه JSON از منبع عملیات طولانی در بدنه و یک فیلد sentTimestamp خواهد بود. مهر زمانی ارسال شده، میکروثانیه های یونیکس را از زمان ارسال درخواست مشخص می کند. این به شما امکان می دهد اعلان های پخش شده را شناسایی کنید. یک URI نمونه https://us-central1-example-project-id.cloudfunctions.net/example-function-1 است. URI باید از HTTPS استفاده کند و به سایتی با گواهینامه SSL معتبر در سرور وب اشاره کند. URI باید حداکثر طول رشته 128 کاراکتر داشته باشد و فقط از کاراکترهای مجاز RFC 1738 استفاده کند. هنگامی که سرور وب هوک شما اعلان دریافت می کند، انتظار می رود که در عرض 5 ثانیه با کد وضعیت پاسخ HTTP 200 پاسخ دهد. یک URI برای استفاده از اعلان‌های وب هوک لازم است. درخواست‌ها به این سرور وب هوک حاوی یک رمز شناسه است که اعتبار حساب سرویس google-analytics-audience-export@system.gserviceaccount.com را تأیید می‌کند. برای کسب اطلاعات بیشتر درباره نشانه‌های شناسه، به https://cloud.google.com/docs/authentication/token-types#id مراجعه کنید. برای توابع Google Cloud، این به شما امکان می دهد عملکرد خود را طوری پیکربندی کنید که نیاز به احراز هویت داشته باشد. در Cloud IAM، باید مجوزهای حساب سرویس را به Cloud Run Invoker ( roles/run.invoker ) و Cloud Functions Invoker ( roles/cloudfunctions.invoker ) برای درخواست پست webhook بدهید تا احراز هویت Google Cloud Functions را انجام دهد. این API می‌تواند اعلان‌های webhook را به URIهای دلخواه ارسال کند. برای سرورهای وب هوک غیر از Google Cloud Functions، در صورت عدم نیاز، این رمز شناسه در هدر حامل مجوز باید نادیده گرفته شود. |
channel Token | string اختیاری. نشانه کانال یک مقدار رشته دلخواه است و باید حداکثر طول رشته 64 کاراکتر داشته باشد. توکن های کانال به شما امکان می دهند منبع اعلان وب هوک را تأیید کنید. این از جعل شدن پیام محافظت می کند. توکن کانال در هدر HTTP X-Goog-Channel-Token درخواست webhook POST مشخص خواهد شد. برای استفاده از اعلان‌های وب هوک نیازی به توکن کانال نیست. |
،
یک منبع عملیات طولانی‌مدت را برای ارسال اعلان وب هوک از Google Analytics Data API به سرور وب هوک شما هنگام به‌روزرسانی منبع پیکربندی می‌کند.
پیکربندی‌های اعلان حاوی مقادیر خصوصی هستند و فقط برای پروژه GCP شما قابل مشاهده هستند. پروژه های مختلف GCP ممکن است اعلان های مختلف وب هوک را به یک منبع عملیات طولانی مدت متصل کنند.
| نمایندگی JSON |
|---|
{
"uri": string,
"channelToken": string
} |
| فیلدها |
|---|
uri | string اختیاری. آدرس وب که اعلان وب هوک را دریافت می کند. با تغییر وضعیت منابع عملیات طولانی مدت، این آدرس درخواست های POST را دریافت می کند. درخواست POST شامل یک نسخه JSON از منبع عملیات طولانی در بدنه و یک فیلد sentTimestamp خواهد بود. مهر زمانی ارسال شده، میکروثانیه های یونیکس را از زمان ارسال درخواست مشخص می کند. این به شما امکان می دهد اعلان های پخش شده را شناسایی کنید. یک URI نمونه https://us-central1-example-project-id.cloudfunctions.net/example-function-1 است. URI باید از HTTPS استفاده کند و به سایتی با گواهینامه SSL معتبر در سرور وب اشاره کند. URI باید حداکثر طول رشته 128 کاراکتر داشته باشد و فقط از کاراکترهای مجاز RFC 1738 استفاده کند. هنگامی که سرور وب هوک شما اعلان دریافت می کند، انتظار می رود که در عرض 5 ثانیه با کد وضعیت پاسخ HTTP 200 پاسخ دهد. یک URI برای استفاده از اعلان‌های وب هوک لازم است. درخواست‌ها به این سرور وب هوک حاوی یک رمز شناسه است که اعتبار حساب سرویس google-analytics-audience-export@system.gserviceaccount.com را تأیید می‌کند. برای کسب اطلاعات بیشتر درباره نشانه‌های شناسه، به https://cloud.google.com/docs/authentication/token-types#id مراجعه کنید. برای توابع Google Cloud، این به شما امکان می دهد عملکرد خود را طوری پیکربندی کنید که نیاز به احراز هویت داشته باشد. در Cloud IAM، باید مجوزهای حساب سرویس را به Cloud Run Invoker ( roles/run.invoker ) و Cloud Functions Invoker ( roles/cloudfunctions.invoker ) برای درخواست پست webhook بدهید تا احراز هویت Google Cloud Functions را انجام دهد. این API می‌تواند اعلان‌های webhook را به URIهای دلخواه ارسال کند. برای سرورهای وب هوک غیر از Google Cloud Functions، در صورت عدم نیاز، این رمز شناسه در هدر حامل مجوز باید نادیده گرفته شود. |
channel Token | string اختیاری. نشانه کانال یک مقدار رشته دلخواه است و باید حداکثر طول رشته 64 کاراکتر داشته باشد. توکن های کانال به شما امکان می دهند منبع اعلان وب هوک را تأیید کنید. این از جعل شدن پیام محافظت می کند. توکن کانال در هدر HTTP X-Goog-Channel-Token درخواست webhook POST مشخص خواهد شد. برای استفاده از اعلان‌های وب هوک نیازی به توکن کانال نیست. |
،
یک منبع عملیات طولانی‌مدت را برای ارسال اعلان وب هوک از Google Analytics Data API به سرور وب هوک شما هنگام به‌روزرسانی منبع پیکربندی می‌کند.
پیکربندی‌های اعلان حاوی مقادیر خصوصی هستند و فقط برای پروژه GCP شما قابل مشاهده هستند. پروژه های مختلف GCP ممکن است اعلان های مختلف وب هوک را به یک منبع عملیات طولانی مدت متصل کنند.
| نمایندگی JSON |
|---|
{
"uri": string,
"channelToken": string
} |
| فیلدها |
|---|
uri | string اختیاری. آدرس وب که اعلان وب هوک را دریافت می کند. با تغییر وضعیت منابع عملیات طولانی مدت، این آدرس درخواست های POST را دریافت می کند. درخواست POST شامل یک نسخه JSON از منبع عملیات طولانی در بدنه و یک فیلد sentTimestamp خواهد بود. مهر زمانی ارسال شده، میکروثانیه های یونیکس را از زمان ارسال درخواست مشخص می کند. این به شما امکان می دهد اعلان های پخش شده را شناسایی کنید. یک URI نمونه https://us-central1-example-project-id.cloudfunctions.net/example-function-1 است. URI باید از HTTPS استفاده کند و به سایتی با گواهینامه SSL معتبر در سرور وب اشاره کند. URI باید حداکثر طول رشته 128 کاراکتر داشته باشد و فقط از کاراکترهای مجاز RFC 1738 استفاده کند. هنگامی که سرور وب هوک شما اعلان دریافت می کند، انتظار می رود که در عرض 5 ثانیه با کد وضعیت پاسخ HTTP 200 پاسخ دهد. یک URI برای استفاده از اعلان‌های وب هوک لازم است. درخواست‌ها به این سرور وب هوک حاوی یک رمز شناسه است که اعتبار حساب سرویس google-analytics-audience-export@system.gserviceaccount.com را تأیید می‌کند. برای کسب اطلاعات بیشتر درباره نشانه‌های شناسه، به https://cloud.google.com/docs/authentication/token-types#id مراجعه کنید. برای توابع Google Cloud، این به شما امکان می دهد عملکرد خود را طوری پیکربندی کنید که نیاز به احراز هویت داشته باشد. در Cloud IAM، باید مجوزهای حساب سرویس را به Cloud Run Invoker ( roles/run.invoker ) و Cloud Functions Invoker ( roles/cloudfunctions.invoker ) برای درخواست پست webhook بدهید تا احراز هویت Google Cloud Functions را انجام دهد. این API می‌تواند اعلان‌های webhook را به URIهای دلخواه ارسال کند. برای سرورهای وب هوک غیر از Google Cloud Functions، در صورت عدم نیاز، این رمز شناسه در هدر حامل مجوز باید نادیده گرفته شود. |
channel Token | string اختیاری. نشانه کانال یک مقدار رشته دلخواه است و باید حداکثر طول رشته 64 کاراکتر داشته باشد. توکن های کانال به شما امکان می دهند منبع اعلان وب هوک را تأیید کنید. این از جعل شدن پیام محافظت می کند. توکن کانال در هدر HTTP X-Goog-Channel-Token درخواست webhook POST مشخص خواهد شد. برای استفاده از اعلان‌های وب هوک نیازی به توکن کانال نیست. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]
