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

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

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

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

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

אירועי השעיה

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

כדי להודיע לכם על השעיה, Google Workspace Event 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 Event API ולא ניתן לחדש אותו או להפעיל אותו מחדש.

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

כשמקבלים אירוע תזכורת שפג תוקפו, אפשר להשתמש בשיטה 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 Event API שולח לכם אירוע במחזור החיים כשפג תוקף המינוי. סוג האירוע עבור האירוע הזה במחזור החיים הוא google.workspace.events.subscription.v1.expired.

מינויים שתוקפם פג יימחקו באופן סופי מ-Google Workspace Event API. אם תוקף המינוי יפוג, תוכלו להשתמש בשיטה 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",
      ...
    }
  }
}