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