Method: projects.databases.documents.patch

更新或插入文档。

HTTP请求

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

URL 使用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

有关详细信息,请参阅身份验证概述