הודעות

ה-Alert Center API יכול לשלוח התראות כשההתראות מתעדכנות. כדי לקבל התראות, צריך להגדיר את הגדרות ההתראות.

התראות Pub/Sub

ממשק Alert Center API יכול לפרסם התראות בנושא Pub/Sub. אחרי שיוצרים נושא ומעניקים alerts-api-push-notifications@system.gserviceaccount.comהרשאת פרסום, משתמשים ב-Alert Center API update settings API כדי להגדיר את הנושא הזה כיעד להודעות. אחרי שמגדירים את Alert Center API, הוא מפרסם הודעה בנושא הזה בכל עדכון, למשל כשמתקבלת התראה חדשה.

מאפייני הודעות ב-Pub/Sub

בקטעים הבאים מתוארים המאפיינים שכלולים בהודעות Pub/Sub.

מאפיינים נפוצים

  • ‫alertcenter_resource_type: סוג המשאב. הערך הנתמך הוא "ALERT".
  • ‫alertcenter_resource_status: הסטטוס של המשאב. הערכים הנתמכים הם "CREATED",‏ "DELETED",‏ "UNDELETED" ו-"MODIFIED".
  • ‫alertcenter_payload_format: הפורמט של מטען הייעודי. הערך הנתמך הוא "JSON".

מאפייני ההתראה

  • alertcenter_start_time: השעה שבה התחיל האירוע שגרם להתראה הזו או השעה שבה הוא זוהה.
  • alertcenter_end_time: השעה שבה האירוע שגרם להתראה הזו הפסיק להיות פעיל.
  • ‫alertcenter_type: סוג ההתראה. רשימה של סוגי ההתראות הזמינים מופיעה במאמר סוגי ההתראות של Google Workspace.
  • ‫alertcenter_source: מזהה ייחודי של המערכת שדיווחה על ההתראה.
  • alertcenter_create_time: השעה שבה נוצרה ההתראה.
  • ‫alertcenter_update_time: הפעם האחרונה שבה ההתראה הזו עודכנה.

מטען ייעודי (payload) של הודעה

המטען הייעודי (payload) של ההודעה תלוי ב-alertcenter_resource_type. כשסוג המשאב הוא "ALERT", המטען הייעודי (Payload) הוא אחד מסוגי ההתראות של Alert Center API. הפורמט של מטען הייעודי (payload) תלוי ב-alertcenter_payload_format. אם הפורמט הוא "JSON", המטען הייעודי הוא אובייקט JSON בקידוד base64.