Method: projects.databases.documents.list

يسرد المستندات.

طلب HTTP

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

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

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

المَعلمات
parent

string

يجب ملء الحقل. اسم المورد الرئيسي. بالتنسيق: projects/{projectId}/databases/{databaseId}/documents أو projects/{projectId}/databases/{databaseId}/documents/{document_path}.

على سبيل المثال: projects/my-project/databases/my-database/documents أو projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
collectionId

string

هذه السمة اختيارية. رقم تعريف المجموعة المرتبط بـ parent في القائمة.

على سبيل المثال: chatrooms أو messages

هذا الإجراء اختياري، وفي حال عدم توفيره، سيُدرج Firestore المستندات من كل المجموعات ضمن parent المقدَّم.

معامِلات طلب البحث

المَعلمات
pageSize

integer

هذه السمة اختيارية. الحد الأقصى لعدد المستندات المطلوب عرضها في رد واحد.

قد تعرض Firestore عددًا أقل من هذه القيمة.
pageToken

string

هذه السمة اختيارية. رمز مميّز للصفحة، تم تلقّيه من رد documents.list سابق.

ويمكنك توفير هذا الحقل لاسترداد الصفحة التالية. عند التقسيم على صفحات، يجب أن تتطابق جميع المَعلمات الأخرى (باستثناء pageSize) مع القيم المحدَّدة في الطلب الذي أنشأ الرمز المميّز للصفحة.
orderBy

string

هذه السمة اختيارية. الترتيب الاختياري للمستندات المطلوب عرضها

مثلاً: priority desc, __name__ desc

يعكس هذا ORDER BY المستخدم في طلبات بحث Firestore ولكن في تمثيل سلسلة. عند عدم توفّر هذه المستندات، يتم ترتيب المستندات استنادًا إلى __name__ ASC.
mask

object (DocumentMask)

هذه السمة اختيارية. الحقول المطلوب عرضها. وفي حال تم تركها بدون ضبط، سيتم عرض جميع الحقول.

إذا كان المستند يحتوي على حقل غير موجود في هذا القناع، لن يتم عرض هذا الحقل في الرد.
showMissing

boolean

ما إذا كان يجب أن تُظهر القائمة المستندات المفقودة.

أحد المستندات مفقود إذا لم يكن موجودًا، ولكن توجد مستندات فرعية متداخلة أسفله. عندما تكون القيمة true، سيتم عرض هذه المستندات المفقودة باستخدام مفتاح ولكن لن تحتوي على مجموعة من الحقول، أو createTime أو updateTime.

لا يجوز أن تحدّد الطلبات مع showMissing السمة where أو orderBy.
معلمة الاتحاد consistency_selector. وضع الاتساق لهذه المعاملة وفي حال تم ترك السياسة بدون ضبط، سيتم تطبيق القيمة التلقائية على مستوى الاتساق القوي. يمكن أن يكون consistency_selector واحدًا فقط مما يلي:
transaction

string (bytes format)

يُرجى إجراء القراءة كجزء من معاملة نشطة حاليًا.

سلسلة بترميز base64.
readTime

string (Timestamp format)

نفِّذ القراءة في الوقت المحدَّد.

ويجب أن يكون هذا الطابع الزمني للدقة بالميكرو ثانية خلال الساعة الماضية، أو إذا كانت ميزة "الاسترداد في نقطة زمنية" مفعَّلة، يمكن أن يكون أيضًا طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام.

طابع زمني بتنسيق RFC3339 UTC "Zulu"، بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال ListDocumentsResponse.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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