更新或插入文件。
HTTP 要求
PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
document.name |
文件的資源名稱,例如 |
查詢參數
參數 | |
---|---|
updateMask |
要更新的欄位。遮罩中沒有任何欄位路徑可能包含保留名稱。 如果文件存在於伺服器上,且遮罩中有未參照的欄位,則文件會維持不變。遮罩中參照的欄位,但輸入文件中沒有該欄位,系統會從伺服器上的文件刪除這些欄位。 |
mask |
要傳回的欄位。如果沒有設定,系統會傳回所有欄位。 如果文件的某個欄位未列於這個遮罩中,系統不會在回應中傳回該欄位。 |
currentDocument |
文件上的選用先決條件。如果已設定此設定,但未為目標文件達成,要求就會失敗。 |
要求主體
要求主體包含 Document
的例項。
回應主體
如果成功,回應主體會包含 Document
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽。