自動スケーリング、高パフォーマンス、アプリケーション開発の容易さのために構築された NoSQL ドキュメント データベースにアクセスします。
サービス: firestore.googleapis.com
このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをお勧めします。アプリケーションが独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストを行うときに次の情報を使用します。
発見文書
Discovery Document は、 REST API を記述および使用するための機械可読仕様です。これは、クライアント ライブラリ、IDE プラグイン、および Google API と対話するその他のツールを構築するために使用されます。 1 つのサービスが複数の検出ドキュメントを提供する場合があります。このサービスは、次の検出ドキュメントを提供します。
サービスエンドポイント
サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。 1 つのサービスに複数のサービス エンドポイントがある場合があります。このサービスには次のサービス エンドポイントがあり、以下のすべての 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 すべてのバックアップを一覧表示します。 |