Trang này được dịch bởi Cloud Translation API.

Cloud Firestore API

Truy cập vào cơ sở dữ liệu tài liệu NoSQL được xây dựng để tự động mở rộng quy mô, hiệu suất cao và dễ dàng phát triển ứng dụng.

Dịch vụ: firestore.googleapis.com

Để gọi dịch vụ này, bạn nên sử dụng thư viện ứng dụng do Google cung cấp. Nếu ứng dụng của bạn cần sử dụng thư viện của riêng bạn để gọi dịch vụ này, hãy sử dụng thông tin sau đây khi đưa ra yêu cầu API.

Tài liệu khám phá

Tài liệu khám phá là thông số kỹ thuật mà máy có thể đọc được để mô tả và sử dụng các API REST. Thư viện này được dùng để xây dựng thư viện ứng dụng, trình bổ trợ IDE và các công cụ khác tương tác với các API của Google. Một dịch vụ có thể cung cấp nhiều tài liệu khám phá. Dịch vụ này cung cấp các tài liệu khám phá sau:

Điểm cuối dịch vụ

Điểm cuối dịch vụ là một URL cơ sở chỉ định địa chỉ mạng của một dịch vụ API. Một dịch vụ có thể có nhiều điểm cuối dịch vụ. Dịch vụ này có điểm cuối của dịch vụ sau đây và tất cả URI bên dưới đều liên quan đến điểm cuối của dịch vụ này:

https://firestore.googleapis.com

Tài nguyên REST: v1beta2.projects.databases

Phương thức
`exportDocuments`	`POST /v1beta2/{name=projects//databases/}:exportDocuments` Xuất bản sao của tất cả hoặc một nhóm tài liệu từ Google Cloud Firestore sang một hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage.
`importDocuments`	`POST /v1beta2/{name=projects//databases/}:importDocuments` Nhập tài liệu vào Google Cloud Firestore.

Tài nguyên REST: v1beta2.projects.databases.collectionGroups.fields

Phương thức
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//fields/}` Lấy siêu dữ liệu và cấu hình cho một Trường.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/fields` Liệt kê cấu hình trường và siêu dữ liệu của cơ sở dữ liệu này.
`patch`	`PATCH /v1beta2/{field.name=projects//databases//collectionGroups//fields/}` Cập nhật cấu hình trường.

Tài nguyên REST: v1beta2.projects.databases.collectionGroups.indexes

Phương thức
`create`	`POST /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Tạo chỉ mục tổng hợp.
`delete`	`DELETE /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Xoá chỉ mục tổng hợp.
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Lấy chỉ mục tổng hợp.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Liệt kê các chỉ mục tổng hợp.

Tài nguyên REST: v1beta1.projects.databases

Phương thức
`exportDocuments`	`POST /v1beta1/{name=projects//databases/}:exportDocuments` Xuất bản sao của tất cả hoặc một nhóm tài liệu từ Google Cloud Firestore sang một hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage.
`importDocuments`	`POST /v1beta1/{name=projects//databases/}:importDocuments` Nhập tài liệu vào Google Cloud Firestore.

Tài nguyên REST: v1beta1.projects.databases.documents

