Google Workspace サブスクリプションを削除する

このページでは、subscriptions.delete() メソッドを使用して Google Workspace サブスクリプションを削除する方法について説明します。

サブスクリプションを削除すると、アプリはイベントを受信しなくなります。サブスクリプションが期限切れになると、Google Workspace Events API によって自動的に削除されます。

前提条件

Apps Script

  • Apps Script プロジェクト:
    • Apps Script によって自動的に作成されるデフォルトのプロジェクトではなく、Google Cloud プロジェクトを使用します。
    • OAuth 同意画面の構成に追加したスコープは、Apps Script プロジェクトの appsscript.json ファイルにも追加する必要があります。次に例を示します。
    • "oauthScopes": [
        "https://www.googleapis.com/auth/chat.messages.readonly"
      ]
          
    • Google Workspace Events アドバンスト サービスを有効にします。

Python

  • Python 3.6 以降
  • pip パッケージ管理ツール
  • Python 用の最新の Google クライアント ライブラリ。これらのパッケージをインストールまたは更新するには、コマンドライン インターフェースで次のコマンドを実行します。
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
      
  • Google Workspace サブスクリプション。作成するには、定期購入を作成するをご覧ください。

  • 認証が必要:

    • ユーザー認証には、サブスクリプションのイベントタイプの少なくとも 1 つをサポートするスコープが必要です。スコープを特定するには、イベントタイプ別のスコープをご覧ください。
    • アプリ認証には chat.bot スコープが必要です(Google Chat アプリのみ)。

ユーザーが承認した定期購入を削除する

次のコードサンプルは、ユーザー認証を使用して Subscription リソースを削除します。

定期購入を削除するには:

Apps Script

  1. Apps Script プロジェクトで、deleteSubscription という名前の新しいスクリプト ファイルを作成し、次のコードを追加します。

    function deleteSubscription() {
      // The name of the subscription to delete.
      const name = 'subscriptions/SUBSCRIPTION_ID';
    
      // Call the Workspace Events API using the advanced service.
      const response = WorkspaceEvents.Subscriptions.remove(name);
      console.log(response);
    }
    

    次のように置き換えます。

    • SUBSCRIPTION_ID: サブスクリプションの ID。ID を取得するには、次のいずれかを使用します。
      • uid フィールドの値。
      • name フィールドで表されるリソース名の ID。たとえば、リソース名が subscriptions/subscription-123 の場合は、subscription-123 を使用します。
  2. サブスクリプションを削除するには、Apps Script プロジェクトで deleteSubscription 関数を実行します。

Python

  1. 作業ディレクトリに delete_subscription.py という名前のファイルを作成し、次のコードを追加します。

    """Delete subscription."""
    
    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient.discovery import build
    
    # Specify required scopes.
    SCOPES = ['SCOPE']
    
    # Authenticate with Google Workspace and get user authentication.
    flow = InstalledAppFlow.from_client_secrets_file('client_secrets.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().delete(name=NAME).execute()
    print(response)
    

    次のように置き換えます。

    • SCOPE: サブスクリプションのイベントタイプを 1 つ以上サポートする OAuth スコープ。たとえば、サブスクリプションが更新された Chat スペースのイベントを受信した場合は、https://www.googleapis.com/auth/chat.spaces.readonly です。
    • SUBSCRIPTION_ID: サブスクリプションの ID。ID を取得するには、次のいずれかを使用します。
      • uid フィールドの値。
      • name フィールドで表されるリソース名の ID。たとえば、リソース名が subscriptions/subscription-123 の場合は、subscription-123 を使用します。
  2. 作業ディレクトリで、OAuth クライアント ID 認証情報を保存し、ファイル名を client_secrets.json にします。コードサンプルでは、この JSON ファイルを使用して Google Workspace で認証を行い、ユーザー認証情報を取得します。手順については、OAuth クライアント ID 認証情報を作成するをご覧ください。

  3. サブスクリプションを削除するには、ターミナルで次のコマンドを実行します。

    python3 delete_subscription.py
Google Workspace Events API は、Subscription リソースのインスタンスが含まれる長時間実行オペレーションを返します。