列出 Google Chat 聊天室中的事件

本指南說明如何使用 Google Chat API 的 SpaceEvent 資源上的 list() 方法，列出聊天室中資源的變更。

SpaceEvent 資源代表目標聊天室的變更，包括聊天室的子項資源，例如訊息、回應和成員資格。如要進一步瞭解支援的事件類型和事件酬載清單，請參閱 SpaceEvent 資源參考文件中的 eventType 和 payload 欄位。

您最多可以列出要求時間前 28 天的事件。伺服器會傳回包含受影響資源的最新版本事件。舉例來說，如果您列出新聊天室成員的事件，伺服器會傳回包含最新會員詳細資料的 Membership 資源。如果在要求期間移除了新會員，事件酬載就會包含空白的 Membership 資源。

如要呼叫這個方法，您必須使用使用者驗證。如要列出聊天室中的事件，已驗證的使用者必須是該聊天室的成員。

必要條件

Node.js

列出聊天室事件

如要列出 Chat 聊天室中的聊天室事件，請在要求中傳遞以下內容：

  • 請指定一或多個授權範圍，以支援要求中的每個事件類型。最佳做法是選擇最嚴格的範圍，讓應用程式仍可正常運作。如要選擇範圍，請參閱驗證和授權總覽。

  • 呼叫 ListSpaceEvents() 方法，傳遞要列出的事件類型的 filter。您必須指定至少一種事件類型，也可以篩選日期。如需支援的事件類型清單，請參閱 SpaceEvent 資源參考文件的 eventType 欄位。

以下範例列出聊天室中新會員和訊息的事件：

Node.js

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

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly'
];

// This sample shows how to list space events 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 here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages
    filter: 'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"'
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

main().catch(console.error);

如要執行這個範例，請將 SPACE_NAME 替換為空間 name 中的 ID。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。

Chat API 會傳回新成員和訊息的聊天室事件分頁清單清單。