Phương thức
`batchGet`	`POST /v1beta1/{database=projects//databases/}/documents:batchGet` Lấy nhiều tài liệu.
`batchWrite`	`POST /v1beta1/{database=projects//databases/}/documents:batchWrite` Áp dụng một loạt các thao tác ghi.
`beginTransaction`	`POST /v1beta1/{database=projects//databases/}/documents:beginTransaction` Bắt đầu một giao dịch mới.
`commit`	`POST /v1beta1/{database=projects//databases/}/documents:commit` Cam kết giao dịch, đồng thời cập nhật tài liệu (không bắt buộc).
`createDocument`	`POST /v1beta1/{parent=projects//databases//documents/**}/{collectionId}` Tạo tài liệu mới.
`delete`	`DELETE /v1beta1/{name=projects//databases//documents//*}` Xoá một tài liệu.
`get`	`GET /v1beta1/{name=projects//databases//documents//*}` Lấy một tài liệu.
`list`	`GET /v1beta1/{parent=projects//databases//documents//*}/{collectionId}` Liệt kê các tài liệu.
`listCollectionIds`	`POST /v1beta1/{parent=projects//databases//documents}:listCollectionIds` Liệt kê tất cả mã bộ sưu tập bên dưới một tài liệu.
`listDocuments`	`GET /v1beta1/{parent=projects//databases//documents}/{collectionId}` Liệt kê các tài liệu.
`partitionQuery`	`POST /v1beta1/{parent=projects//databases//documents}:partitionQuery` Phân vùng một truy vấn bằng cách trả về các con trỏ phân vùng có thể dùng để chạy truy vấn song song.
`patch`	`PATCH /v1beta1/{document.name=projects//databases//documents//*}` Cập nhật hoặc chèn một tài liệu.
`rollback`	`POST /v1beta1/{database=projects//databases/}/documents:rollback` Khôi phục giao dịch.
`runAggregationQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runAggregationQuery` Chạy một truy vấn tổng hợp.
`runQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runQuery` Chạy một truy vấn.

Tài nguyên REST: v1beta1.projects.databases.indexes

Phương thức
`create`	`POST /v1beta1/{parent=projects//databases/}/indexes` Tạo chỉ mục được chỉ định.
`delete`	`DELETE /v1beta1/{name=projects//databases//indexes/*}` Xoá chỉ mục.
`get`	`GET /v1beta1/{name=projects//databases//indexes/*}` Lấy chỉ mục.
`list`	`GET /v1beta1/{parent=projects//databases/}/indexes` Liệt kê các chỉ mục khớp với bộ lọc đã chỉ định.

Tài nguyên REST: v1.projects.databases

Phương thức
`create`	`POST /v1/{parent=projects/*}/databases` Tạo cơ sở dữ liệu.
`delete`	`DELETE /v1/{name=projects//databases/}` Xoá cơ sở dữ liệu.
`exportDocuments`	`POST /v1/{name=projects//databases/}:exportDocuments` Xuất bản sao của tất cả hoặc một nhóm tài liệu từ Google Cloud Firestore sang một hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage.
`get`	`GET /v1/{name=projects//databases/}` Lấy thông tin về cơ sở dữ liệu.
`importDocuments`	`POST /v1/{name=projects//databases/}:importDocuments` Nhập tài liệu vào Google Cloud Firestore.
`list`	`GET /v1/{parent=projects/*}/databases` Liệt kê tất cả cơ sở dữ liệu trong dự án.
`patch`	`PATCH /v1/{database.name=projects//databases/}` Cập nhật một cơ sở dữ liệu.
`restore`	`POST /v1/{parent=projects/*}/databases:restore` Tạo cơ sở dữ liệu mới bằng cách khôi phục từ bản sao lưu hiện có.

Tài nguyên REST: v1.projects.databases.backupSchedules

Phương thức
`create`	`POST /v1/{parent=projects//databases/}/backupSchedules` Tạo lịch sao lưu trên cơ sở dữ liệu.
`delete`	`DELETE /v1/{name=projects//databases//backupSchedules/*}` Xoá lịch biểu sao lưu.
`get`	`GET /v1/{name=projects//databases//backupSchedules/*}` Nhận thông tin về lịch biểu sao lưu.
`list`	`GET /v1/{parent=projects//databases/}/backupSchedules` Liệt kê lịch sao lưu.
`patch`	`PATCH /v1/{backupSchedule.name=projects//databases//backupSchedules/*}` Cập nhật lịch sao lưu.

Tài nguyên REST: v1.projects.databases.collectionGroups.fields

