列出文件。
HTTP 要求
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
執行個體類型,父項資源名稱。格式: 例如 |
collectionId |
選用設定。要清單的集合 ID (相對於 例如 這是選用項目,如未提供,Firestore 會在指定 |
查詢參數
參數 | |
---|---|
pageSize |
選用設定。單次回應中傳回的文件數量上限。 Firestore 傳回的值可能會小於這個值。 |
pageToken |
選用設定。屬於接收自前一個 提供此項目即可擷取後續網頁。進行分頁時,所有其他參數 ( |
orderBy |
選用設定。要傳回文件的選用順序。 例如 這與 Firestore 查詢中使用的 |
mask |
選用設定。要傳回的欄位。如未設定,則會傳回所有欄位。 如果文件含有不在這個遮罩中的欄位,則不會在回應中傳回該欄位。 |
showMissing |
如果清單應顯示缺漏的文件, 如果文件不存在,但文件底下有子文件,則不會顯示。如果設為 True,這類遺漏的文件會以鍵的形式傳回,但不會設定欄位、 含有 |
聯集參數 consistency_selector 。這筆交易的一致性模式。如果未設定,則會預設為同步一致性。consistency_selector 只能採用下列其中一種設定: |
|
transaction |
在運作中的交易中執行讀取作業。 Base64 編碼的字串。 |
readTime |
於指定時間執行讀取作業。 這個時間戳記須為過去 1 小時內的微秒精確度,或者如果已啟用時間點復原,也可以是過去 7 天內的整分鐘時間戳記。 RFC3339 世界標準時間「Zulu」格式的時間戳記,解析度以奈秒為單位,小數點後最多 9 位。範例: |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體會包含 ListDocumentsResponse
的執行個體。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽。