Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1338139174.7 KB
projects

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

post/v1/{+name}:importDocuments

Path parameters

namestring required

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

Request body

namespaceIdsstring[]

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

inputUriPrefixstring

Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

collectionIdsstring[]

IDs of the collection groups to import. Unspecified means all collection groups that were included in the export. Each collection group in this list must be unique.

Response

Successful response