Method: projects.databases.importDocuments

Importa documentos a Google Cloud Firestore. Se reemplazarán los documentos existentes con el mismo nombre. La importación se realiza en segundo plano, y su progreso se puede supervisar y administrar mediante el recurso de operación que se crea. Si se cancela una operación database.importDocuments, es posible que ya se haya importado un subconjunto de datos a Cloud Firestore.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Base de datos a la que se importará. Debe tener el formato projects/{projectId}/databases/{databaseId}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "collectionIds": [
    string
  ],
  "inputUriPrefix": string,
  "namespaceIds": [
    string
  ]
}
Campos
collectionIds[]

string

Los IDs de colecciones que se deben importar. Si no se especifica, se refiere a todas las colecciones incluidas en la importación.

inputUriPrefix

string

Ubicación de los archivos exportados Este debe coincidir con el outputUriPrefix de ExportDocumentsResponse de una exportación que se completó correctamente. Consulta: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

namespaceIds[]

string

Una lista vacía representa todos los espacios de nombres. Este es el uso preferido para las bases de datos que no utilizan espacios de nombres.

Un elemento de string vacía representa el espacio de nombres predeterminado. Se debe usar si la base de datos tiene datos en espacios de nombres no predeterminados, pero no desea incluirlos. Cada espacio de nombres de esta lista debe ser único.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.