Mendapatkan beberapa dokumen.
Dokumen yang dikembalikan 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 sintaks gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
database |
Wajib diisi. Nama {i>database<i}. 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, defaultnya 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 streaming. |
readTime |
Membaca dokumen sebagaimana adanya pada waktu tertentu. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, juga dapat berupa stempel waktu menit penuh dalam 7 hari terakhir. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. 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 di respons pertama, dan hanya jika String berenkode base64. |
readTime |
Waktu saat dokumen dibaca. Hal ini mungkin meningkat secara monotis, dalam hal ini dokumen sebelumnya dalam aliran hasil dijamin tidak berubah antara readTime dan dokumen ini. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
Kolom union result . Satu hasil. Kolom ini boleh kosong jika server hanya 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 mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.