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

このページでは、 subscriptions.delete() メソッドを呼び出します。

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

前提条件

Apps Script

  • Apps Script プロジェクトには次のような特徴があります。
    • Apps Script。
    • 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

ユーザーが承認したサブスクリプションを削除する

次のコードサンプルでは、 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 を取得するには、次のいずれかを使用できます。 <ph type="x-smartling-placeholder">
        </ph>
      • 「 <ph type="x-smartling-placeholder"></ph> uid フィールド。
      • リソース ブロック ID で表されるリソース名の ID <ph type="x-smartling-placeholder"></ph> name フィールド。たとえば、リソース名が 1 つの subscriptions/subscription-123、subscription-123 を使用します。

  2. サブスクリプションを削除するには、deleteSubscription 関数を Apps Script プロジェクト。

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: 以下をサポートする OAuth スコープ サブスクリプションの 1 つのイベントタイプ。たとえば、サブスクリプションがイベントを受信し、 更新された Chat スペース https://www.googleapis.com/auth/chat.spaces.readonly。
    • SUBSCRIPTION_ID: サブスクリプションの ID。ID を取得するには、次のいずれかを使用できます。 <ph type="x-smartling-placeholder">
        </ph>
      • 「 <ph type="x-smartling-placeholder"></ph> uid フィールド。
      • リソース ブロック ID で表されるリソース名の ID <ph type="x-smartling-placeholder"></ph> name フィールド。たとえば、リソース名が 1 つの 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 リソースのインスタンスが含まれています。