Bir dokümanın altındaki tüm koleksiyon kimliklerini listeler.
HTTP isteği
POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
parent |
Zorunlu. Üst doküman. Biçimi: |
İstek içeriği
İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:
JSON gösterimi |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
Alanlar | |
---|---|
pageSize |
Döndürülecek maksimum sonuç sayısı. |
pageToken |
Sayfa jetonu. |
Birleştirme alanı consistency_selector . Bu istek 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: |
|
readTime |
Dokümanları verilen zaman olduğu gibi okur. 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: |
Yanıt gövdesi
Firestore.ListCollectionIds
adlı kullanıcının yanıtı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{ "collectionIds": [ string ], "nextPageToken": string } |
Alanlar | |
---|---|
collectionIds[] |
Koleksiyon kimlikleri. |
nextPageToken |
Listeye devam etmek için kullanılabilecek bir sayfa jetonu. |
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.