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 Transcoding 構文を使用します。
パスパラメータ
パラメータ |
name |
string
エクスポートするデータベース。形式は projects/{projectId}/databases/{databaseId} です。
|
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
{
"collectionIds": [
string
],
"outputUriPrefix": 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 がバケット(名前空間パスなし)の場合、開始時間に基づいて接頭辞が生成されます。
|
レスポンスの本文
成功した場合、レスポンスの本文には Operation
のインスタンスが含まれます。
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要をご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-04-12 UTC。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"必要な情報がない"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"複雑すぎる / 手順が多すぎる"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"最新ではない"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻訳に関する問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"サンプル / コードに問題がある"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"その他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"わかりやすい"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"問題の解決に役立った"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"その他"
}]