Method: projects.databases.documents.commit

提交事务，同时选择性地更新文档。

HTTP 请求

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:commit

网址采用 gRPC 转码语法。

路径参数

参数
database

string

必需。数据库名称。格式为：projects/{projectId}/databases/{databaseId}。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
字段
writes[]

object (Write)

要应用的写入。

始终以原子方式按顺序执行。
transaction

string (bytes format)

如果设置，则应用此事务中的所有写入，并提交。

使用 base64 编码的字符串。

响应正文

Firestore.Commit 的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
字段
writeResults[]

object (WriteResult)

应用写入的结果。

第 i 个写入结果对应于请求中的第 i 个写入。
commitTime

string (Timestamp format)

提交发生的时间。任何具有等于或大于 readTime 的读取操作一定会看到提交的效果。

采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式的时间戳，采用纳秒级精度，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

授权范围

需要以下 OAuth 范围之一：

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

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