Google Workspace サブスクリプションを作成する

Apps Script

• このガイドの Google Cloud CLI コマンドを使用するには: <ph type="x-smartling-placeholder">
  </ph>
  1. Google Cloud CLI をインストールします。
  2. 宛先<ph type="x-smartling-placeholder"></ph> gcloud CLI を初期化してから、次のコードを実行します。

    gcloud init
    

• Google Cloud プロジェクト 課金が有効になっている必要がありますChat のサブスクリプションでは、 Cloud プロジェクトで Chat API を有効にし、 [アプリ名]、[アバターの URL]、[説明] を構成します 表示されます。詳しくは、 Google Chat アプリを作成します。
• OAuth 同意画面で構成されたユーザー認証が必要です クリックします。同意画面を設定するときに、スコープを指定する必要があります。 サポートしていることがわかります。同意ステータスを設定するには 必要なスコープを特定するには、このモジュールの スコープを選択する。

• 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
    

• このガイドの Google Cloud CLI コマンドを使用するには: <ph type="x-smartling-placeholder">
  </ph>
  1. Google Cloud CLI をインストールします。
  2. 宛先<ph type="x-smartling-placeholder"></ph> gcloud CLI を初期化してから、次のコードを実行します。

    gcloud init
    

• Google Cloud プロジェクト 課金が有効になっている必要がありますChat のサブスクリプションでは、 Cloud プロジェクトで Chat API を有効にし、 [アプリ名]、[アバターの URL]、[説明] を構成します 表示されます。詳しくは、 Google Chat アプリを作成します。
• OAuth 同意画面で構成されたユーザー認証が必要です クリックします。同意画面を設定するときに、スコープを指定する必要があります。 サポートしていることがわかります。同意ステータスを設定するには 必要なスコープを特定するには、このモジュールの スコープを選択する。

Google Cloud コンソール

Google Cloud コンソールで、アプリの Google Cloud プロジェクトを開き、 Google Workspace Events API と Pub/Sub API:

API を有効にする

gcloud

1. 作業ディレクトリで、Google アカウントにログインします。

   gcloud auth login
   

2. プロジェクトをアプリの Cloud プロジェクトに設定します。

   gcloud config set project PROJECT_ID
   

   PROJECT_ID を次の内容に置き換えます。 アプリの Cloud プロジェクトのプロジェクト ID。

3. Google Workspace Events API と Google Cloud Pub/Sub を有効にする API:

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
   

Google Cloud コンソール

1. Google Cloud コンソールで、[Pub/Sub] ページに移動します。

   Google Cloud Pub/Sub に移動

   アプリの Cloud プロジェクトが選択されていることを確認します。

2. [add_box トピックを作成] をクリックします。 次の操作を行います。

   1. トピックの名前を入力します（例: workspace-events-topic）。
   2. [デフォルトのサブスクリプションを追加する] は選択されたままにしておきます。Pub/Sub は トピックの名前に似たデフォルトのサブスクリプションです。 workspace-events-topic-sub。
   3. 省略可: 追加のプロパティを更新または設定する 選択します。

3. [作成] をクリックします。完全なトピック名は次の形式です: projects/PROJECT_ID/topics/TOPIC_ID。 このフルネームは後のステップで使用します。

4. トピックに Pub/Sub メッセージをパブリッシュするためのアクセス権を付与します。

   1. トピックのページのサイドパネルで [権限] タブ。
   2. [プリンシパルを追加] をクリックします。
   3. [プリンシパルの追加] フィールドに、プロジェクトのサービス アカウントを追加します。 Google Workspace アプリケーションで 定期購入: <ph type="x-smartling-placeholder">
      </ph>
      1. Chat イベントの場合: chat-api-push@system.gserviceaccount.com。
      2. Meet のイベントでは、 meet-api-event-push@system.gserviceaccount.com。
   4. [ロールの割り当て] メニューで、[Pub/Sub Publisher] を選択します。
   5. [保存] をクリックします。権限の更新には数分かかることがあります 選択します。

gcloud

1. Cloud プロジェクトで、次のコマンドを実行してトピックを作成します。 command:

   gcloud pubsub topics create TOPIC_ID
   

   TOPIC_ID は、トピックの一意の ID（ workspace-events-topic として。

   出力には、完全なトピック名が projects/PROJECT_ID/topics/TOPIC_ID。 名前をメモし、 PROJECT_ID は、Cloud プロジェクト ID です。 提供しますトピック名は次の手順で使用します。 サブスクリプションを後で行うこともできます。

