Method: projects.databases.exportDocuments

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

エクスポートの動作と出力形式の詳細については、https: //cloud.google.com/firestore/docs/manage-data/export-importを参照してください。

HTTPリクエスト

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

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

パスパラメータ

パラメーター
name

string

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

リクエストボディ

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

JSON表現
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": 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 がバケット (名前空間パスなし) の場合、開始時刻に基づいてプレフィックスが生成されます。

namespaceIds[]

string

空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースの場合に推奨される使用法です。

空の文字列要素はデフォルトの名前空間を表します。これは、データベースにデフォルト以外の名前空間にデータがあるが、それらを含めたくない場合に使用する必要があります。このリスト内の各名前空間は一意である必要があります。

snapshotTime

string ( Timestamp format)

エクスポートするデータベースのバージョンに対応するタイムスタンプ。タイムスタンプは分単位に四捨五入され、 earliestVersionTimeより古いものでなければなりません。指定した場合、エクスポートされたドキュメントは、指定された時点でのデータベースの一貫したビューを表します。そうしないと、エクスポートされたドキュメントの一貫性が保証されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

レスポンスボディ

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

認可範囲

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

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

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