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 Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

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

リクエストの本文

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

JSON 表現 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
フィールド
collectionIds[]

string

エクスポートするコレクション ID。指定しない場合は、すべてのコレクションが使用されます。
outputUriPrefix

string

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

string

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

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

詳細については、認証の概要をご覧ください。