Method: users.sections.list

列出 Chat 使用者可用的區段。使用者可以透過區段將對話分組,並自訂 Chat 導覽面板中顯示的聊天室清單。詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用授權範圍進行使用者驗證

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

HTTP 要求

GET https://chat.googleapis.com/v1/{parent=users/*}/sections

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

路徑參數

參數
parent

string

必填。父項,也就是擁有這個章節集合的使用者資源名稱。僅支援列出通話使用者的區段。如要參照呼叫使用者,請設定下列其中一項:

  • me 別名。例如:users/me

  • 使用者的 Workspace 電子郵件地址。例如 users/user@example.com

  • 使用者 ID。例如 users/123456789

格式:users/{user}

查詢參數

參數
pageSize

integer

(選用步驟) 要傳回的章節數量上限。服務傳回的產品數量可能會少於這個值。

如未指定,最多將傳回 10 個章節。

值的上限為 100。如果使用超過 100 的值,系統會自動變更為 100。

負值會傳回 INVALID_ARGUMENT 錯誤。

pageToken

string

(選用步驟) 這是接收自先前清單區段呼叫的頁面權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致非預期的結果。

要求主體

要求主體必須為空白。

回應主體

房源區段的回覆訊息。

如果成功,回應主體會含有以下結構的資料:

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

object (Section)

指定使用者的章節。

nextPageToken

string

可做為 pageToken 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

授權範圍

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

詳情請參閱授權指南