Method: projects.databases.documents.listDocuments

string

Zorunlu. Üst kaynak adı. Şu biçimde: projects/{projectId}/databases/{databaseId}/documents veya projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Örneğin: projects/my-project/databases/my-database/documents veya projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

İsteğe bağlı. Listelenecek parent ile ilişkili koleksiyon kimliği.

Örneğin: chatrooms veya messages.

Bu isteğe bağlıdır ve sağlanmadığında Firestore, sağlanan parent altındaki tüm koleksiyonlardaki dokümanları listeler.

integer

İsteğe bağlı. Tek bir yanıtta döndürülecek maksimum doküman sayısı.

Firestore bu değerden daha az sonuç döndürebilir.

string

İsteğe bağlı. Önceki documents.list yanıtından alınan bir sayfa jetonu.

Sonraki sayfayı almak için bunu sağlayın. Sayfalara ayırma işlemi sırasında diğer tüm parametreler (pageSize hariç), sayfa jetonunu oluşturan istekte ayarlanan değerlerle eşleşmelidir.

string

İsteğe bağlı. İade edilecek belgelerin isteğe bağlı sıralaması.

Örnek: priority desc, __name__ desc.

Bu, Firestore sorgularında kullanılan ancak dize biçiminde olan ORDER BY öğesini yansıtır. Eksik olduğunda dokümanlar __name__ ASC temel alınarak sıralanır.

object (DocumentMask)

İsteğe bağlı. Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Bir dokümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.

boolean

Listede eksik dokümanların gösterilip gösterilmediği

Bir doküman yoksa ancak altında iç içe yerleştirilmiş alt dokümanlar varsa eksiktir. Doğru değerine ayarlandığında bu tür eksik belgeler bir anahtarla döndürülür ancak createTime veya updateTime alanları ayarlanmaz.

showMissing içeren isteklerde where veya orderBy belirtilemez.

string (bytes format)

Okuma işlemini, zaten etkin olan bir işlemin parçası olarak gerçekleştirin.

base64 kodlu bir dize.

string (Timestamp format)

Okumayı belirtilen zamanda gerçekleştir.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".