แสดงรายการเอกสาร
คำขอ HTTP
GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: เช่น |
collectionId |
ไม่บังคับ รหัสคอลเล็กชันที่สัมพันธ์กับ เช่น โดยคุณจะดำเนินการนี้หรือไม่ก็ได้ และเมื่อไม่มีให้บริการ Firestore จะแสดงรายการเอกสารจากคอลเล็กชันทั้งหมดภายใต้ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
pageSize |
ไม่บังคับ จำนวนเอกสารสูงสุดที่จะแสดงในคำตอบเดียว Firestore อาจแสดงผลน้อยกว่าค่านี้ |
pageToken |
ไม่บังคับ โทเค็นของหน้าเว็บ ที่ได้รับจากการตอบกลับ โปรดระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมด (ยกเว้น |
orderBy |
ไม่บังคับ ลำดับของเอกสารที่จะส่งคืนหรือไม่ก็ได้ เช่น ซึ่งสะท้อนให้เห็นถึง |
mask |
ไม่บังคับ ช่องที่จะแสดง หากไม่ได้ตั้งค่า ระบบจะแสดงช่องทั้งหมด หากเอกสารมีฟิลด์ที่ไม่ได้แสดงอยู่ในมาสก์นี้ ฟิลด์ดังกล่าวจะไม่แสดงผลในคำตอบ |
showMissing |
กรณีที่รายการควรแสดงเอกสารที่ขาดหายไป เอกสารหายไปถ้าไม่มีอยู่ แต่มีเอกสารย่อยฝังอยู่ใต้นั้น เมื่อเป็นจริง ระบบจะแสดงผลเอกสารที่ขาดหายไปดังกล่าวพร้อมคีย์ แต่จะไม่มีช่อง คำขอที่มี |
พารามิเตอร์การรวม consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องที่อัปเดตเป็นค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
transaction |
ดำเนินการอ่านโดยเป็นส่วนหนึ่งของธุรกรรมที่ใช้งานอยู่แล้ว สตริงที่เข้ารหัสฐาน 64 |
readTime |
อ่านตามเวลาที่ระบุไว้ โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้ การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: |
เนื้อความของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ ListDocumentsResponse
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์