Method: projects.databases.documents.listCollectionIds

تمام شناسه های مجموعه را در زیر یک سند فهرست می کند.

درخواست HTTP

POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
parent

string

ضروری. سند مادر. در قالب: projects/{projectId}/databases/{databaseId}/documents/{document_path} . به عنوان مثال: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی 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.
}
زمینه های
pageSize

integer

حداکثر تعداد نتایج برای بازگشت.

pageToken

string

یک نشانه صفحه باید مقداری از ListCollectionIdsResponse باشد.

اتحاد فیلد consistency_selector . حالت سازگاری برای این درخواست. اگر تنظیم نشود، به طور پیش‌فرض روی سازگاری قوی تنظیم می‌شود. consistency_selector تنها می تواند یکی از موارد زیر باشد:
readTime

string ( Timestamp format)

اسناد را همانطور که در زمان معین بودند می خواند.

این باید یک مهر زمانی دقیق میکروثانیه در یک ساعت گذشته باشد، یا اگر بازیابی نقطه در زمان فعال باشد، می‌تواند یک مهر زمانی کامل در 7 روز گذشته باشد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

بدن پاسخگو

پاسخ از Firestore.ListCollectionIds .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
زمینه های
collectionIds[]

string

شناسه های مجموعه

nextPageToken

string

نشانه صفحه ای که ممکن است برای ادامه لیست استفاده شود.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.