Google Workspace サブスクリプションを一覧表示する

Apps Script

• Google Workspace サブスクリプション。作成するには、定期購入を作成するをご覧ください。

• サブスクリプションのすべてのイベントタイプをサポートする 1 つ以上のスコープを使用したユーザー認証が必要です。

• Apps Script プロジェクト:
  • Apps Script によって自動的に作成されるデフォルトのプロジェクトではなく、Google Cloud プロジェクトを使用します。
  • OAuth 同意画面を構成するために追加したすべてのスコープについて、Apps Script プロジェクトの appsscript.json ファイルにもスコープを追加する必要があります。たとえば、chat.messages スコープを指定した場合は、次のように追加します。

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages"
  ]
      

  • 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 アプリのみ）。

Apps Script

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

   function listSubscriptions() {
     // Filter for event type (required).
     const eventType = 'EVENT_TYPE';
   
     // Filter for target resource (optional).
     const targetResource = 'TARGET_RESOURCE';
   
     const filter = `event_types:"${eventType}" AND target_resource="${targetResource}"`
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.list({ filter });
     console.log(response);
   }
   

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

   • EVENT_TYPE: CloudEvents 仕様に従ってフォーマットされたイベントタイプ。たとえば、Google Chat スペースへの新しいメンバーシップに関するイベントを受信するサブスクリプションをフィルタするには、google.workspace.chat.message.v1.created を使用します。
   • TARGET_RESOURCE: ターゲット リソース。完全なリソース名としてフォーマットされます。たとえば、Google Chat スペースのサブスクリプションでフィルタするには、//chat.googleapis.com/spaces/SPACE_ID を使用します。ここで、spaces/SPACE_ID は Space リソースの name フィールドを表します。

2. サブスクリプションを一覧表示するには、Apps Script プロジェクトで関数 listSubscriptions を実行します。

Python

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

   """List subscriptions."""
   
   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('credentials.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   # Filter for event type (required).
   EVENT_TYPE = 'EVENT_TYPE'
   
   # Filter for target resource (optional).
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   FILTER = f'event_types:"{EVENT_TYPE}" AND target_resource="{TARGET_RESOURCE}"'
   response = service.subscriptions().list(filter=FILTER).execute()
   print(response)
   

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

   • SCOPE: サブスクリプションの少なくとも 1 つのイベントタイプをサポートする OAuth スコープ。たとえば、サブスクリプションが更新された Chat スペースのイベントを受信する場合、https://www.googleapis.com/auth/chat.spaces.readonly。
   • EVENT_TYPE: CloudEvents 仕様に従ってフォーマットされたイベントタイプ。たとえば、Google Chat スペースへの新しいメンバーシップに関するイベントを受信するサブスクリプションをフィルタするには、google.workspace.chat.message.v1.created を使用します。
   • TARGET_RESOURCE: ターゲット リソース。完全なリソース名としてフォーマットされます。たとえば、Google Chat スペースのサブスクリプションでフィルタするには、//chat.googleapis.com/spaces/SPACE_ID を使用します。ここで、spaces/SPACE_ID は Space リソースの name フィールドを表します。

2. 作業ディレクトリに OAuth クライアント ID の認証情報が保存され、ファイル名が credentials.json になっていることを確認します。このコードサンプルでは、この JSON ファイルを使用して Google Workspace で認証を行い、ユーザー認証情報を取得します。手順については、OAuth クライアント ID 認証情報を作成するをご覧ください。

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

   python3 list_subscriptions.py