Method: spaces.spaceEvents.list

列出 Google Chat 聊天室中的事件。每個事件的payload都包含最新版本的 Chat 資源。舉例來說，如果您列出新聊天室成員的事件，伺服器會傳回 Membership 資源，當中包含最新成員詳細資料。如果新成員在要求期間遭到移除，事件酬載會包含空白的 Membership 資源。

需要使用者驗證。如要列出事件，已驗證的使用者必須是聊天室成員。

如需範例，請參閱「列出 Google Chat 聊天室中的事件」。

HTTP 要求

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。發生事件的 Google Chat 聊天室資源名稱。

格式：spaces/{space}。

查詢參數

參數
pageSize

integer

選用設定。傳回的聊天室事件數量上限。服務傳回的產品數量可能會少於這個值。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

頁面符記，接收自前一個清單空間事件呼叫。提供此項目即可擷取後續網頁。

進行分頁時，提供用於列出空間事件的所有其他參數，都必須與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數，可能會導致非預期的結果。
filter

string

必要欄位。查詢篩選器。

您必須使用 : 運算子指定至少一個事件類型 (eventType)。如要依據多個事件類型進行篩選，請使用 OR 運算子。請在篩選器中省略批次事件類型。該要求會自動傳回任何相關的批次事件。舉例來說，如果你依新的回應 (google.workspace.chat.reaction.v1.created) 進行篩選，伺服器也會傳回批次新的回應事件 (google.workspace.chat.reaction.v1.batchCreated)。如需支援的事件類型清單，請參閱 SpaceEvents 參考說明文件。

您也可以選擇依開始時間 (startTime) 和結束時間 (endTime) 進行篩選：

  • startTime：用於開始列出聊天室事件的專屬時間戳記。您可以列出 28 天前發生的事件。如果未指定，則會列出過去 28 天的聊天室事件。
  • endTime：包含完整時間戳記，直到列出該聊天室事件為止。如果未指定，則會列出要求時間之前的事件。

如要指定開始或結束時間，請在 RFC-3339 中使用等於 = 運算子和格式。如要同時依 startTime 和 endTime 進行篩選，請使用 AND 運算子。

舉例來說，以下查詢是有效的查詢：

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

以下查詢無效：

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

無效查詢遭到伺服器拒絕，並顯示 INVALID_ARGUMENT 錯誤。

要求主體

要求主體必須為空白。

回應主體

列出聊天室事件的回應訊息。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
欄位
spaceEvents[]

object (SpaceEvent)

系統會按照時間順序傳回結果 (由舊到新)。
nextPageToken

string

用於擷取更多事件的接續權杖。如果省略這個欄位，就不會有後續頁面。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

詳情請參閱授權指南。