Method: projects.databases.documents.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
HTTP請求
GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
URL 使用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) 在規定的時間執行讀取。 這必須是過去一小時內的微秒精度時間戳,或者如果啟用了時間點恢復,則還可以是過去 7 天內的整分鐘時間戳。 RFC3339 UTC「Zulu」格式的時間戳,具有奈秒解析度和最多九個小數位。範例: "2014-10-02T15:01:23Z" 和"2014-10-02T15:01:23.045123456Z" 。 |
授權範圍
需要以下 OAuth 範圍之一:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
有關詳細信息,請參閱身份驗證概述。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2023-12-01 (世界標準時間)。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"缺少我需要的資訊"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"過於複雜/步驟過多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"過時"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻譯問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/程式碼問題"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"容易理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"確實解決了我的問題"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]