Method: projects.databases.importDocuments

Importa documentos para o Google Cloud Firestore. Os documentos existentes com o mesmo nome serão substituídos. A importação ocorre em segundo plano, e o progresso dela pode ser monitorado e gerenciado pelo recurso de operação criado. Se uma operação database.importDocuments for cancelada, é possível que um subconjunto dos dados já tenha sido importado para o Cloud Firestore.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Banco de dados para onde importar. Precisa estar no formato: projects/{projectId}/databases/{databaseId}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "collectionIds": [
    string
  ],
  "inputUriPrefix": string,
  "namespaceIds": [
    string
  ]
}
Campos
collectionIds[]

string

Os IDs de coleções a serem importados. Não especificado significa que todas as coleções incluídas na importação.

inputUriPrefix

string

Local dos arquivos exportados. Ele precisa corresponder ao outputUriPrefix de um ExportDocumentsResponse de uma exportação concluída. Consulte: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

namespaceIds[]

string

Uma lista vazia representa todos os namespaces. Esse é o uso preferencial para bancos de dados que não usam namespaces.

Um elemento de string vazio representa o namespace padrão. Isso deve ser usado se o banco de dados tiver dados em namespaces não padrão, mas não quiser incluí-los. Cada namespace nessa lista precisa ser exclusivo.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.