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