Method: projects.databases.documents.listCollectionIds

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

string

Wajib. Dokumen induk. Dalam format: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Misalnya: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "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.
}
Kolom
pageSize

integer

Jumlah hasil maksimum yang akan ditampilkan.
pageToken

string

Token halaman. Harus berupa nilai dari ListCollectionIdsResponse.
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

string (Timestamp format)

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: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Isi respons

Respons dari Firestore.ListCollectionIds.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
Kolom
collectionIds[]

string

ID koleksi.
nextPageToken

string

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.