Phương thức
`get`	`GET /v1/{name=projects//databases//collectionGroups//fields/}` Lấy siêu dữ liệu và cấu hình cho một Trường.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/fields` Liệt kê cấu hình trường và siêu dữ liệu của cơ sở dữ liệu này.
`patch`	`PATCH /v1/{field.name=projects//databases//collectionGroups//fields/}` Cập nhật cấu hình trường.

Tài nguyên REST: v1.projects.databases.collectionGroups.indexes

Phương thức
`create`	`POST /v1/{parent=projects//databases//collectionGroups/*}/indexes` Tạo chỉ mục tổng hợp.
`delete`	`DELETE /v1/{name=projects//databases//collectionGroups//indexes/}` Xoá chỉ mục tổng hợp.
`get`	`GET /v1/{name=projects//databases//collectionGroups//indexes/}` Lấy chỉ mục tổng hợp.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/indexes` Liệt kê các chỉ mục tổng hợp.

Tài nguyên REST: v1.projects.databases.documents

Phương thức
`batchGet`	`POST /v1/{database=projects//databases/}/documents:batchGet` Lấy nhiều tài liệu.
`batchWrite`	`POST /v1/{database=projects//databases/}/documents:batchWrite` Áp dụng một loạt các thao tác ghi.
`beginTransaction`	`POST /v1/{database=projects//databases/}/documents:beginTransaction` Bắt đầu một giao dịch mới.
`commit`	`POST /v1/{database=projects//databases/}/documents:commit` Cam kết giao dịch, đồng thời cập nhật tài liệu (không bắt buộc).
`createDocument`	`POST /v1/{parent=projects//databases//documents/**}/{collectionId}` Tạo tài liệu mới.
`delete`	`DELETE /v1/{name=projects//databases//documents//*}` Xoá một tài liệu.
`get`	`GET /v1/{name=projects//databases//documents//*}` Lấy một tài liệu.
`list`	`GET /v1/{parent=projects//databases//documents//*}/{collectionId}` Liệt kê các tài liệu.
`listCollectionIds`	`POST /v1/{parent=projects//databases//documents}:listCollectionIds` Liệt kê tất cả mã bộ sưu tập bên dưới một tài liệu.
`listDocuments`	`GET /v1/{parent=projects//databases//documents}/{collectionId}` Liệt kê các tài liệu.
`partitionQuery`	`POST /v1/{parent=projects//databases//documents}:partitionQuery` Phân vùng một truy vấn bằng cách trả về các con trỏ phân vùng có thể dùng để chạy truy vấn song song.
`patch`	`PATCH /v1/{document.name=projects//databases//documents//*}` Cập nhật hoặc chèn một tài liệu.
`rollback`	`POST /v1/{database=projects//databases/}/documents:rollback` Khôi phục giao dịch.
`runAggregationQuery`	`POST /v1/{parent=projects//databases//documents}:runAggregationQuery` Chạy một truy vấn tổng hợp.
`runQuery`	`POST /v1/{parent=projects//databases//documents}:runQuery` Chạy một truy vấn.

Tài nguyên REST: v1.projects.databases.operations

Phương thức
`cancel`	`POST /v1/{name=projects//databases//operations/*}:cancel` Bắt đầu quá trình huỷ không đồng bộ đối với một hoạt động diễn ra trong thời gian dài.
`delete`	`DELETE /v1/{name=projects//databases//operations/*}` Xoá một thao tác diễn ra trong thời gian dài.
`get`	`GET /v1/{name=projects//databases//operations/*}` Nhận trạng thái mới nhất của một hoạt động diễn ra trong thời gian dài.
`list`	`GET /v1/{name=projects//databases/}/operations` Liệt kê các thao tác khớp với bộ lọc đã chỉ định trong yêu cầu.

Tài nguyên REST: v1.projects.locations

Phương thức
`get`	`GET /v1/{name=projects//locations/}` Nhận thông tin về vị trí.
`list`	`GET /v1/{name=projects/*}/locations` Liệt kê thông tin về các vị trí hỗ trợ dịch vụ này.

Tài nguyên REST: v1.projects.locations.backups

Phương thức
`delete`	`DELETE /v1/{name=projects//locations//backups/*}` Xoá một bản sao lưu.
`get`	`GET /v1/{name=projects//locations//backups/*}` Nhận thông tin về bản sao lưu.
`list`	`GET /v1/{parent=projects//locations/}/backups` Liệt kê tất cả bản sao lưu.