رویدادهای چرخه حیات اشتراک‌های 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 یک رویداد چرخه حیات را برای شما ارسال می‌کند. نوع رویداد برای این رویداد چرخه حیات 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",
      ...
    }
  }
}