接收和响应 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",
      ...
    }
  }
}