تلقّي أحداث مراحل النشاط والردّ عليها لاشتراكات Google Workspace

توضّح هذه الصفحة أحداث مراحل النشاط التي تتلقّاها بشأن اشتراكات Google Workspace، وكيفية استخدام الأحداث للحفاظ على اشتراك نشط.

ترسل واجهة برمجة تطبيقات أحداث Google Workspace أنواع أحداث مراحل النشاط التالية:

يجب أن يتعامل تطبيقك بشكل صريح مع أنواع أحداث مراحل النشاط هذه وأن يتجاهل أنواع الأحداث الجديدة التي قد تظهر في المستقبل.

يتم تنظيم أحداث دورة الحياة من Google Workspace Events API وفقًا لمواصفات CloudEvents. لمزيد من المعلومات، يُرجى الاطّلاع على بنية أحداث Google Workspace.

فعّاليات التعليق

عند حدوث خطأ في اشتراك Google Workspace، تعلّق Google Workspace Events API الاشتراك وتمنعه من تلقّي الأحداث. عليك حلّ أي أخطاء في الاشتراك قبل إعادة تفعيله.

لإعلامك بالتعليق، ترسل "واجهة برمجة تطبيقات أحداث Google Workspace" حدث يتم في مراحل النشاط بنوع الحدث 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 أحداث مراحل النشاط قبل 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",
      ...
    }
  }
}