Method: projects.databases.documents.listDocuments

列出文件。

HTTP 要求

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

這個網址使用 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

選用設定。要清單的集合 ID (相對於 parent)。

例如 chatrooms 或 messages。

這是選用項目，如未提供，Firestore 會在指定 parent 下列出所有集合的文件。

查詢參數

參數
pageSize

integer

選用設定。單次回應中傳回的文件數量上限。

Firestore 傳回的值可能會小於這個值。
pageToken

string

選用設定。屬於接收自前一個 documents.list 回應的網頁權杖。

提供此項目即可擷取後續網頁。進行分頁時，所有其他參數 (pageSize 除外) 都必須與產生網頁權杖的要求中設定的值相符。
orderBy

string

選用設定。要傳回文件的選用順序。

例如 priority desc, __name__ desc。

這與 Firestore 查詢中使用的 ORDER BY 一模一樣，但是以字串表示。如果找不到，系統會根據 __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)

於指定時間執行讀取作業。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度不超過奈秒，最多 9 個小數位數。範例："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

詳情請參閱驗證總覽一文。