Method: projects.databases.importDocuments

ドキュメントを Google Cloud Firestore にインポートします。同じ名前の既存のドキュメントは上書きされます。インポートはバックグラウンドで行われ、その進行状況は作成されたオペレーション リソースを介してモニタリングおよび管理できます。databases.importDocuments オペレーションがキャンセルされた場合、データのサブセットがすでに Cloud Firestore にインポートされている可能性があります。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。インポート先のデータベース。形式は projects/{projectId}/databases/{databaseId} です。

リクエスト本文

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

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

string

インポートするコレクション ID。指定しない場合、インポートに含まれるすべてのコレクションが対象となります。

inputUriPrefix

string

エクスポートされたファイルの場所。これは、正常に完了したエクスポートからの ExportDocumentsResponse の outputUriPrefix と一致する必要があります。詳しくは、google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix をご覧ください。

namespaceIds[]

string

空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースに適しています。

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

レスポンスの本文

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

承認スコープ

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

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

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