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 aktif.

Google Workspace Events API mengirimkan jenis peristiwa siklus proses berikut:

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

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

Peristiwa penangguhan

Saat terjadi error pada langganan Google Workspace, Google Workspace Events API akan menangguhkan langganan dan mencegahnya menerima peristiwa. Anda harus mengatasi error terkait 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.

Gambar berikut menampilkan CloudEvent untuk peristiwa siklus proses terkait 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",
      ...
    }
  }
}

Peristiwa pengingat masa berlaku

Setelah masa berlaku 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 habis masa berlakunya, Google Workspace Events API akan mengirimkan peristiwa siklus proses 12 jam satu jam sebelum masa berlaku habis. Jenis peristiwa untuk peristiwa siklus proses adalah google.workspace.events.subscription.v1.expirationReminder.

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

Tabel berikut menampilkan CloudEvent untuk peristiwa siklus proses terkait langganan Google Workspace yang akan habis masa berlakunya:

{
  "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 mengirimi Anda peristiwa siklus proses 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 habis masa berlakunya secara permanen. Jika masa berlaku langganan telah berakhir, Anda dapat menggunakan metode subscriptions.create() untuk membuat langganan lain. Untuk mengetahui detailnya, lihat Membuat langganan Google Workspace.

Gambar berikut menampilkan CloudEvent untuk peristiwa siklus proses terkait langganan Google Workspace yang telah habis masa berlakunya:

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