Method: projects.locations.sampleQuerySets.sampleQueries.list

SampleQuery のリストを取得します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。親サンプル クエリセットのリソース名（projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet} など）。

呼び出し元にこのサンプル クエリセットの SampleQuery を一覧表示する権限がない場合、このサンプル クエリセットが存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

クエリ パラメータ

パラメータ
pageSize

integer

返す SampleQuery の最大数。指定しない場合、デフォルトは 100 です。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

このフィールドが負の数の場合、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 のドキュメントをご覧ください。