Method: projects.databases.documents.listCollectionIds

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

string

Zorunlu. Üst doküman. Belirtilen biçimde: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Örnek: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "pageSize": integer,
  "pageToken": string,

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Alanlar
pageSize

integer

Döndürülecek maksimum sonuç sayısı.
pageToken

string

Sayfa jetonu. ListCollectionIdsResponse değerinden bir değer olmalıdır.
Birleştirme alanı consistency_selector. Bu istek için tutarlılık modu. Ayarlanmazsa varsayılan olarak güçlü tutarlılık kullanılır. consistency_selector şunlardan yalnızca biri olabilir:
readTime

string (Timestamp format)

Belgeleri belirtilen zamanda olduğu gibi okur.

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".

Yanıt gövdesi

Firestore.ListCollectionIds tarafından gönderilen yanıt.

Başarılı olursa yanıt gövdesi aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
Alanlar
collectionIds[]

string

Koleksiyon kimlikleri.
nextPageToken

string

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ış başlıklı makaleye bakın.