Cloud Firestore API

存取專為自動擴展、高效能和易於應用程式開發而建置的 NoSQL 文件資料庫。

服務:firestore.googleapis.com

若要呼叫此服務,我們建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用您自己的程式庫來呼叫此服務,請在發出 API 請求時使用以下資訊。

發現文件

發現文件是用於描述和使用 REST API 的機器可讀規格。它用於建立客戶端庫、IDE 插件以及與 Google API 互動的其他工具。一項服務可能會提供多個發現文件。該服務提供以下發現文件:

服務端點

服務端點是指定 API 服務的網路位址的基本 URL。一項服務可能有多個服務端點。本服務具有以下服務端點,且以下所有 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
列出所有備份。