Method: projects.locations.collections.list

列出指定專案和位置中的集合。

HTTP 要求

GET https://vectorsearch.googleapis.com/v1/{parent}/collections

路徑參數

參數
parent

string

這是必要旗標,ListCollectionsRequest 的父項值

查詢參數

參數
pageSize

integer

選用。要求的頁面大小。伺服器傳回的項目數量可能會少於要求數量。如未指定,伺服器會挑選適當的預設值。

pageToken

string

選用。這個符記可識別伺服器應傳回的結果頁面。

filter

string

選用。篩選結果

orderBy

string

選用。如何排序結果的提示

要求主體

要求主體必須為空白。

回應主體

回覆商家檔案集合的訊息

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

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

object (Collection)

收藏清單

nextPageToken

string

這個符記可識別伺服器應傳回的結果頁面。

unreachable[]

string

未排序的清單。無法連線的位置。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱Authentication Overview

IAM 權限

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

  • vectorsearch.collections.list

詳情請參閱 IAM 說明文件