Method: projects.databases.documents.listDocuments

แสดงรายการเอกสาร

คำขอ HTTP

GET https://firestore.googleapis.com/v1/{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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์