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

Belgenin kaynak adı. Örneğin, 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 bulunuyorsa ve maskede başvurulmayan alanlar içeriyorsa 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ümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.
currentDocument

object (Precondition)

Dokümandaki isteğe bağlı bir ön koşul. Bu değer ayarlanırsa ve hedef doküman tarafından karşılanmazsa istek başarısız olur.

İstek içeriği

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

Yanıt gövdesi

Başarılıysa yanıt metni, 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ış sayfasına göz atın.