Method: projects.databases.exportDocuments

ドキュメントのすべてまたはサブセットのコピーを Google Cloud Firestore から別のストレージ システム (Google Cloud Storage など) にエクスポートします。ドキュメントに対する最近の更新がエクスポートに反映されない場合があります。エクスポートはバックグラウンドで実行され、その進行状況は、作成された操作リソースを介して監視および管理できます。エクスポートの出力は、関連する操作が完了した後にのみ使用できます。エクスポート操作が完了前にキャンセルされると、部分的なデータが Google Cloud Storage に残る可能性があります。

HTTPリクエスト

POST https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*}:exportDocuments

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
name

string

エクスポートするデータベース。形式は、 projects/{projectId}/databases/{databaseId}である必要があります。

リクエストボディ

リクエスト本文には、次の構造のデータが含まれます。

JSON表現
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
田畑
collectionIds[]

string

どのコレクション ID をエクスポートするか。 「未指定」とは、すべてのコレクションを意味します。

outputUriPrefix

string

出力 URI。現在、次の形式の Google Cloud Storage URI のみをサポートしています: gs://BUCKET_NAME[/NAMESPACE_PATH] BUCKET_NAMEは Google Cloud Storage バケットの名前、 NAMESPACE_PATHはオプションの Google Cloud Storage 名前空間のパスです。名前を選択するときは、Google Cloud Storage の命名ガイドライン ( https://cloud.google.com/storage/docs/naming ) を必ず考慮してください。 URI がバケット (名前空間パスなし) の場合、開始時刻に基づいてプレフィックスが生成されます。

レスポンスボディ

成功した場合、応答本文にはOperationのインスタンスが含まれます。

認可範囲

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

詳細については、 「認証の概要」を参照してください。