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/v1/{database=projects/*/databases/*}/documents:batchGet
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
database |
Wajib. Nama database. Dalam format: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "documents": [ string ], "mask": { object ( |
Kolom | |
---|---|
documents[] |
Nama dokumen yang akan diambil. Dalam format: |
mask |
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 |
Membaca dokumen dalam transaksi. String berenkode base64. |
newTransaction |
Memulai transaksi baru dan membaca dokumen. Setelan defaultnya adalah transaksi hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam aliran data. |
readTime |
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: |
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 |
Kolom | |
---|---|
transaction |
Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya akan ditetapkan dalam respons pertama, dan hanya jika String berenkode base64. |
readTime |
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: |
Kolom union result . Hasil tunggal. Kolom ini boleh kosong jika server baru saja menampilkan transaksi. result hanya ada berupa salah satu diantara berikut: |
|
found |
Dokumen yang diminta. |
missing |
Nama dokumen yang diminta tetapi tidak ada. Dalam format: |
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.