Method: projects.databases.documents.listCollectionIds

يسرد جميع معرّفات المجموعات أسفل المستند.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز gRPC.

معلمات المسار

المَعلمات
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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.