Method: projects.databases.documents.listDocuments

Liệt kê tài liệu.

yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
parent

string

Bắt buộc. Tên tài nguyên mẹ. Ở định dạng: projects/{projectId}/databases/{databaseId}/documents hoặc projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Ví dụ: projects/my-project/databases/my-database/documents hoặc projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
collectionId

string

Không bắt buộc. Mã bộ sưu tập, so với parent, so với danh sách.

Ví dụ: chatrooms hoặc messages.

Đây là việc không bắt buộc. Nếu không được cung cấp, Firestore sẽ liệt kê tài liệu từ mọi bộ sưu tập trong parent được cung cấp.

Tham số truy vấn

Thông số
pageSize

integer

Không bắt buộc. Số tài liệu tối đa được trả về trong một phản hồi.

Firestore có thể trả về ít hơn giá trị này.
pageToken

string

Không bắt buộc. Mã thông báo trang, đã nhận được từ phản hồi trước đó của documents.list.

Cung cấp mã này để truy xuất trang tiếp theo. Khi phân trang, tất cả các thông số khác (ngoại trừ pageSize) phải khớp với các giá trị được đặt trong yêu cầu đã tạo mã thông báo trang.
orderBy

string

Không bắt buộc. Thứ tự trả lại chứng từ (không bắt buộc).

Ví dụ: priority desc, __name__ desc.

Điều này phản ánh ORDER BY được dùng trong các truy vấn Firestore nhưng ở dạng chuỗi. Khi không có, giấy tờ sẽ được sắp xếp dựa trên __name__ ASC.
mask

object (DocumentMask)

Không bắt buộc. Các trường cần trả về. Nếu bạn không đặt chính sách này, hệ thống sẽ trả về tất cả các trường.

Nếu một tài liệu có một trường không có trong mặt nạ này, thì trường đó sẽ không được trả về trong phản hồi.
showMissing

boolean

Nếu danh sách hiển thị các tài liệu còn thiếu.

Tài liệu bị thiếu nếu không tồn tại nhưng có các tài liệu phụ được lồng bên dưới. Nếu đúng, những tài liệu bị thiếu đó sẽ được trả về bằng một khoá nhưng sẽ không có các trường, createTime hoặc updateTime được đặt.

Yêu cầu có showMissing không được chỉ định where hoặc orderBy.
Tham số kết hợp consistency_selector. Chế độ nhất quán cho giao dịch này. Nếu bạn không đặt chính sách này, hệ thống sẽ đặt mặc định là tính nhất quán cao. consistency_selector chỉ có thể là một trong những trạng thái sau đây:
transaction

string (bytes format)

Thực hiện việc đọc như một phần của giao dịch đang hoạt động.

Chuỗi được mã hoá base64.
readTime

string (Timestamp format)

Thực hiện việc đọc tại thời gian được cung cấp.

Đây phải là một dấu thời gian có độ chính xác là micrô giây trong vòng 1 giờ qua, hoặc nếu tính năng Khôi phục tại một thời điểm đang bật, thì đây cũng có thể là dấu thời gian cả phút trong vòng 7 ngày qua.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của ListDocumentsResponse.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về việc xác thực.