Method: projects.databases.documents.commit

Melakukan transaksi, sekaligus memperbarui dokumen secara opsional.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
database

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{projectId}/databases/{databaseId}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
Kolom
writes[]

object (Write)

Penulisan yang akan diterapkan.

Selalu dijalankan secara atomik dan berurutan.

transaction

string (bytes format)

Jika ditetapkan, semua penulisan dalam transaksi ini akan diterapkan, lalu di-commit.

String berenkode base64.

Isi respons

Respons untuk Firestore.Commit.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
Kolom
writeResults[]

object (WriteResult)

Hasil penerapan penulisan.

Hasil penulisan ke-i ini sesuai dengan penulisan ke-i dalam permintaan.

commitTime

string (Timestamp format)

Waktu terjadinya commit. Setiap pembacaan dengan readTime yang sama atau lebih besar dijamin akan melihat efek commit.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.