Method: projects.databases.documents.beginTransaction

启动新事务。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
database

string

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

请求正文

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

JSON 表示法 
{
  "options": {
    object (TransactionOptions)
  }
}
字段
options

object (TransactionOptions)

交易的选项。默认为读写事务。

响应正文

Firestore.BeginTransaction 的响应。

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

JSON 表示法 
{
  "transaction": string
}
字段
transaction

string (bytes format)

启动的事务。

使用 base64 编码的字符串。

授权范围

需要以下 OAuth 范围之一：

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

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