این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Method: projects.databases.documents.listDocuments

اسناد را فهرست می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های

مولفه های
`parent`	`string` ضروری. نام منبع والد در قالب: `projects/{projectId}/databases/{databaseId}/documents` or `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` ارائه شده فهرست می‌کند.

parent

string

ضروری. نام منبع والد در قالب: projects/{projectId}/databases/{databaseId}/documents or 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` set ندارند. درخواست‌های دارای `showMissing` ممکن است `where` یا `orderBy` مشخص نکنند.
پارامتر Union `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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.