Menerima dan merespons peristiwa siklus proses untuk langganan Google Workspace

Halaman ini menjelaskan peristiwa siklus proses yang Anda terima untuk langganan Google Workspace, dan cara menggunakan peristiwa tersebut untuk mempertahankan langganan yang aktif.

Google Workspace Events API mengirimkan jenis peristiwa siklus proses berikut:

Aplikasi Anda harus menangani jenis peristiwa siklus proses ini secara eksplisit dan mengabaikan jenis peristiwa baru yang mungkin muncul pada masa mendatang.

Peristiwa siklus proses dari Google Workspace Events API disusun sesuai dengan spesifikasi CloudEvents. Untuk mempelajari lebih lanjut, lihat Struktur acara Google Workspace.

Peristiwa penangguhan

Jika terjadi error pada langganan Google Workspace, Google Workspace Events API akan menangguhkan langganan dan mencegahnya menerima peristiwa. Atasi error apa pun pada langganan sebelum mengaktifkannya kembali.

Untuk memberi tahu Anda tentang penangguhan, Google Workspace Events API mengirimkan peristiwa siklus proses dengan jenis peristiwa google.workspace.events.subscription.v1.suspended.

Setelah menerima peristiwa penangguhan, Anda dapat mempelajari alasan penangguhan, mengatasi error, dan mengaktifkan kembali langganan. Untuk mengetahui detailnya, lihat Mengatasi error dan mengaktifkan kembali langganan Google Workspace.

Berikut menunjukkan CloudEvent untuk peristiwa siklus proses tentang langganan Google Workspace yang ditangguhkan karena error 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",
      ...
    }
  }
}

Acara pengingat waktu berakhir

Setelah langganan berakhir, Google Workspace Events API akan menghapusnya secara permanen, dan Anda tidak dapat memperpanjang atau mengaktifkannya kembali.

Untuk memberi tahu Anda tentang langganan yang akan berakhir, Google Workspace Events API mengirimkan peristiwa siklus proses 12 jam dan satu jam sebelum waktu berakhir. Jenis peristiwa untuk peristiwa siklus proses adalah google.workspace.events.subscription.v1.expirationReminder.

Saat Anda menerima peristiwa pengingat masa berlaku berakhir, gunakan metode subscriptions.update() untuk memperbarui waktu habis masa berlaku. Untuk mengetahui detailnya, lihat Memperbarui atau memperpanjang langganan Google Workspace.

Berikut ini menunjukkan CloudEvent untuk peristiwa siklus proses tentang langganan Google Workspace yang akan berakhir:

{
  "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",
      ...
    }
  }
}

Peristiwa masa berlaku langganan berakhir

Google Workspace Events API akan mengirimkan peristiwa siklus proses kepada Anda saat langganan berakhir. Jenis peristiwa untuk peristiwa siklus proses ini adalah google.workspace.events.subscription.v1.expired.

Google Workspace Events API menghapus langganan yang telah berakhir secara permanen. Jika langganan Anda berakhir, gunakan metode subscriptions.create() untuk membuat langganan lain. Untuk mengetahui detailnya, lihat Membuat langganan Google Workspace.

Berikut ini menunjukkan CloudEvent untuk peristiwa siklus proses tentang langganan Google Workspace yang telah berakhir:

{
  "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",
      ...
    }
  }
}