接收和响应 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 订阅。

以下示例展示了因错误 ENDPOINT_PERMISSION_DENIED 而被暂停的 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.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 Events 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",
      ...
    }
  }
}