接收及回應 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，其生命週期事件是因錯誤 ENDPOINT_PERMISSION_DENIED 而遭到停用的 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.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 事件 API 會永久刪除該訂閱方案，您無法續訂或重新啟用。

為了通知您訂閱項目即將到期，Google Workspace Events API 會在到期時間前 12 小時和 1 小時傳送生命週期事件。生命週期事件的事件類型為 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 Events API 會傳送生命週期事件。這個生命週期事件的事件類型為 google.workspace.events.subscription.v1.expired。

Google Workspace Events API 會永久刪除過期訂閱項目。如果訂閱項目到期，您可以使用 subscriptions.create() 方法建立其他訂閱項目。詳情請參閱「建立 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.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",
      ...
    }
  }
}