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

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

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

レスポンスの本文

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

認可スコープ

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

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

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