Nhận và phản hồi các sự kiện trong vòng đời của gói thuê bao Google Workspace

Trang này giải thích các sự kiện trong vòng đời mà bạn nhận được cho gói thuê bao Google Workspace và cách bạn có thể sử dụng các sự kiện đó để duy trì gói thuê bao đang hoạt động.

API Sự kiện của Google Workspace gửi các loại sự kiện trong vòng đời sau:

Ứng dụng của bạn phải xử lý rõ ràng các loại sự kiện trong vòng đời này và bỏ qua các loại sự kiện mới có thể xuất hiện trong tương lai.

Các sự kiện trong vòng đời của API Sự kiện Google Workspace được cấu trúc theo quy cách CloudEvents. Để tìm hiểu thêm, hãy xem phần Cấu trúc của sự kiện trên Google Workspace.

Sự kiện tạm ngưng

Khi xảy ra lỗi đối với gói thuê bao Google Workspace, API Sự kiện Google Workspace sẽ tạm ngưng gói thuê bao đó và ngăn gói thuê bao nhận sự kiện. Bạn phải khắc phục mọi lỗi liên quan đến gói thuê bao trước khi kích hoạt lại gói thuê bao đó.

Để thông báo cho bạn về việc tạm ngưng, API Sự kiện của Google Workspace sẽ gửi một sự kiện vòng đời có loại sự kiện là google.workspace.events.subscription.v1.suspended.

Sau khi nhận được sự kiện tạm ngưng, bạn có thể tìm hiểu lý do tạm ngưng, khắc phục mọi lỗi và kích hoạt lại gói thuê bao. Để biết thông tin chi tiết, hãy xem bài viết Giải quyết lỗi và kích hoạt lại gói thuê bao Google Workspace.

Phần sau đây cho thấy một CloudEvent cho một sự kiện trong vòng đời về một gói thuê bao Google Workspace đã bị tạm ngưng do lỗi 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",
      ...
    }
  }
}

Sự kiện lời nhắc về thời gian hết hạn

Sau khi gói thuê bao hết hạn, API Sự kiện của Google Workspace sẽ xoá vĩnh viễn gói thuê bao đó và bạn không thể gia hạn hoặc kích hoạt lại gói thuê bao.

Để thông báo cho bạn về gói thuê bao sắp hết hạn, API Sự kiện Google Workspace sẽ gửi các sự kiện trong vòng đời 12 giờ và 1 giờ trước thời điểm hết hạn. Loại sự kiện cho sự kiện trong vòng đời là google.workspace.events.subscription.v1.expirationReminder.

Khi nhận được sự kiện nhắc nhở về ngày hết hạn, bạn có thể sử dụng phương thức subscriptions.update() để cập nhật thời gian hết hạn. Để biết thông tin chi tiết, hãy xem bài viết Cập nhật hoặc gia hạn gói thuê bao Google Workspace.

Phần sau đây cho thấy một CloudEvent cho một sự kiện trong vòng đời về gói thuê bao Google Workspace sắp hết hạn:

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

Sự kiện gói thuê bao đã hết hạn

API Sự kiện của Google Workspace sẽ gửi cho bạn một sự kiện trong vòng đời khi gói thuê bao hết hạn. Loại sự kiện cho sự kiện trong vòng đời này là google.workspace.events.subscription.v1.expired.

API Sự kiện của Google Workspace sẽ xoá vĩnh viễn các gói thuê bao đã hết hạn. Nếu gói thuê bao của bạn hết hạn, bạn có thể sử dụng phương thức subscriptions.create() để tạo một gói thuê bao khác. Để biết thông tin chi tiết, hãy xem bài viết Tạo gói thuê bao Google Workspace.

Phần sau đây cho thấy một CloudEvent cho một sự kiện trong vòng đời về gói thuê bao Google Workspace đã hết hạn:

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