קבלת אירועים במחזור החיים של מינויים ל-Google Workspace ומענה עליהם

בדף הזה נסביר על אירועי מחזור החיים שמתקבלים עבור מינויים ל-Google Workspace, ועל האופן שבו אפשר להשתמש באירועים האלה כדי לשמור על מינוי פעיל.

Google Workspace Events API שולח את סוגי האירועים הבאים במחזור החיים:

האפליקציה צריכה לטפל באופן מפורש בסוגי האירועים האלה במחזור החיים ולהתעלם מסוגי אירועים חדשים שעשויים להופיע בעתיד.

אירועי מחזור חיים מ-Google Workspace Events API מובנים בהתאם למפרט של CloudEvents. מידע נוסף זמין במאמר המבנה של אירועים ב-Google Workspace.

אירועי השעיה

כשמתרחשת שגיאה במינוי ל-Google Workspace, Google Workspace Events API משהה את המינוי ומונע ממנו לקבל אירועים. עליכם לפתור את כל השגיאות במינוי לפני שתפעילו אותו מחדש.

כדי להודיע לכם על השעיה, Google Workspace Events API שולח אירוע מחזור חיים עם סוג האירוע google.workspace.events.subscription.v1.suspended.

אחרי שתקבלו אירוע השעיה, תוכלו לבדוק מה הסיבה להשעיה, לפתור שגיאות ולהפעיל מחדש את המינוי. פרטים נוספים זמינים במאמר פתרון שגיאות והפעלה מחדש של מינוי ל-Google Workspace.

בהמשך מוצג CloudEvent לאירוע מחזור חיים של מינוי ל-Google Workspace שהושעתה בגלל השגיאה ENDPOINT_PERMISSION_DENIED:

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.suspended",
  "time": "2023-06-08T06:50:43.641299Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "suspension_reason": "ENDPOINT_PERMISSION_DENIED",
      ...
    }
  }
}

אירועים של תזכורות לגבי פקיעת תוקף

אחרי שתוקף המינוי יפוג, הוא יימחק לתמיד על ידי Google Workspace Events API ולא תוכלו לחדש אותו או להפעיל אותו מחדש.

כדי להודיע לכם על תפוגת התוקף של המינוי, Google Workspace Events API שולח אירועי מחזור חיים 12 שעות ושעתיים לפני מועד התפוגה. סוג האירוע של אירועי מחזור החיים הוא google.workspace.events.subscription.v1.expirationReminder.

כשמקבלים אירוע של תזכורת לתפוגה, אפשר להשתמש ב-method‏ subscriptions.update() כדי לעדכן את מועד התפוגה. פרטים נוספים זמינים במאמר עדכון או חידוש של מינוי ל-Google Workspace.

בהמשך מוצג CloudEvent לאירוע מחזור חיים לגבי מינוי ל-Google Workspace שפג תוקפו:

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.expirationReminder",
  "time": "2023-06-08T06:50:43.641299Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "expire_time": "2023-06-08T18:50:43.641299Z",
      ...
    }
  }
}

אירועים של תפוגת תוקף המינוי

כשפג התוקף של המינוי, Google Workspace Events API שולח לכם אירוע מחזור חיים. סוג האירוע של אירוע מחזור החיים הזה הוא google.workspace.events.subscription.v1.expired.

Google Workspace Events API מחק לצמיתות מינויים שפג תוקפם. אם תוקף המינוי יפוג, תוכלו להשתמש ב-method‏ subscriptions.create() כדי ליצור מינוי חדש. פרטים נוספים זמינים במאמר יצירת מינוי ל-Google Workspace.

הדוגמה הבאה מראה CloudEvent לאירוע מחזור חיים לגבי מינוי ל-Google Workspace שפג התוקף שלו:

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.expired",
  "time": "2023-06-08T07:00:00.000000Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "expire_time": "2023-06-08T07:00:00.000000Z",
      ...
    }
  }
}