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