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

ไม่บังคับ รหัสคอลเล็กชันที่สัมพันธ์กับ parent กับรายการ

เช่น chatrooms หรือ messages

ซึ่งจะไม่บังคับ และหากไม่มี Firestore จะแสดงเอกสารจากคอลเล็กชันทั้งหมดในส่วน parent ที่ให้ไว้

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

ไม่บังคับ จำนวนสูงสุดของเอกสารที่จะแสดงผลในการตอบ 1 ครั้ง

Firestore อาจแสดงผลน้อยกว่าค่านี้
pageToken

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการตอบกลับ documents.list รายการก่อนหน้านี้

ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมด (ยกเว้น pageSize) ต้องตรงกับค่าที่ตั้งไว้ในคำขอที่สร้างโทเค็นของหน้า
orderBy

string

ไม่บังคับ ลำดับของเอกสารที่จะส่งคืน (ไม่บังคับ)

เช่น priority desc, __name__ desc

การดำเนินการนี้จะมิเรอร์ ORDER BY ที่ใช้ในการค้นหา Firestore แต่ในการนำเสนอสตริง หากไม่ระบุ ระบบจะเรียงลำดับเอกสารตาม __name__ ASC
mask

object (DocumentMask)

ไม่บังคับ ช่องที่จะแสดงผล หากไม่ได้ตั้งค่า ระบบจะแสดงฟิลด์ทั้งหมด

หากเอกสารมีช่องที่ไม่ได้อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในคำตอบ
showMissing

boolean

หากในรายการควรแสดงเอกสารที่ขาดหายไป

เอกสารจะหายไปหากไม่มีอยู่ แต่มีเอกสารย่อยซ้อนอยู่ เมื่อค่าเป็น "จริง" ระบบจะส่งเอกสารที่หายไปดังกล่าวกลับมาพร้อมกับคีย์ แต่จะไม่มีช่อง createTime หรือ updateTime อีก

คำขอที่มี showMissing ต้องไม่ระบุ where หรือ orderBy
พารามิเตอร์การรวม consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
transaction

string (bytes format)

ดำเนินการอ่านที่เป็นส่วนหนึ่งของธุรกรรมที่ใช้งานอยู่แล้ว

สตริงที่เข้ารหัสฐาน 64
readTime

string (Timestamp format)

อ่านเวลาที่ระบุ

โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์