Method: projects.locations.collections.list

Mendapatkan daftar Collection.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource penyimpanan data induk, dalam format projects/{project}/locations/{location}.

Parameter kueri

Parameter
pageSize

integer

Jumlah maksimum Collection yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, paling banyak 100 Collection akan ditampilkan.

Nilai maksimum adalah 1.000; nilai di atas 1.000 akan dikonversi menjadi 1.000.
pageToken

string

Token halaman, yang diterima dari panggilan CollectionService.ListCollections sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk CollectionService.ListCollections harus sesuai dengan panggilan yang memberikan token halaman.
filter

string

Memfilter koleksi yang ditampilkan menurut sumber data konektor data terkait. Misalnya: filter = 'dataSource:jira confluence'. Jika filter kosong, kami akan menampilkan semua koleksi dalam project dan lokasi.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk metode CollectionService.ListCollections.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Kolom
collections[]

object (Collection)

Collection.
nextPageToken

string

Token yang dapat dikirim sebagai ListCollectionsRequest.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.collections.list

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.