Mencantumkan semua ID koleksi di bawah dokumen.
Permintaan HTTP
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
parent |
Wajib. Dokumen induk. Dalam format: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
Kolom | |
---|---|
pageSize |
Jumlah hasil maksimum yang akan ditampilkan. |
pageToken |
Token halaman. Harus berupa nilai dari |
Kolom union consistency_selector . Mode konsistensi untuk permintaan ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
readTime |
Membaca dokumen sebagaimana adanya pada waktu yang ditentukan. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
Isi respons
Respons dari Firestore.ListCollectionIds
.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "collectionIds": [ string ], "nextPageToken": string } |
Kolom | |
---|---|
collectionIds[] |
ID koleksi. |
nextPageToken |
Token halaman yang dapat digunakan untuk melanjutkan daftar. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.