يسرد المستندات.
طلب HTTP
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
يستخدم عنوان URL بنية تحويل الترميز gRPC.
معلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. اسم المورد الرئيسي. بالتنسيق: على سبيل المثال: السمة |
collectionId |
اختياريّ. رقم تعريف المجموعة المرتبط بـ على سبيل المثال: هذه الخطوة اختيارية، وفي حال عدم توفيرها، ستعرض Firestore المستندات من كل المجموعات ضمن |
معلمات طلب البحث
المَعلمات | |
---|---|
pageSize |
اختياريّ. الحد الأقصى لعدد المستندات التي يمكن عرضها في ردّ واحد. قد تعرِض Firestore أقل من هذه القيمة. |
pageToken |
اختياريّ. رمز مميّز للصفحة تم استلامه من ردّ سابق من يُرجى توفير هذا الحقل لاسترداد الصفحة التالية. عند التقسيم على صفحات، يجب أن تتطابق جميع المَعلمات الأخرى (باستثناء |
orderBy |
اختياريّ. الترتيب الاختياري للمستندات التي يتم إرجاعها. مثلاً: يتطابق هذا مع |
mask |
اختياريّ. الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة. |
showMissing |
إذا كان من المفترض أن تعرض القائمة المستندات المفقودة يكون المستند مفقودًا إذا لم يكن متوفرًا، ولكن توجد مستندات فرعية متداخلة أسفله. عند ضبط القيمة على "صحيح"، سيتم عرض هذه المستندات الناقصة باستخدام مفتاح، ولكن لن يتم ضبط حقول أو إنّ الطلبات التي تتضمّن |
معلمة الاتحاد consistency_selector . وضع الاتّساق لهذه المعاملة وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
transaction |
يمكنك إجراء القراءة كجزء من معاملة نشطة حاليًا. سلسلة بترميز base64. |
readTime |
اقرأ القراءة في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال ListDocumentsResponse
.
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.