Mendapat banyak dokumen.
Dokumen yang dikembalikan dengan cara ini tidak dijamin akan dikembalikan sesuai urutan yang diminta.
permintaan HTTP
POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchGet
URL menggunakan sintaks Transcoding gRPC .
Parameter jalur
Parameter | |
---|---|
database | Diperlukan. Nama basis data. Dalam format: |
Permintaan tubuh
Badan permintaan berisi data dengan struktur berikut:
Representasi JSON |
---|
{ "documents": [ string ], "mask": { object ( |
Bidang | |
---|---|
documents[] | Nama dokumen yang akan diambil. Dalam format: |
mask | Bidang yang akan dikembalikan. Jika tidak disetel, kembalikan semua bidang. Jika dokumen memiliki bidang yang tidak ada dalam masker ini, bidang tersebut tidak akan dikembalikan dalam respons. |
consistency_selector bidang gabungan_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, defaultnya adalah konsistensi yang kuat. consistency_selector hanya dapat berupa salah satu dari berikut ini: | |
transaction | Membaca dokumen dalam suatu transaksi. String yang dikodekan base64. |
newTransaction | Memulai transaksi baru dan membaca dokumen. Defaultnya adalah transaksi read-only. ID transaksi baru akan dikembalikan sebagai respons pertama di aliran. |
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, dapat juga berupa stempel waktu satu menit penuh dalam 7 hari terakhir. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
Badan respons
Respons yang dialirkan untuk Firestore.BatchGetDocuments
.
Jika berhasil, isi respons berisi data dengan struktur berikut:
Representasi JSON |
---|
{ "transaction": string, "readTime": string, // Union field |
Bidang | |
---|---|
transaction | Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya akan disetel pada respons pertama, dan hanya jika String yang dikodekan base64. |
readTime | Waktu saat dokumen dibaca. Ini mungkin meningkat secara monoton, dalam hal ini dokumen sebelumnya dalam aliran hasil dijamin tidak berubah antara waktu baca dan waktu ini. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
result lapangan serikat. Hasil tunggal. Ini bisa kosong jika server baru saja mengembalikan transaksi. result hanya dapat berupa salah satu dari berikut ini: | |
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 lebih lanjut, lihat Ikhtisar Otentikasi .