Dokümanları listeler.
HTTP isteği
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
parent |
Zorunlu. Üst kaynak adı. Biçimi: Örneğin, |
collectionId |
İsteğe bağlı. Örneğin, Bu isteğe bağlıdır. Bu belirtilmediğinde Firestore, tüm koleksiyonlardaki belgeleri sağlanan |
Sorgu parametreleri
Parametreler | |
---|---|
pageSize |
İ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. |
pageToken |
İsteğe bağlı. Önceki bir Sonraki sayfayı almak için bu kodu sağlayın. Sayfalara ayırırken, diğer tüm parametreler ( |
orderBy |
İsteğe bağlı. İade edilecek belgelerin isteğe bağlı sıralaması. Örneğin: Bu, Firestore sorgularında kullanılan ancak dize gösteriminde kullanılan |
mask |
İ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. |
showMissing |
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
|
Birleştirme parametresi consistency_selector . Bu işlem için tutarlılık modu. Politika ayarlanmazsa varsayılan olarak güçlü tutarlılık sağlanır. consistency_selector şunlardan yalnızca biri olabilir: |
|
transaction |
Okumayı etkin bir işlemin parçası olarak gerçekleştirin. Base64 kodlu bir dize. |
readTime |
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: |
İstek içeriği
İstek metni boş olmalıdır.
Yanıt metni
Başarılıysa yanıt metni, ListDocumentsResponse
öğesinin bir örneğini içerir.
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış sayfasına göz atın.