Mencantumkan dokumen.
Permintaan HTTP
GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
parent |
Wajib. Nama resource induk. Dalam format: Misalnya: |
collectionId |
Opsional. ID koleksi, yang terkait dengan Misalnya: Hal ini bersifat opsional. Jika tidak disediakan, Firestore akan mencantumkan dokumen dari semua koleksi pada |
Parameter kueri
Parameter | |
---|---|
pageSize |
Opsional. Jumlah maksimum dokumen yang akan ditampilkan dalam satu respons. Firestore mungkin menampilkan lebih sedikit dari nilai ini. |
pageToken |
Opsional. Token halaman, diterima dari respons Berikan ini untuk mengambil halaman berikutnya. Saat melakukan penomoran halaman, semua parameter lainnya (kecuali |
orderBy |
Opsional. Urutan opsional dokumen yang akan ditampilkan. Misalnya: Ini mencerminkan |
mask |
Opsional. 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. |
showMissing |
Apakah daftar akan menampilkan dokumen yang tidak ada. Dokumen hilang jika tidak ada, tetapi ada sub-dokumen yang disusun bertingkat di bawahnya. Jika benar (true), dokumen yang hilang tersebut akan ditampilkan dengan kunci, tetapi tidak akan memiliki kolom, Permintaan dengan |
Parameter gabungan 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 |
Lakukan operasi baca sebagai bagian dari transaksi yang sudah aktif. String berenkode base64. |
readTime |
Melakukan pembacaan pada waktu yang disediakan. 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 permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan berisi instance ListDocumentsResponse
.
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.