Method: projects.databases.collectionGroups.fields.patch

Memperbarui konfigurasi bidang. Saat ini, pembaruan bidang hanya berlaku untuk konfigurasi indeks bidang tunggal. Namun, panggilan ke FirestoreAdmin.UpdateField harus menyediakan field mask untuk menghindari perubahan konfigurasi apa pun yang tidak diketahui oleh pemanggil. Masker bidang harus ditentukan sebagai: { paths: "indexConfig" } .

Panggilan ini mengembalikan google.longrunning.Operation yang dapat digunakan untuk melacak status pembaruan bidang. Metadata untuk operasi ini adalah tipe FieldOperationMetadata .

Untuk mengonfigurasi pengaturan bidang default untuk database, gunakan Field khusus dengan nama sumber daya: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* .

permintaan HTTP

PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

URL menggunakan sintaks Transcoding gRPC .

Parameter jalur

Parameter
field.name

string

Nama bidang formulir projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Jalur bidang dapat berupa nama bidang yang sederhana, misalnya address atau jalur ke bidang dalam mapValue , misalnya address.city , atau jalur bidang khusus. Satu-satunya bidang khusus yang valid adalah * , yang mewakili bidang apa pun.

Jalur bidang dapat dikutip menggunakan (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: * , . , ``` (backtick), [ , ]`, serta karakter simbolis ascii apa pun.

Contoh: (Catatan: Komentar di sini ditulis dalam sintaksis penurunan harga, jadi ada lapisan backtick tambahan untuk mewakili blok kode) \ address.city` represents a field named address.city , not the map key city in the field address . `*` represents a field named *`, bukan bidang apa pun.

Field khusus berisi pengaturan pengindeksan default untuk semua bidang. Nama sumber daya bidang ini adalah: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Indeks yang ditentukan pada Field ini akan diterapkan ke semua bidang yang tidak memiliki konfigurasi Field Bidangnya sendiri.

Parameter kueri

Parameter
updateMask

string ( FieldMask format)

Topeng, relatif terhadap lapangan. Jika ditentukan, hanya konfigurasi yang ditentukan oleh field_mask ini yang akan diperbarui di bidang tersebut.

Ini adalah daftar nama bidang yang memenuhi syarat yang dipisahkan koma. Contoh: "user.displayName,photo" .

Permintaan tubuh

Badan permintaan berisi turunan Field .

Badan respons

Jika berhasil, isi respons berisi turunan Operation .

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 .