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