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