Method: projects.databases.documents.beginTransaction

Memulai transaksi baru.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
database

string

Wajib. Nama database. Dalam format: projects/{projectId}/databases/{databaseId}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "options": {
    object (TransactionOptions)
  }
}
Kolom
options

object (TransactionOptions)

Opsi untuk transaksi. Setelan defaultnya adalah transaksi baca-tulis.

Isi respons

Respons untuk Firestore.BeginTransaction.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "transaction": string
}
Kolom
transaction

string (bytes format)

Transaksi yang dimulai.

String berenkode base64.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.