Google Workspace サブスクリプションを更新または更新する

Apps Script

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

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

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

  • Google Workspace Events 高度なサービスを有効にします。

• サブスクリプションで認証と各イベントタイプに適した認可スコープが必要です。

  • ユーザー認証の場合、サブスクリプションのイベントタイプを少なくとも 1 つサポートする 1 つ以上のスコープが必要です。スコープを特定するには、イベントタイプ別のスコープをご覧ください。
  • Chat アプリとして Chat イベントを登録するには、1 回限りの管理者承認によるアプリ認証が必要です。Chat アプリとして Chat イベントをサブスクライブすることは、デベロッパー プレビューで利用できます。

Python

• Python 3.6 以降
• pip パッケージ管理ツール
• Python 用の最新の Google クライアント ライブラリ。インストールまたは更新するには、コマンドライン インターフェースで次のコマンドを実行します。

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

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

• サブスクリプションで認証と各イベントタイプに適した認可スコープが必要です。

  • ユーザー認証の場合、サブスクリプションのイベントタイプを少なくとも 1 つサポートする 1 つ以上のスコープが必要です。スコープを特定するには、イベントタイプ別のスコープをご覧ください。
  • Chat アプリとして Chat イベントを登録するには、1 回限りの管理者承認によるアプリ認証が必要です。Chat アプリとして Chat イベントをサブスクライブすることは、デベロッパー プレビューで利用できます。

Apps Script

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

   function updateSubscription() {
     // The name of the subscription to update.
     const name = 'subscriptions/SUBSCRIPTION_ID';
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.patch({
       ttl: '0s',
     }, name);
     console.log(response);
   }
   

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

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

2. Google Workspace サブスクリプションを更新するには、Apps Script プロジェクトで関数 updateSubscription を実行します。

Python

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

   """Update 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,
   )
   
   BODY = {
       'ttl': {'seconds': 0},
   }
   NAME = 'subscriptions/SUBSCRIPTION_ID'
   response = (
       service.subscriptions()
       .patch(name=NAME, updateMask='ttl', body=BODY)
       .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 を取得するには、次のいずれかを使用します。
     • uid フィールドの値。
     • name フィールドに示されるリソース名の ID。たとえば、リソース名が subscriptions/subscription-123 の場合は、subscription-123 を使用します。

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

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

   python3 update_subscription.py

Python

  """Update subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = [SCOPES]

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # Call the Workspace Events API using the service endpoint.
  service = build(
      'workspaceevents',
      'v1beta',
      credentials=CREDENTIALS,
      discoveryServiceUrl='https://workspaceevents.googleapis.com/$discovery/rest?version=v1beta&labels=DEVELOPER_PREVIEW&key=API_KEY',
  )

  BODY = {
      'ttl': {'seconds': 0},
  }
  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = (
      service.subscriptions()
      .patch(name=NAME, updateMask='ttl', body=BODY)
      .execute()
  )
  print(response)