Method: projects.databases.documents.list

string

Zorunlu. Üst kaynak adı. Biçimi: 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ı. parent ile göreli olarak listelenecek koleksiyon kimliği.

Örneğin, chatrooms veya messages.

Bu isteğe bağlıdır. Bu belirtilmediğinde Firestore, tüm koleksiyonlardaki belgeleri sağlanan parent altında listeler.

integer

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

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

string

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

Sonraki sayfayı almak için bu kodu sağlayın. Sayfalara ayırırken, 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ı.

Örneğin: priority desc, __name__ desc.

Bu, Firestore sorgularında kullanılan ancak dize gösteriminde kullanılan ORDER BY öğesini yansıtır. Yoksa belgeler __name__ ASC tarihine göre sıralanır.

object (DocumentMask)

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

Bir dokümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.

boolean

Listede eksik dokümanların gösterilip gösterilmeyeceğ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 dokümanlar bir anahtarla döndürülür ancak createTime veya updateTime alanları ayarlanmaz.

showMissing içeren isteklerde where veya orderBy belirtilemez.

string (bytes format)

Okumayı etkin bir işlemin parçası olarak gerçekleştirin.

Base64 kodlu bir dize.

string (Timestamp format)

Okumayı belirtilen zamanda gerçekleştirin.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".