Method: projects.databases.importDocuments

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

HTTPリクエスト

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

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

パスパラメータ

パラメーター
name

string

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

リクエストボディ

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

JSON表現
{
  "collectionIds": [
    string
  ],
  "inputUriPrefix": string
}
田畑
collectionIds[]

string

どのコレクション ID をインポートするか。 「未指定」とは、インポートに含まれるすべてのコレクションを意味します。

inputUriPrefix

string

エクスポートされたファイルの場所。これは、正常に完了したエクスポートからの ExportDocumentsResponse の OutputUriPrefix と一致する必要があります。参照: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix

レスポンスボディ

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

認可範囲

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

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

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