Method: projects.databases.documents.patch

Doküman günceller veya ekler.

HTTP isteği

PATCH https://firestore.googleapis.com/v1/{document.name=projects/*/databases/*/documents/*/**}

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
document.name

string

Dokümanın kaynak adı (ör. projects/{projectId}/databases/{databaseId}/documents/{document_path}).

Sorgu parametreleri

Parametreler
updateMask

object (DocumentMask)

Güncellenecek alanlar. Maskedeki alan yollarının hiçbiri ayrılmış bir ad içeremez.

Doküman sunucuda mevcutsa ve maskede referans verilmeyen alanlar varsa bunlar değiştirilmeden bırakılır. Maskede başvurulan ancak giriş dokümanında bulunmayan alanlar sunucudaki dokümandan silinir.
mask

object (DocumentMask)

Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Dokümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.
currentDocument

object (Precondition)

Dokümandaki isteğe bağlı bir ön koşul. Bu ayar yapılırsa ve hedef belge tarafından karşılanmazsa istek başarısız olur.

İstek içeriği

İstek gövdesi, Document öğesinin bir örneğini içerir.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, Document öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.