يسرد جميع معرّفات المجموعات أسفل المستند.
طلب HTTP
POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds
يستخدم عنوان URL بنية تحويل الترميز gRPC.
معلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. المستند الرئيسي. بالتنسيق: |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
الحقول | |
---|---|
pageSize |
تمثّل هذه السمة الحد الأقصى لعدد النتائج المطلوب عرضها. |
pageToken |
الرمز المميز للصفحة. يجب أن تكون القيمة من |
حقل الاتحاد consistency_selector وضع التناسق لهذا الطلب. وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
readTime |
يقرأ المستندات كما كانت في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
نص الاستجابة
الردّ من Firestore.ListCollectionIds
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "collectionIds": [ string ], "nextPageToken": string } |
الحقول | |
---|---|
collectionIds[] |
معرّفات المجموعات |
nextPageToken |
رمز الصفحة الذي يمكن استخدامه لمتابعة القائمة. |
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.