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 و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 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."]]],[]]
