Method: projects.databases.documents.beginTransaction

開始新的交易。

HTTP 要求

POST https://firestore.googleapis.com/v1/{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

詳情請參閱驗證總覽。