Method: projects.databases.documents.beginTransaction

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

詳細については、認証の概要をご覧ください。