Method: projects.databases.importDocuments

Mengimpor dokumen ke Google Cloud Firestore. Dokumen yang ada dengan nama yang sama akan ditimpa. Impor terjadi di latar belakang dan progresnya dapat dipantau serta dikelola melalui resource Operation yang dibuat. Jika operasi database.importDocuments dibatalkan, ada kemungkinan sebagian data telah diimpor ke Cloud Firestore.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Database yang akan diimpor. Harus dalam bentuk: projects/{projectId}/databases/{databaseId}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "collectionIds": [
    string
  ],
  "inputUriPrefix": string,
  "namespaceIds": [
    string
  ]
}
Kolom
collectionIds[]

string

ID koleksi yang akan diimpor. Tidak ditentukan berarti semua koleksi yang disertakan dalam impor.

inputUriPrefix

string

Lokasi file yang diekspor. Nilai ini harus cocok dengan outputUriPrefix dari ExportDocumentsResponse dari ekspor yang telah berhasil diselesaikan. Lihat: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

namespaceIds[]

string

Daftar kosong mewakili semua namespace. Ini adalah penggunaan yang disarankan untuk database yang tidak menggunakan namespace.

Elemen string kosong mewakili namespace default. Ini harus digunakan jika database memiliki data dalam namespace non-default, tetapi tidak ingin menyertakannya. Setiap namespace dalam daftar ini harus unik.

Isi respons

Jika berhasil, isi respons akan berisi instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.