本頁面由 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` 個列出所有備份。