קבלת אירועים במחזור החיים של מינויים ל-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.

כשמקבלים אירוע תזכורת על תפוגה, משתמשים בשיטה 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 מוחק לצמיתות מינויים שתוקפם פג. אם תוקף המינוי שלכם יפוג, תוכלו להשתמש בשיטה 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",
      ...
    }
  }
}