Method: projects.databases.exportDocuments

Google Cloud Firestore에서 문서의 전체 또는 하위 집합 사본을 다른 스토리지 시스템(예: Google Cloud Storage)으로 내보냅니다. 문서의 최근 업데이트가 내보내기에 반영되지 않을 수 있습니다. 내보내기는 백그라운드에서 실행되며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. 내보내기 출력은 연결된 작업이 완료된 후에만 사용할 수 있습니다. 내보내기 작업이 완료 전에 취소되면 Google Cloud Storage에 일부 데이터가 남아 있을 수 있습니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
name

string

내보낼 데이터베이스입니다. projects/{projectId}/databases/{databaseId} 형식이어야 합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
필드
collectionIds[]

string

내보낼 컬렉션 ID입니다. '지정되지 않음'은 모든 컬렉션을 의미합니다.
outputUriPrefix

string

출력 URI입니다. 현재는 gs://BUCKET_NAME[/NAMESPACE_PATH] 형식의 Google Cloud Storage URI만 지원합니다. 여기서 BUCKET_NAME은 Google Cloud Storage 버킷의 이름이고 NAMESPACE_PATH은 선택적 Google Cloud Storage 네임스페이스 경로입니다. 이름을 선택할 때는 Google Cloud Storage 이름 지정 가이드라인(https://cloud.google.com/storage/docs/naming)을 고려하세요. URI가 네임스페이스 경로가 없는 버킷인 경우 시작 시간을 기준으로 프리픽스가 생성됩니다.

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 인증 개요를 참조하세요.