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:

• Peristiwa penangguhan yang memberi tahu Anda saat langganan Anda ditangguhkan karena error.
• Peristiwa pengingat habis masa berlaku yang memberi tahu Anda bahwa langganan Anda akan segera berakhir.
• Peristiwa yang habis masa berlakunya yang memberi tahu Anda saat langganan Anda berakhir.

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.

Catatan: Jika langganan Anda mengalami error yang terkait dengan endpoint pemberitahuannya, Anda mungkin tidak menerima peristiwa siklus proses. Untuk mempelajari dan mengatasi error endpoint, Anda dapat memantau endpoint itu sendiri. Untuk memantau endpoint yang merupakan topik Google Cloud Pub/Sub, lihat Menangani kegagalan pesan.

Peristiwa penangguhan

Saat terjadi error untuk langganan Google Workspace, Google Workspace Events API akan menangguhkan langganan dan mencegahnya menerima peristiwa. Anda harus menyelesaikan 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, menyelesaikan error, dan mengaktifkan kembali langganan. Untuk mengetahui detailnya, lihat Memecahkan error dan mengaktifkan kembali langganan Google Workspace.

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

Peristiwa pengingat habis masa berlaku

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 mengirim peristiwa siklus proses 12 jam dan satu jam sebelum waktu habis masa berlaku. 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.

Berikut ini menunjukkan CloudEvent untuk peristiwa siklus proses tentang langganan Google Workspace yang akan berakhir 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 habis

Google Workspace Events API 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 akan menghapus langganan yang sudah tidak berlaku secara permanen. Jika masa berlaku langganan berakhir, Anda dapat menggunakan 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 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",
      ...
    }
  }
}

Topik terkait

• Struktur peristiwa Google Workspace
• Menyelesaikan error dan mengaktifkan kembali langganan
• Memperbarui atau memperpanjang langganan