Method: projects.databases.documents.list

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

string

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

例如 chatrooms 或 messages。

此為選用項目。如未提供，Firestore 會在提供的 parent 底下列出所有集合的文件。

integer

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

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

string

選用設定。接收自先前 documents.list 回應的網頁權杖。

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

string

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

例如 priority desc, __name__ desc。

這會反映 Firestore 查詢中使用的 ORDER BY，但以字串表示法表示。不使用時，文件會根據 __name__ ASC 排序。

object (DocumentMask)

選用設定。要傳回的欄位。如果沒有設定，系統會傳回所有欄位。

如果文件的某個欄位未列於這個遮罩中，系統不會在回應中傳回該欄位。

boolean

清單是否應顯示遺漏的文件。

文件不存在時就不見了，但下方有子文件巢狀結構。如果設為「是」，系統將傳回缺少的這類文件以及鍵，但不會設定欄位、createTime 或 updateTime。

含有 showMissing 的要求無法指定 where 或 orderBy。

string (bytes format)

在既有交易中執行讀取作業。

Base64 編碼的字串。

string (Timestamp format)

在提供的時間點執行讀取作業。

這個值必須是過去 1 小時內的微秒精確度，如果已啟用「時間點復原」功能，則可以是過去 7 天內的整分鐘時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度和最多九個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。