Memperbarui atau menyisipkan dokumen.
Permintaan HTTP
PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
document.name |
Nama resource dokumen, misalnya |
Parameter kueri
Parameter | |
---|---|
updateMask |
Kolom yang akan diperbarui. Tidak ada jalur kolom dalam mask yang boleh berisi nama yang dicadangkan. Jika dokumen ada di server dan memiliki kolom yang tidak dirujuk di mask, kolom tersebut tidak akan berubah. Kolom yang dirujuk dalam mask, tetapi tidak ada di dokumen input, akan dihapus dari dokumen di server. |
mask |
Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan. Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons. |
currentDocument |
Prasyarat opsional pada dokumen. Permintaan akan gagal jika hal ini ditetapkan dan tidak dipenuhi oleh dokumen target. |
Isi permintaan
Isi permintaan memuat instance Document
.
Isi respons
Jika berhasil, isi respons akan berisi instance Document
.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.