Cloud Firestore API

เข้าถึงฐานข้อมูลเอกสาร NoSQL ที่สร้างขึ้นเพื่อการปรับขนาดอัตโนมัติ ประสิทธิภาพสูง และความง่ายในการพัฒนาแอปพลิเคชัน

บริการ: firestore.googleapis.com

หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้คุณใช้ ไลบรารีไคลเอ็นต์ ที่ Google มอบให้ หากแอปพลิเคชันของคุณจำเป็นต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อคุณส่งคำขอ API

เอกสารการค้นพบ

เอกสารการค้นพบ เป็นข้อกำหนดที่เครื่องอ่านได้สำหรับการอธิบายและใช้ REST API ใช้เพื่อสร้างไลบรารีไคลเอ็นต์ ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google API บริการหนึ่งอาจมีเอกสารการค้นพบหลายฉบับ บริการนี้มีเอกสารการค้นพบดังต่อไปนี้:

จุดสิ้นสุดการบริการ

จุดสิ้นสุดของบริการ คือ URL พื้นฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการหนึ่งอาจมีจุดสิ้นสุดบริการหลายจุด บริการนี้มีจุดสิ้นสุดบริการดังต่อไปนี้ และ URI ทั้งหมดด้านล่างสัมพันธ์กับจุดสิ้นสุดบริการนี้:

  • https://firestore.googleapis.com

ทรัพยากรส่วนที่เหลือ: v1beta2.projects.databases

