Method: projects.databases.exportDocuments

Google Cloud Firestore'daki dokümanların tümünün veya bir alt kümesinin kopyasını Google Cloud Storage gibi başka bir depolama sistemine aktarır. Dokümanlarda yapılan son güncellemeler dışa aktarma işlemine yansıtılmayabilir. Dışa aktarma işlemi arka planda gerçekleşir ve ilerleme durumu, oluşturulan işlem kaynağıyla izlenip yönetilebilir. Dışa aktarma çıkışı, yalnızca ilişkili işlem tamamlandığında kullanılabilir. Bir dışa aktarma işlemi tamamlanmadan önce iptal edilirse kısmi veriler Google Cloud Storage'da kalabilir.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
name

string

Dışa aktarılacak veritabanı. projects/{projectId}/databases/{databaseId} biçiminde olmalıdır.

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:

JSON gösterimi
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
Alanlar
collectionIds[]

string

Dışa aktarılacak koleksiyon kimlikleri. Belirtilmemiş ifadesi, tüm koleksiyonlar anlamına gelir.

outputUriPrefix

string

Çıkış URI'sı. Şu anda yalnızca gs://BUCKET_NAME[/NAMESPACE_PATH] biçimindeki Google Cloud Storage URI'ları desteklenir. Burada BUCKET_NAME Google Cloud Storage paketinin adıdır ve NAMESPACE_PATH isteğe bağlı bir Google Cloud Storage ad alanı yoludur. Ad seçerken Google Cloud Storage adlandırma yönergelerini göz önünde bulundurmayı unutmayın: https://cloud.google.com/storage/docs/naming. URI bir paketse (ad alanı yolu olmayan) başlangıç zamanına göre bir önek oluşturulur.

Yanıt gövdesi

Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış sayfasına göz atın.