Method: projects.databases.documents.list

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

طلب HTTP

GET https://firestore.googleapis.com/v1beta1/{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

إذا كان من المفترض أن تعرض القائمة المستندات المفقودة

يكون المستند مفقودًا إذا لم يكن متوفرًا، ولكن توجد مستندات فرعية متداخلة أسفله. عند ضبط القيمة على "صحيح"، سيتم عرض هذه المستندات الناقصة باستخدام مفتاح، ولكن لن يتم ضبط حقول أو 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

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