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

このガイドでは、Google Chat API の SpaceEvent リソースで get() メソッドを使用して、Google Chat スペースのイベントの詳細を取得する方法について説明します。

SpaceEvent リソースは、スペースまたはその子リソース（メッセージ、リアクション、メンバーシップなど）に対する変更を表します。サポートされているイベント タイプについては、SpaceEvent リソースの eventType フィールドの参照ドキュメントをご覧ください。

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

このメソッドを呼び出すには、ユーザー認証を使用する必要があります。イベントを取得するには、認証されたユーザーがイベントが発生したスペースのメンバーである必要があります。

前提条件

Node.js

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

Google Chat のスペース イベントの詳細を取得するには、リクエストで次の情報を渡します。

  • リクエストのイベントタイプをサポートする認可スコープを指定します。アプリが機能する範囲で最も制限の大きいスコープを選択することをおすすめします。
  • GetSpaceEvent() メソッドを呼び出し、取得するスペース イベントの name を渡します。

次の例では、スペース イベントを取得します。

Node.js

chat/client-libraries/cloud/get-space-event-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
      USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
  };

  // Make the request
  const response = await chatClient.getSpaceEvent(request);

  // Handle the response
  console.log(response);
}

await main();

このサンプルを実行するには、次の値を置き換えます。

  • SCOPE_NAME: イベントタイプに基づく認可スコープ。たとえば、新しいメンバーシップに関するスペース イベントを取得する場合は、chat.memberships.readonly スコープを https://www.googleapis.com/auth/chat.memberships.readonly 形式で使用します。イベントタイプは、ListSpaceEvents() メソッドから取得できます。このメソッドの使用方法については、スペースからイベントを一覧表示するをご覧ください。
  • SPACE_NAME: スペースの name からの ID。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。
  • SPACE_EVENT_NAME: スペース イベントの name からの ID。ID は ListSpaceEvents() メソッドから取得できます。このメソッドの使用方法については、スペースからイベントを一覧表示するをご覧ください。

Chat API は、イベントの詳細を含む SpaceEvent のインスタンスを返します。