接收及回應 Google Workspace 訂閱方案的生命週期事件

本頁面說明您針對 Google Workspace 訂閱收到的生命週期事件，以及如何使用事件維持有效的訂閱項目。

Google Workspace Event API 會傳送下列類型的生命週期事件：

應用程式應明確處理這些生命週期事件類型，並忽略未來可能出現的新事件類型。

Google Workspace 事件 API 的生命週期事件會根據 CloudEvents 規格建構結構。詳情請參閱「Google Workspace 事件的結構」。

停權事件

當 Google Workspace 訂閱發生錯誤時，Google WorkspaceEvents API 會暫停訂閱，防止該訂閱接收事件。您必須先解決該訂閱項目的所有錯誤，才能重新啟用該訂閱項目。

為了通知您停權通知，Google Workspace Event 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 Event API 會永久刪除該訂閱，而且無法續訂或重新啟用。

為了通知您訂閱即將到期，Google Workspace Event API 會在到期時間的前 12 小時和一小時前傳送生命週期事件。生命週期事件的事件類型為 google.workspace.events.subscription.v1.expirationReminder。

收到到期提醒事件時，您可以使用 subscriptions.update() 方法更新到期時間。詳情請參閱「更新或續訂 Google Workspace 訂閱方案」。

以下是關於 Google Workspace 訂閱即將到期的生命週期事件的 CloudEvent：

{
  "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 Event API 會傳送生命週期事件給您。這個生命週期事件的事件類型為 google.workspace.events.subscription.v1.expired。

Google Workspace Event 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",
      ...
    }
  }
}