本頁面由 Cloud Translation API 翻譯而成。

Cloud Firestore API

特別打造的 NoSQL 文件資料庫，可自動調整資源配置、發揮優異效能並簡化應用程式開發作業。

服務：firestore.googleapis.com

如要呼叫這項服務，建議您使用 Google 提供的用戶端程式庫。如果應用程式需要使用您自己的程式庫來呼叫這項服務，請在提出 API 要求時使用下列資訊。

探索文件

探索文件是一種機器可解讀的規格，用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式，以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。此服務提供下列探索文件：

服務端點

服務端點是指定 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` 列出文件下方所有集合 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` 執行查詢。

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` 列出文件下方所有集合 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` 列出符合要求中指定篩選器的作業。

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` 列出所有備份。