Method: projects.locations.collections.list

取得 Collection 清單。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/collections

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

路徑參數

參數
parent

string

這是必要旗標，父項資料儲存庫資源名稱，格式為 projects/{project}/locations/{location}。

查詢參數

參數
pageSize

integer

要傳回的 Collection 數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多將傳回 100 個 Collection。

許可的最大值為 1000；超出的數值將一律指定為 1000。
pageToken

string

屬於接收自前一個 CollectionService.ListCollections 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 CollectionService.ListCollections 的所有其他參數須與提供網頁權杖的呼叫相符。
filter

string

依相關聯的資料連接器資料來源篩選傳回的集合。例如：filter = 'dataSource:jira confluence'。如果篩選條件為空白，我們會傳回專案和位置下的所有集合。

要求主體

要求主體必須為空白。

回應主體

CollectionService.ListCollections 方法的回應訊息。

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

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

object (Collection)

Collection。
nextPageToken

string

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

授權範圍

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • discoveryengine.collections.list

詳情請參閱 IAM 說明文件。