แสดงรหัสคอลเล็กชันทั้งหมดภายใต้เอกสาร
คำขอ HTTP
POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ต้องระบุ เอกสารหลัก ในรูปแบบ: |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
ช่อง | |
---|---|
pageSize |
จำนวนผลลัพธ์สูงสุดที่จะแสดง |
pageToken |
โทเค็นของหน้า ต้องเป็นค่าจาก |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับคำขอนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
readTime |
อ่านเอกสารแบบเดียวกับ ณ เวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
เนื้อหาการตอบกลับ
คำตอบจาก Firestore.ListCollectionIds
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "collectionIds": [ string ], "nextPageToken": string } |
ช่อง | |
---|---|
collectionIds[] |
รหัสคอลเล็กชัน |
nextPageToken |
โทเค็นของหน้าที่อาจใช้เพื่อเป็นรายการต่อ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์