Cloud Firestore API

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

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

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

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

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

ปลายทางบริการ

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

  • https://firestore.googleapis.com

ทรัพยากร REST: 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

ทรัพยากร REST: 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/*}
อัปเดตการกำหนดค่าช่อง

ทรัพยากร REST: 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
แสดงรายการดัชนีผสม

ทรัพยากร REST: 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

ทรัพยากร REST: 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
แสดงรหัสคอลเล็กชันทั้งหมดภายใต้เอกสาร
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
ทำการค้นหา

ทรัพยากร REST: 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
แสดงรายการดัชนีที่ตรงกับตัวกรองที่ระบุ

ทรัพยากร REST: 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
สร้างฐานข้อมูลใหม่โดยกู้คืนจากข้อมูลสำรองที่มีอยู่

ทรัพยากร REST: 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/*}
อัปเดตกำหนดการสำรองข้อมูล

ทรัพยากร REST: 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/*}
อัปเดตการกำหนดค่าช่อง

ทรัพยากร REST: 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
แสดงรายการดัชนีผสม

ทรัพยากร REST: 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
แสดงรหัสคอลเล็กชันทั้งหมดภายใต้เอกสาร
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
แสดงรายการการดำเนินการที่ตรงกับตัวกรองที่ระบุไว้ในคำขอ

ทรัพยากร REST: 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
แสดงรายการข้อมูลสำรองทั้งหมด