Method: projects.databases.documents.listDocuments

string

Wajib. Nama resource induk. Dalam format: projects/{projectId}/databases/{databaseId}/documents atau projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Misalnya: projects/my-project/databases/my-database/documents atau projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Opsional. ID koleksi, yang terkait dengan parent, ke daftar.

Misalnya: chatrooms atau messages.

Hal ini bersifat opsional. Jika tidak disediakan, Firestore akan mencantumkan dokumen dari semua koleksi pada parent yang disediakan.

integer

Opsional. Jumlah maksimum dokumen yang akan ditampilkan dalam satu respons.

Firestore mungkin menampilkan lebih sedikit dari nilai ini.

string

Opsional. Token halaman, diterima dari respons documents.list sebelumnya.

Berikan ini untuk mengambil halaman berikutnya. Saat melakukan penomoran halaman, semua parameter lainnya (kecuali pageSize) harus cocok dengan nilai yang ditetapkan dalam permintaan yang membuat token halaman.

string

Opsional. Urutan opsional dokumen yang akan ditampilkan.

Misalnya: priority desc, __name__ desc.

Ini mencerminkan ORDER BY yang digunakan dalam kueri Firestore, tetapi dalam representasi string. Jika tidak ada, dokumen akan diurutkan berdasarkan __name__ ASC.

object (DocumentMask)

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.

boolean

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, createTime, atau updateTime yang ditetapkan.

Permintaan dengan showMissing tidak boleh menentukan where atau orderBy.

string (bytes format)

Lakukan operasi baca sebagai bagian dari transaksi yang sudah aktif.

String berenkode base64.

string (Timestamp format)

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: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".