Method: projects.databases.collectionGroups.fields.list

Mencantumkan konfigurasi kolom 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 atau ttlConfig:*.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib diisi. Nama induk formulir projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parameter kueri

Parameter
filter

string

Filter yang akan diterapkan ke 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 menyertakan indexConfig.usesAncestorConfig:false atau ttlConfig:*.
pageSize

integer

Jumlah hasil yang akan ditampilkan.
pageToken

string

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons untuk FirestoreAdmin.ListFields.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (Field)

Kolom yang diminta.
nextPageToken

string

Token halaman yang dapat digunakan untuk meminta halaman hasil lain. 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 mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.