Method: projects.databases.documents.beginTransaction

新しいトランザクションを開始します。

HTTPリクエスト

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

URL は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

詳細については、 「認証の概要」を参照してください。