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. Nama resource set kueri contoh induk, seperti projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Jika pemanggil tidak memiliki izin untuk mencantumkan SampleQuery dalam set kueri contoh ini, terlepas dari apakah set kueri contoh 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 dikonversi 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 ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk SampleQueryService.ListSampleQueries harus sesuai 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 akan 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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.sampleQueries.list

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.