Method: projects.databases.documents.batchGet

Mendapatkan beberapa dokumen.

Dokumen yang ditampilkan dengan metode ini tidak dijamin akan dikembalikan dalam urutan yang sama seperti yang diminta.

Permintaan HTTP

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

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 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Kolom
documents[]

string

Nama dokumen yang akan diambil. Dalam format: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Permintaan akan gagal jika salah satu dokumen bukan merupakan resource turunan dari database yang ditentukan. Nama duplikat akan dihapus.
mask

object (DocumentMask)

Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons.
Kolom union consistency_selector. Mode konsistensi untuk transaksi ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut:
transaction

string (bytes format)

Membaca dokumen dalam transaksi.

String berenkode base64.
newTransaction

object (TransactionOptions)

Memulai transaksi baru dan membaca dokumen. Setelan defaultnya adalah transaksi hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam aliran data.
readTime

string (Timestamp format)

Membaca dokumen sebagaimana adanya pada waktu yang ditentukan.

Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir.

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

Isi respons

Respons yang di-streaming untuk Firestore.BatchGetDocuments.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
Kolom
transaction

string (bytes format)

Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya akan ditetapkan dalam respons pertama, dan hanya jika BatchGetDocumentsRequest.new_transaction telah ditetapkan dalam permintaan.

String berenkode base64.
readTime

string (Timestamp format)

Waktu saat dokumen dibaca. Jumlah ini mungkin meningkat secara monoton. Dalam hal ini, dokumen sebelumnya dalam aliran hasil dijamin tidak berubah antara readTime-nya dan dokumen ini.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
Kolom union result. Hasil tunggal. Kolom ini boleh kosong jika server baru saja menampilkan transaksi. result hanya ada berupa salah satu diantara berikut:
found

object (Document)

Dokumen yang diminta.
missing

string

Nama dokumen yang diminta tetapi tidak ada. Dalam format: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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.