Method: projects.databases.documents.list

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

Tham số
parent

string

Bắt buộc. Tên tài nguyên gốc. Theo đị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 (tương ứng với parent) trong danh sách.

Ví dụ: chatrooms hoặc messages.

Đây là yêu cầu không bắt buộc và 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 theo parent được cung cấp.

Tham số truy vấn

Tham số
pageSize

integer

Không bắt buộc. Số lượng tài liệu tối đa cần trả về trong một câu trả lờ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 documents.list trước đó.

Cung cấp URL này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham 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ự không bắt buộc của tài liệu cần trả lại.

Ví dụ: priority desc, __name__ desc.

Thao tác này phản ánh ORDER BY được dùng trong các truy vấn Firestore nhưng ở dạng biểu diễn dạng chuỗi. Khi không có dữ liệu, các tài liệu 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 không được đặt, hàm sẽ trả về tất cả các trường.

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

boolean

Liệu danh sách có hiển thị các tài liệu bị thiếu hay không.

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 tài liệu đó. Khi đúng, những tài liệu bị thiếu này sẽ được trả về bằng một khoá nhưng sẽ không có các trường, createTime hoặc updateTime nào đượ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, thì chế độ mặc định sẽ là mức độ nhất quán cao. consistency_selector chỉ có thể là một trong những trạng thái sau:
transaction

string (bytes format)

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

Một chuỗi được mã hoá base64.
readTime

string (Timestamp format)

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

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

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 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 phiên bản của ListDocumentsResponse.

Phạm vi uỷ quyền

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

  • 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ề hoạt động xác thực.