Method: projects.locations.sampleQuerySets.sampleQueries.list

Mendapatkan daftar SampleQuery.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib diisi. Nama resource set kueri sampel induk, seperti projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Jika pemanggil tidak memiliki izin untuk mencantumkan SampleQuery di set kueri sampel ini, terlepas dari apakah set kueri sampel ini ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Parameter kueri

Parameter
pageSize

integer

Jumlah maksimum SampleQuery yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 100. Nilai maksimum yang diizinkan adalah 1.000. Nilai di atas 1.000 akan dipaksa menjadi 1.000.

Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.
pageToken

string

Token halaman ListSampleQueriesResponse.next_page_token, yang diterima dari panggilan SampleQueryService.ListSampleQueries sebelumnya. Berikan token ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang diberikan ke SampleQueryService.ListSampleQueries harus cocok dengan panggilan yang memberikan token halaman. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk metode SampleQueryService.ListSampleQueries.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ],
  "nextPageToken": string
}
Kolom
sampleQueries[]

object (SampleQuery)

SampleQuery.
nextPageToken

string

Token yang dapat dikirim sebagai ListSampleQueriesRequest.page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.sampleQueries.list

Untuk mengetahui informasi selengkapnya, baca dokumentasi IAM.