Method: projects.locations.sampleQuerySets.sampleQueries.list

取得 SampleQuery 清單。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries

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

路徑參數

參數
parent

string

這是必要旗標，父項範例查詢集資源名稱，例如 projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}。

如果呼叫者沒有權限列出這個範例查詢集下的 SampleQuery，無論這個範例查詢集是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

查詢參數

參數
pageSize

integer

要傳回的 SampleQuery 數量上限。如未指定，則預設為 100。允許的最大值為 1000。超出的數值將一律指定為 1000。

如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

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

進行分頁時，提供至 SampleQueryService.ListSampleQueries 的所有其他參數須與提供網頁權杖的呼叫相符。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

要求主體

要求主體必須為空白。

回應主體

SampleQueryService.ListSampleQueries 方法的回應訊息。

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

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

object (SampleQuery)

SampleQuery。
nextPageToken

string

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • discoveryengine.sampleQueries.list

詳情請參閱 IAM 說明文件。