Google Workspace サブスクリプションの詳細を確認する

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

ユーザー認証を使用してこのメソッドを呼び出すと、ユーザーが承認した定期購入の詳細が返されます。アプリ認証を使用すると、このメソッドは、アプリの定期購入に関する詳細を返すことができます。

前提条件

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 プロジェクトで、getSubscription という名前の新しいスクリプト ファイルを作成し、次のコードを追加します。

    function getSubscription() {
  // The name of the subscription to get.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const subscription = WorkspaceEvents.Subscriptions.get(name);
  console.log(subscription);
}

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

    • SUBSCRIPTION_ID: サブスクリプションの ID。ID を取得するには、次のいずれかを使用します。
      • uid フィールドの値。
      • name フィールドに表示されるリソース名の ID。たとえば、リソース名が subscriptions/subscription-123 の場合は、subscription-123 を使用します。

  2. サブスクリプションを取得するには、Apps Script プロジェクトで関数 getSubscription を実行します。

Python

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

    """Get 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'
subscription = service.subscriptions().get(name=NAME).execute()
print(subscription)

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

    • 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 get_subscription.py