2. トピックにメッセージをパブリッシュするためのアクセス権を付与します。

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
   

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

   • TOPIC_NAME: 完全なトピック名。 出力します。形式 projects/PROJECT_ID/topics/TOPIC_ID。

   • GOOGLE_WORKSPACE_APPLICATION: イベントの配信先を指定する必要がある Google Workspace アプリケーション サブスクリプション:

     • Chat からイベントを受信するには、 chat-api-push@system.gserviceaccount.com。
     • Meet からの予定を受信するには、 meet-api-event-push@system.gserviceaccount.com。

   トピックの権限が更新されるまで数分かかることがあります。

3. トピックに Pub/Sub サブスクリプションを作成します。

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

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

   • SUBSCRIPTION_NAME: サブスクリプションの名前。 workspace-events-subscription など。
   • TOPIC_NAME: 作成したトピックの名前 確認します。

Apps Script

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

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

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

   • TARGET_RESOURCE: Google Workspace リソース 完全なリソース名の形式で指定します。対象 スペース ID を使用して Google Chat スペースを AAAABBBB、//chat.googleapis.com/spaces/AAAABBBB を使用します。
   • EVENT_TYPES: 1 つ以上のイベントタイプ リソースにサブスクライブするものを指定します。表示形式 文字列の配列（'google.workspace.chat.message.v1.created' など）。
   • TOPIC_NAME: 受信する Pub/Sub トピックの完全な名前 Cloud プロジェクトで作成したものが含まれます。形式 projects/PROJECT_ID/topics/TOPIC_ID。

   • RESOURCE_DATA: 読み取り状態を待機するかどうかを サブスクリプションには、ペイロードにリソースデータが含まれます。

     • True: すべてのリソースデータが含まれます。表示するフィールドを制限するには、 fieldMask を追加 変更されたリソースについて少なくとも 1 つのフィールドを指定します。単独 Chat リソース サポート サブスクリプションの 使用します。
     • False: リソースデータは除外されます。

2. Google Workspace サブスクリプションを作成するには、次の関数を実行します。 Apps Script プロジェクトの createSubscription。

Python

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

   """Create 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('client_secrets.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

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

   • SCOPES: 各イベントタイプをサポートする 1 つ以上の OAuth スコープ 割り当てられています文字列の配列としてフォーマットされます。複数のスコープを一覧表示するには、カンマで区切ります。 例: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
   • TARGET_RESOURCE: Google Workspace リソース 完全なリソース名の形式で指定します。対象 スペース ID を使用して Google Chat スペースを AAAABBBB、//chat.googleapis.com/spaces/AAAABBBB を使用します。
   • EVENT_TYPES: 1 つ以上のイベントタイプ リソースにサブスクライブするものを指定します。表示形式 文字列の配列（'google.workspace.chat.message.v1.created' など）。
   • TOPIC_NAME: 受信する Pub/Sub トピックの完全な名前 Cloud プロジェクトで作成したものが含まれます。形式 projects/PROJECT_ID/topics/TOPIC_ID。

   • RESOURCE_DATA: 読み取り状態を待機するかどうかを サブスクリプションには、ペイロードにリソースデータが含まれます。

     • True: すべてのリソースデータが含まれます。表示するフィールドを制限するには、 fieldMask を追加 変更されたリソースについて少なくとも 1 つのフィールドを指定します。単独 Chat リソース サポート サブスクリプションの 使用します。
     • False: リソースデータは除外されます。

2. Google Workspace サブスクリプションを作成するには、 ターミナルに次のコマンドを入力します。

   python3 create_subscription.py
   

Google Cloud コンソール

1. プロジェクトのターゲット リソースで 1 つ以上のタイプのイベントを Google Workspace サブスクリプション。たとえば、 スペースにメッセージを投稿できます。

2. Google Cloud コンソールで、[Pub/Sub] ページに移動します。

   [Pub/Sub] に移動

   アプリの Cloud プロジェクトが選択されていることを確認します。

3. [Pub/Sub] メニューで、[サブスクリプション] をクリックします。

4. テーブルで、トピックの Pub/Sub サブスクリプションを見つけて、 サブスクリプション名。

5. [メッセージ] タブをクリックします。

6. [Pull] をクリックします。イベントが生成されるまで数分かかることがあります。 Pub/Sub メッセージです。

gcloud

1. プロジェクトのターゲット リソースで 1 つ以上のタイプのイベントを Google Workspace サブスクリプション。たとえば、 スペースにメッセージを投稿できます。

2. 次のコマンドを実行します。

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
   

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

   • PUBSUB_SUBSCRIPTION_NAME: 名前のフルネーム Pub/Sub サブスクリプションの形式 projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID。
   • MESSAGE_COUNT: pull する Pub/Sub メッセージの最大数。

   イベントで Pub/Sub が生成されるまでに数分かかることがあります。 表示されます。