列出 Google Chat 聊天室中的事件。每個活動的payload都包含最新版本的 Chat 資源。舉例來說,假設您列出新聊天室成員的相關事件,伺服器會傳回 Membership
資源,其中包含最新成員詳細資料。如果在要求期間移除新成員,事件酬載會包含空白的 Membership
資源。
必須完成使用者驗證。如要列出事件,已驗證的使用者必須是聊天室成員。
如需範例,請參閱「列出 Google Chat 聊天室中的活動」。
HTTP 要求
GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
必要欄位。發生事件的 Google Chat 聊天室資源名稱。 格式: |
查詢參數
參數 | |
---|---|
pageSize |
選用設定。傳回的聊天室事件數量上限。服務傳回的產品數量可能會少於這個值。 負值會傳回 |
pageToken |
接收自先前的清單聊天室事件呼叫的網頁權杖。提供此項目即可擷取後續網頁。 進行分頁時,提供用於列出空間事件的所有其他參數,都必須與提供網頁權杖的呼叫相符。如果將不同的值傳遞給其他參數,可能會導致非預期的結果。 |
filter |
必要欄位。查詢篩選器。 您必須使用 你也可以視需要按照開始時間 (
如要指定開始或結束時間,請使用等值的 舉例來說,以下是有效的查詢:
下列查詢無效:
伺服器拒絕無效的查詢,並顯示 |
要求主體
要求主體必須為空白。
回應主體
列出聊天室事件的回應訊息。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"spaceEvents": [
{
object ( |
欄位 | |
---|---|
spaceEvents[] |
系統會依時間順序傳回結果 (由舊到新)。 |
nextPageToken |
用於擷取更多事件的接續權杖。如果省略這個欄位,就不會有後續頁面。 |
授權範圍
需要下列其中一種 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
詳情請參閱授權指南。