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

如需了解详情，请参阅身份验证概览。