วิธีการ
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
ส่งออกสำเนาของเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบจัดเก็บข้อมูลอื่น เช่น Google Cloud Storage
importDocuments POST /v1beta2/{name=projects/*/databases/*}:importDocuments
นำเข้าเอกสารไปยัง Google Cloud Firestore

ทรัพยากรส่วนที่เหลือ: v1beta2.projects.databases.collectionGroups.fields

วิธีการ
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}
รับข้อมูลเมตาและการกำหนดค่าสำหรับฟิลด์
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
แสดงรายการการกำหนดค่าฟิลด์และข้อมูลเมตาสำหรับฐานข้อมูลนี้
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
อัปเดตการกำหนดค่าฟิลด์

ทรัพยากรส่วนที่เหลือ: v1beta2.projects.databases.collectionGroups.indexes

วิธีการ
create POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
สร้างดัชนีคอมโพสิต
delete DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
ลบดัชนีคอมโพสิต
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
รับดัชนีคอมโพสิต
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
แสดงรายการดัชนีผสม

ทรัพยากรส่วนที่เหลือ: v1beta1.projects.databases

วิธีการ
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
ส่งออกสำเนาของเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบจัดเก็บข้อมูลอื่น เช่น Google Cloud Storage
importDocuments POST /v1beta1/{name=projects/*/databases/*}:importDocuments
นำเข้าเอกสารไปยัง Google Cloud Firestore

ทรัพยากรส่วนที่เหลือ: v1beta1.projects.databases.documents

วิธีการ
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
รับเอกสารหลายชุด
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
ใช้ชุดการดำเนินการเขียน
beginTransaction POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction
เริ่มการทำธุรกรรมใหม่
commit POST /v1beta1/{database=projects/*/databases/*}/documents:commit
ยืนยันการทำธุรกรรมในขณะที่อัพเดตเอกสารเป็นทางเลือก
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
สร้างเอกสารใหม่
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
ลบเอกสาร
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
ได้รับเอกสารฉบับเดียว
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
แสดงรายการเอกสาร
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
แสดงรายการ ID คอลเลกชันทั้งหมดใต้เอกสาร
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
แสดงรายการเอกสาร
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
แบ่งพาร์ติชันแบบสอบถามโดยการส่งคืนเคอร์เซอร์พาร์ติชันที่สามารถใช้เพื่อเรียกใช้แบบสอบถามแบบขนาน
patch PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}
อัพเดตหรือแทรกเอกสาร
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
ย้อนกลับธุรกรรม
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
รันแบบสอบถามแบบรวม
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
เรียกใช้แบบสอบถาม

ทรัพยากรส่วนที่เหลือ: v1beta1.projects.databases.indexes

วิธีการ
create POST /v1beta1/{parent=projects/*/databases/*}/indexes
สร้างดัชนีที่ระบุ
delete DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}
ลบดัชนี
get GET /v1beta1/{name=projects/*/databases/*/indexes/*}
รับดัชนี
list GET /v1beta1/{parent=projects/*/databases/*}/indexes
แสดงรายการดัชนีที่ตรงกับตัวกรองที่ระบุ

ทรัพยากรส่วนที่เหลือ: v1.projects.databases

วิธีการ
create POST /v1/{parent=projects/*}/databases
สร้างฐานข้อมูล
delete DELETE /v1/{name=projects/*/databases/*}
ลบฐานข้อมูล
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
ส่งออกสำเนาของเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบจัดเก็บข้อมูลอื่น เช่น Google Cloud Storage
get GET /v1/{name=projects/*/databases/*}
รับข้อมูลเกี่ยวกับฐานข้อมูล
importDocuments POST /v1/{name=projects/*/databases/*}:importDocuments
นำเข้าเอกสารไปยัง Google Cloud Firestore
list GET /v1/{parent=projects/*}/databases
แสดงรายการฐานข้อมูลทั้งหมดในโครงการ
patch PATCH /v1/{database.name=projects/*/databases/*}
อัพเดตฐานข้อมูล
restore POST /v1/{parent=projects/*}/databases:restore
สร้างฐานข้อมูลใหม่โดยการกู้คืนจากข้อมูลสำรองที่มีอยู่

ทรัพยากรส่วนที่เหลือ: v1.projects.databases.backupSchedules

วิธีการ
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
สร้างกำหนดเวลาการสำรองข้อมูลบนฐานข้อมูล
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
ลบกำหนดเวลาการสำรองข้อมูล
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
รับข้อมูลเกี่ยวกับกำหนดเวลาการสำรองข้อมูล
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
แสดงรายการกำหนดการสำรองข้อมูล
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
อัพเดตกำหนดการสำรองข้อมูล

ทรัพยากรส่วนที่เหลือ: v1.projects.databases.collectionGroups.fields

วิธีการ
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
รับข้อมูลเมตาและการกำหนดค่าสำหรับฟิลด์
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
แสดงรายการการกำหนดค่าฟิลด์และข้อมูลเมตาสำหรับฐานข้อมูลนี้
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
อัปเดตการกำหนดค่าฟิลด์

ทรัพยากรส่วนที่เหลือ: v1.projects.databases.collectionGroups.indexes

วิธีการ
create POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
สร้างดัชนีคอมโพสิต
delete DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
ลบดัชนีคอมโพสิต
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
รับดัชนีคอมโพสิต
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
แสดงรายการดัชนีผสม

ทรัพยากรส่วนที่เหลือ: v1.projects.databases.documents

วิธีการ
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
รับเอกสารหลายชุด
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
ใช้ชุดการดำเนินการเขียน
beginTransaction POST /v1/{database=projects/*/databases/*}/documents:beginTransaction
เริ่มการทำธุรกรรมใหม่
commit POST /v1/{database=projects/*/databases/*}/documents:commit
ยืนยันการทำธุรกรรมในขณะที่อัพเดตเอกสารเป็นทางเลือก
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
สร้างเอกสารใหม่
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
ลบเอกสาร
get GET /v1/{name=projects/*/databases/*/documents/*/**}
ได้รับเอกสารฉบับเดียว
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
แสดงรายการเอกสาร
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
แสดงรายการ ID คอลเลกชันทั้งหมดใต้เอกสาร
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
แสดงรายการเอกสาร
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
แบ่งพาร์ติชันแบบสอบถามโดยการส่งคืนเคอร์เซอร์พาร์ติชันที่สามารถใช้เพื่อเรียกใช้แบบสอบถามแบบขนาน
patch PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}
อัพเดตหรือแทรกเอกสาร
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
ย้อนกลับธุรกรรม
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
รันแบบสอบถามแบบรวม
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
เรียกใช้แบบสอบถาม

รีซอร์ส REST: v1.projects.databases.operations

วิธีการ
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
เริ่มการยกเลิกแบบอะซิงโครนัสในการดำเนินการที่ใช้เวลานาน
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
ลบการดำเนินการที่ใช้เวลานาน
get GET /v1/{name=projects/*/databases/*/operations/*}
รับสถานะล่าสุดของการดำเนินการที่ใช้เวลานาน
list GET /v1/{name=projects/*/databases/*}/operations
แสดงรายการการดำเนินการที่ตรงกับตัวกรองที่ระบุในคำขอ

ทรัพยากรส่วนที่เหลือ: v1.projects.locations

วิธีการ
get GET /v1/{name=projects/*/locations/*}
รับข้อมูลเกี่ยวกับสถานที่
list GET /v1/{name=projects/*}/locations
แสดงรายการข้อมูลเกี่ยวกับตำแหน่งที่รองรับสำหรับบริการนี้

ทรัพยากร REST: v1.projects.locations.backups

วิธีการ
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
ลบข้อมูลสำรอง
get GET /v1/{name=projects/*/locations/*/backups/*}
รับข้อมูลเกี่ยวกับการสำรองข้อมูล
list GET /v1/{parent=projects/*/locations/*}/backups
แสดงรายการข้อมูลสำรองทั้งหมด