اطلاعیه ها

API مرکز هشدار می‌تواند هنگام به‌روزرسانی هشدارها، اعلان ارسال کند. برای دریافت اعلان‌ها، باید تنظیمات اعلان خود را پیکربندی کنید.

اعلان‌های انتشار/زیرمجموعه

رابط برنامه‌نویسی کاربردی مرکز هشدار (Alert Center API) می‌تواند اعلان‌ها را در یک موضوع Pub/Sub منتشر کند. پس از ایجاد یک موضوع و اعطای مجوز انتشار alerts-api-push-notifications@system.gserviceaccount.com ، از رابط برنامه‌نویسی کاربردی تنظیمات به‌روزرسانی API مرکز هشدار (Alert Center API) برای تنظیم آن موضوع به عنوان مقصد اعلان استفاده کنید. پس از پیکربندی، رابط برنامه‌نویسی کاربردی مرکز هشدار (Alert Center API) برای هر به‌روزرسانی، مثلاً زمانی که یک هشدار جدید می‌رسد، پیامی را در آن موضوع منتشر می‌کند.

ویژگی‌های پیام‌های Pub/Sub

بخش‌های زیر ویژگی‌های موجود در پیام‌های Pub/Sub را شرح می‌دهند.

ویژگی‌های مشترک

  • alertcenter_resource_type : نوع منبع. مقدار پشتیبانی شده "ALERT" است.
  • alertcenter_resource_status : وضعیت منبع. مقادیر پشتیبانی‌شده عبارتند از "CREATED" ، "DELETED" ، "UNDELETED" و "MODIFIED" .
  • alertcenter_payload_format : فرمت payload. مقدار پشتیبانی شده "JSON" است.

ویژگی‌های هشدار

  • alertcenter_start_time : زمان شروع یا شناسایی رویدادی که باعث ایجاد این هشدار شده است.
  • alertcenter_end_time : زمانی که رویدادی که باعث ایجاد این هشدار شده بود، دیگر فعال نبود.
  • alertcenter_type : نوع هشدار. برای فهرستی از انواع هشدارهای موجود، به انواع هشدارهای Google Workspace مراجعه کنید.
  • alertcenter_source : یک شناسه منحصر به فرد برای سیستمی که هشدار را گزارش کرده است.
  • alertcenter_create_time : زمان ایجاد این هشدار.
  • alertcenter_update_time : آخرین باری که این هشدار به‌روزرسانی شده است.

بار مفید پیام

مقدار بار پیام به alertcenter_resource_type بستگی دارد. وقتی نوع منبع "ALERT" باشد، مقدار بار یکی از انواع هشدار API مرکز هشدار است. قالب بار به alertcenter_payload_format بستگی دارد. وقتی قالب "JSON" باشد، مقدار بار یک شیء JSON با کدگذاری base64 است.