このページは Cloud Translation API によって翻訳されました。

Cloud Firestore API

自動スケーリングと高性能を実現し、アプリケーション開発を簡素化するように構築された NoSQL ドキュメントデータベースにアクセスします。

サービス: firestore.googleapis.com

このサービスを呼び出すには、Google が提供するクライアントライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリドキュメント

ディスカバリドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアントライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリドキュメントを提供できます。このサービスでは、次のディスカバリドキュメントが用意されています。

サービスエンドポイント

サービスエンドポイントは、API サービスのネットワークアドレスを指定するベース URL です。1 つのサービスに複数のサービスエンドポイントが存在することがあります。このサービスには次のサービスエンドポイントがあり、以下のすべての URI がこのサービスエンドポイントに関連しています。

https://firestore.googleapis.com

REST リソース: v1beta2.projects.databases

Methods
`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

Methods
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//fields/}` Field のメタデータと構成を取得します。
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/fields` このデータベースのフィールド構成とメタデータを一覧表示します。
`patch`	`PATCH /v1beta2/{field.name=projects//databases//collectionGroups//fields/}` フィールド構成を更新します。

REST リソース: v1beta2.projects.databases.collectionGroups.indexes

Methods
`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

Methods
`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

Methods
`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` 必要に応じてドキュメントを更新します。トランザクションを 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

Methods
`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

Methods
`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

Methods
`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

Methods
`get`	`GET /v1/{name=projects//databases//collectionGroups//fields/}` Field のメタデータと構成を取得します。
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/fields` このデータベースのフィールド構成とメタデータを一覧表示します。
`patch`	`PATCH /v1/{field.name=projects//databases//collectionGroups//fields/}` フィールド構成を更新します。

REST リソース: v1.projects.databases.collectionGroups.indexes

Methods
`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

Methods
`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` 必要に応じてドキュメントを更新します。トランザクションを 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

Methods
`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

Methods
`delete`	`DELETE /v1/{name=projects//locations//backups/*}` バックアップを削除します。
`get`	`GET /v1/{name=projects//locations//backups/*}` バックアップに関する情報を取得します。
`list`	`GET /v1/{parent=projects//locations/}/backups` すべてのバックアップを一覧表示します。