این صفحه رویدادهای چرخه عمری که برای اشتراکهای Google Workspace دریافت میکنید و نحوه استفاده از رویدادها برای حفظ اشتراک فعال را توضیح میدهد.
رابط برنامهنویسی کاربردی رویدادهای فضای کاری گوگل (Google Workspace Events API) انواع رویدادهای چرخه عمر زیر را ارسال میکند:
- رویدادهای تعلیق که هنگام تعلیق اشتراک شما به دلیل خطا، به شما اطلاع میدهند.
- رویدادهای یادآوری انقضا که به شما اطلاع میدهند اشتراک شما به زودی منقضی میشود.
- رویدادهای منقضیشده که زمان انقضای اشتراک شما را اطلاع میدهند.
برنامه شما باید صریحاً این نوع رویدادهای چرخه عمر را مدیریت کند و انواع رویدادهای جدیدی را که ممکن است در آینده ظاهر شوند، نادیده بگیرد.
رویدادهای چرخه عمر از API رویدادهای Google Workspace طبق مشخصات CloudEvents ساختار یافتهاند. برای کسب اطلاعات بیشتر، به ساختار رویدادهای Google Workspace مراجعه کنید.
رویدادهای تعلیق
وقتی خطایی برای اشتراک Google Workspace رخ میدهد، API رویدادهای Google Workspace اشتراک را به حالت تعلیق در میآورد و از دریافت رویدادها توسط آن جلوگیری میکند. قبل از فعالسازی مجدد اشتراک، هرگونه خطای مربوط به آن را برطرف کنید.
برای اطلاعرسانی در مورد تعلیق، رابط برنامهنویسی کاربردی رویدادهای فضای کاری گوگل (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) رویدادهای چرخه عمر را ۱۲ ساعت و یک ساعت قبل از زمان انقضا ارسال میکند. نوع رویداد برای رویدادهای چرخه عمر، 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",
...
}
}
}
رویدادهای منقضی شده اشتراک
API رویدادهای Google Workspace وقتی اشتراک منقضی میشود، یک رویداد چرخه حیات برای شما ارسال میکند. نوع رویداد برای این رویداد چرخه حیات google.workspace.events.subscription.v1.expired است.
API رویدادهای Google Workspace اشتراکهای منقضی شده را به طور دائم حذف میکند. اگر اشتراک شما منقضی شد، از متد 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",
...
}
}
}