Google Chat スペースのイベントの詳細を取得する

このガイドでは、 get メソッドがオン SpaceEvent リソースの Google Chat スペースのイベントの詳細を取得するための Google Chat API。

SpaceEvent リソースは、スペースまたはその子に対する変更を表します。 メッセージ、リアクション、メンバーシップなどのリソースです。学習内容 サポートされているイベントタイプについては、eventType SpaceEvent リソース ご覧ください。

イベントのリクエストは、リクエストの 28 日前まで可能です。イベント には、変更されたリソースの最新バージョンが含まれます。たとえば 新しいメッセージに関するイベントをリクエストしたが、その後メッセージが更新された場合、 サーバーが、更新された Message リソースをイベント ペイロードで返します。

このメソッドを呼び出すには、userId 認証をご覧ください。特典を 認証済みユーザーは、その予定があるスペースのメンバーである 発生しました。

前提条件

Python

  • Python 3.6 以降
  • pip パッケージ管理ツール
  • 最新の Google クライアント ライブラリ。インストールまたは更新する手順は次のとおりです。 コマンドライン インターフェースで次のコマンドを実行します。 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

スペースのイベントの詳細を確認する

Google Chat で SpaceEvent の詳細を取得する方法は次のとおりです。

  • get メソッドを呼び出す SpaceEvent resource。
  • 取得するには、SpaceEvent の name を渡します。SpaceEvent 名を取得します。 SpaceEventより 次のリソース できます。
  • 相手: ユーザー 認証は、 リクエストのイベントタイプをサポートする認可スコープ。デバイス名: ベスト プラクティスとして、アプリを許可または制限する最も制限の厳しいスコープを 必要があります。

SpaceEvent を取得する方法は次のとおりです。 ユーザー認証:

Python

  1. 作業ディレクトリに、chat_space_event_get.py という名前のファイルを作成します。

  2. chat_space_event_get.py に次のコードを含めます。

    """Gets a SpaceEvent resource from the Chat API."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ['SCOPE']

# Authenticate with Google Workspace
# and get user authorization.
flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
creds = flow.run_local_server()

# Build a service endpoint for Chat API.
chat = build(
  'chat',
  'v1',
  credentials=creds
)

# Use the service endpoint to call Chat API.
result = (
    chat.spaces()
    .spaceEvents()
    .get(
        # The space event to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace SPACE_EVENT with a SpaceEvent name.
        # Obtain the spaceEvent name from the SpaceEvent resource of
        # Chat API.
        name='spaces/SPACE/spaceEvents/SPACE_EVENT'
    )
    .execute()
)

# Prints details about the created spaceEvent.
print(result)

  3. コードの次のように置き換えます。

    • SCOPE: リクエストに基づく認可スコープ イベントタイプを指定します。たとえば、スペースのイベントを受信し、 chat.memberships.readonly スコープを使用する https://www.googleapis.com/auth/chat.memberships.readonly の形式にします。 イベントタイプは spaces.spaceEvents.list メソッド。 この方法の使用方法については、以下をご覧ください。 スペースからの予定を一覧表示する
    • SPACE: スペース名。ここから取得できます。 spaces.list メソッド スペースの URL から取得できます。
    • SPACE_EVENT: スペースの名前 イベントです。これは、 spaces.spaceEvents.list メソッド。

  4. 作業ディレクトリでサンプルをビルドして実行します。

    python3 chat_space_event_get.py

Chat API は、メッセージに対して SpaceEvent イベントの詳細が表示されます。