Method: projects.databases.documents.patch

更新或插入文件。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
document.name

string

文件的資源名稱，例如 projects/{projectId}/databases/{databaseId}/documents/{document_path}。

查詢參數

參數
updateMask

object (DocumentMask)

要更新的欄位。遮罩中的所有欄位路徑均不得包含保留名稱。

如果文件存在於伺服器上，且遮罩中未參照的欄位，這些欄位就不會變更。遮罩中參照但未出現在輸入文件中的欄位，會從伺服器上刪除。
mask

object (DocumentMask)

要傳回的欄位。如未設定，則會傳回所有欄位。

如果文件的某個欄位不在這個遮罩中，則不會在回應中傳回該欄位。
currentDocument

object (Precondition)

文件的選用先決條件。如果已設定這個值，且不符合目標文件，要求就會失敗。

要求主體

要求主體包含 Document 的執行個體。

回應主體

如果成功，回應主體會包含 Document 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。