このページでは、エラーを解決またはトラブルシューティングし、subscriptions.reactivate
メソッドを呼び出して、一時停止された Google Workspace サブスクリプションを再開する方法について説明します。
エラーが発生してサブスクリプションでイベントを受信できなくなると、Google Workspace サブスクリプションは一時停止されます。たとえば、ターゲット リソースまたは通知エンドポイントが見つからない場合、サブスクリプションは一時停止されます。サブスクリプションのエラーを解決したら、サブスクリプションを再開してイベントの受信を再開できます。
一時停止中の定期購入については、次の方法で確認できます。
- アプリが一時停止に関するライフサイクル イベントを受信します。エンドポイントのエラーによりサブスクリプションが一時停止された場合、ライフサイクル イベントを受信できないことがあります。
subscriptions.get
メソッドまたはsubscriptions.list
メソッドを使用して、サブスクリプションのstate
フィールドがSUSPENDED
に設定されているかどうかを確認します。- 配信の失敗が通知エンドポイントに通知されます。Google Cloud Pub/Sub トピックへの配信エラーのモニタリングについては、メッセージ エラーの処理をご覧ください。
再開した定期購入の有効期限は元のままです。サブスクリプションの有効期限を延長するには、Google Workspace サブスクリプションを更新するをご覧ください。
Apps Script
- Google Workspace サブスクリプション。作成するには、定期購入を作成するをご覧ください。
サブスクリプションのすべてのイベントタイプをサポートする 1 つ以上のスコープを使用したユーザー認証が必要です。
- Apps Script プロジェクト:
- Apps Script によって自動的に作成されるデフォルトのプロジェクトではなく、Google Cloud プロジェクトを使用します。
- OAuth 同意画面を構成するために追加したすべてのスコープについて、Apps Script プロジェクトの
appsscript.json
ファイルにもスコープを追加する必要があります。たとえば、chat.messages
スコープを指定した場合は、次のように追加します。 Google Workspace Events
高度なサービスを有効にします。
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages" ]
Python
- Python 3.6 以降
- pip パッケージ管理ツール
- Python 用の最新の Google クライアント ライブラリ。インストールまたは更新するには、コマンドライン インターフェースで次のコマンドを実行します。
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Google Workspace サブスクリプション。作成するには、定期購入を作成するをご覧ください。
サブスクリプションのすべてのイベントタイプをサポートする 1 つ以上のスコープを使用したユーザー認証が必要です。
エラーを特定して解決する
サブスクリプションのエラーを特定するには、サブスクリプションの suspensionReason
フィールドを確認します。このフィールドは、一時停止に関するライフサイクル イベントを受信したとき、または subscriptions.get
メソッドを使用して定期購入のすべてのフィールドを確認したときに確認できます。
次の表に、サブスクリプションで発生する可能性のあるエラーと、可能な場合はエラーの解決方法を示します。エラーを解決できない場合は、定期購入を削除するか、有効期限が切れるまでお待ちください。Google Workspace Events API は、期限切れのサブスクリプションを自動的に削除します。
エラー | 説明 | 解決方法 |
---|---|---|
|
承認ユーザーが、サブスクリプションに必要な 1 つ以上の OAuth スコープの付与を取り消した。 | 別のアクセス トークンを取得します。詳細については、 Google 認証サーバーからアクセス トークンを取得するをご覧ください。 |
|
定期購入のターゲット リソースが削除されます。 | リソースが復元された場合は、reactivate メソッドを呼び出します。それ以外の場合は、元のターゲット リソースなしでサブスクリプションを再有効化できないため、対応は不要です。 |
|
承認ユーザーが、サブスクリプションのリソースにアクセスできなくなりました。 | 対応は不要です。承認したユーザーがターゲット リソースにアクセスできないため、サブスクリプションを再度有効にすることはできません。 |
|
Google Workspace アプリケーションが、通知エンドポイントにイベントを配信する権限を持っていない。 | イベントを配信する Google Workspace アプリケーションのサービス アカウントにアクセス権を付与します。 サービス アカウント:
Pub/Sub トピックの場合は、Pub/Sub パブリッシャー( roles/pubsub.publisher)
)のロールをサービス アカウントに付与します。 |
|
通知エンドポイントが存在しないか、見つかりません。 | エンドポイントが有効で動作していることを確認します。Pub/Sub トピックのトラブルシューティングについては、トラブルシューティングのドキュメントをご覧ください。 |
|
割り当てが不足しているか、レート制限に達したため、通知エンドポイントがイベントを受信できませんでした。 | 割り当ての増加をリクエストしてください。 |
定期購入を再開する
定期購入が一時停止された原因となったエラーを解決したら、reactivate
メソッドを使用して、定期購入でイベントを再び受信できるようにします。このメソッドは、すべてのエラーが解決されたことを確認し、定期購入の state
フィールドを SUSPENDED
から ACTIVE
に変更します。
Google Workspace サブスクリプションを再び有効にするには:
Apps Script
Apps Script プロジェクトで、
reactivateSubscription
という名前の新しいスクリプト ファイルを作成し、次のコードを追加します。function reactivateSubscription() { // The name of the subscription to reactivate. const name = 'subscriptions/SUBSCRIPTION_ID'; // Call the Workspace Events API using the advanced service. const response = WorkspaceEvents.Subscriptions.reactivate({}, name); console.log(response); }
次のように置き換えます。
Google Workspace サブスクリプションを再開するには、Apps Script プロジェクトで
reactivateSubscription
関数を実行します。
Python
作業ディレクトリに
reactivate_subscription.py
という名前のファイルを作成し、次のコードを追加します。"""Reactivate subscription.""" from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Specify required scopes. SCOPES = [SCOPES] # Authenticate with Google Workspace and get user authentication. flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES) CREDENTIALS = flow.run_local_server() # Call the Workspace Events API using the service endpoint. service = build( 'workspaceevents', 'v1', credentials=CREDENTIALS, ) NAME = 'subscriptions/SUBSCRIPTION_ID' response = service.subscriptions().reactivate(name=NAME).execute() print(response)
次のように置き換えます。
SCOPES
: サブスクリプションの各イベントタイプをサポートする 1 つ以上の OAuth スコープ。文字列の配列としてフォーマットされます。複数のスコープを一覧表示するには、カンマで区切ります。例:'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
SUBSCRIPTION_ID
: サブスクリプションの ID。ID を取得するには、次のいずれかを使用します。
作業ディレクトリに OAuth クライアント ID の認証情報が保存され、ファイル名が
credentials.json
になっていることを確認します。このコードサンプルでは、この JSON ファイルを使用して Google Workspace で認証を行い、ユーザー認証情報を取得します。手順については、OAuth クライアント ID 認証情報を作成するをご覧ください。Google Workspace サブスクリプションを再有効化するには、ターミナルで次のコマンドを実行します。
python3 reactivate_subscription.py
Subscription
リソースのインスタンスを含む長時間実行オペレーションを返します。リクエストが失敗した場合は、次のセクションで追加のエラーのトラブルシューティングを行います。
複数のエラーのトラブルシューティング
定期購入を一時停止したエラーを解決し、reactivate
メソッドが失敗した場合は、定期購入が一時停止された後に別のエラーが発生した可能性があります。
追加のエラーを特定するには、失敗したリクエストの出力を確認します。出力には、まだ存在するエラーが含まれます。
定期購入に複数のエラーがある場合、suspensionReason
フィールドの値は常に、定期購入を一時停止した元のエラーを使用します。