Method: projects.databases.collectionGroups.fields.list

Mencantumkan konfigurasi bidang dan metadata untuk database ini.

Saat ini, FirestoreAdmin.ListFields hanya mendukung kolom listingan yang telah diganti secara eksplisit. Untuk mengeluarkan kueri ini, panggil FirestoreAdmin.ListFields dengan filter yang disetel ke indexConfig.usesAncestorConfig:false .

permintaan HTTP

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields

URL menggunakan sintaks Transcoding gRPC .

Parameter jalur

Parameter
parent

string

Nama induk dari formulir projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parameter kueri

Parameter
filter

string

Filter untuk diterapkan pada hasil daftar. Saat ini, FirestoreAdmin.ListFields hanya mendukung kolom listingan yang telah diganti secara eksplisit. Untuk mengeluarkan kueri ini, panggil FirestoreAdmin.ListFields dengan filter yang disetel ke indexConfig.usesAncestorConfig:false .

pageSize

integer

Jumlah hasil yang akan dikembalikan.

pageToken

string

Token halaman, dikembalikan dari panggilan sebelumnya ke FirestoreAdmin.ListFields , yang dapat digunakan untuk mendapatkan halaman hasil berikutnya.

Permintaan tubuh

Badan permintaan harus kosong.

Badan respons

Respons untuk FirestoreAdmin.ListFields .

Jika berhasil, isi respons berisi data dengan struktur berikut:

Representasi JSON
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Bidang
fields[]

object ( Field )

Bidang yang diminta.

nextPageToken

string

Token halaman yang dapat digunakan untuk meminta halaman hasil lainnya. Jika kosong, ini adalah halaman terakhir.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi lebih lanjut, lihat Ikhtisar Otentikasi .