列出 Google Chat 聊天室中的事件

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

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

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

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

必要條件

Python

列出聊天室活動

如要列出 Chat 聊天室中的聊天室事件，請按照下列步驟操作：

  • 在 SpaceEvent 資源上呼叫 list 方法。
  • 使用 filter 欄位指定要列出的事件類型。您必須指定至少一個事件類型，而且也能做為篩選依據 日期。如需支援的事件類型清單，請參閱 eventType 欄位。
  • 透過使用者驗證，指定一或多個授權範圍，以支援要求中的每個事件類型。最佳做法是選擇最嚴格的範圍，讓應用程式仍可正常運作。如要選擇範圍，請參閱 驗證及授權總覽。

在下列程式碼範例中，您會列出空間中新會員和訊息的事件。

Python

  1. 在工作目錄中，建立名為 chat_space_event_list.py 的檔案。

  2. 在 chat_space_event_list.py 中加入下列程式碼：

    """Lists SpaceEvent resources 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 = ["https://www.googleapis.com/auth/chat.memberships.readonly",
"https://www.googleapis.com/auth/chat.messages.readonly"]

# 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().list(

    # The space from which to list events.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE',

    # A required filter. Filters and returns events about new memberships and messages
    filter='event_types:"google.workspace.chat.membership.v1.created" OR event_types:"google.workspace.chat.message.v1.created"'

).execute()

# Prints details about the created space events.
print(result)

  3. 請在程式碼中替換下列內容：

    • SPACE：聊天室名稱，您可以從中取得 spaces.list 方法 或聊天室網址傳送

  4. 在工作目錄中建構並執行範例：

    python3 chat_space_event_list.py

Chat API 會傳回 SpaceEvent 項資源 有關新會員和訊息的通知

自訂分頁

您可以選擇傳遞下列查詢參數，自訂分頁：

  • pageSize：要傳回的 SpaceEvent 資源數量上限。 服務傳回的產品數量可能會少於這個值。負值會傳回 INVALID_ARGUMENT 錯誤。
  • pageToken：從先前的清單空間事件呼叫接收的網頁權杖。 提供此符記即可擷取後續網頁。進行分頁時， 篩選器值應與提供網頁符記的呼叫相符。傳遞不同的值可能會導致非預期的結果。