Cloud Firestore API

자동 확장, 고성능, 간편한 애플리케이션 개발을 위해 설계된 NoSQL 문서 데이터베이스를 이용하세요.

서비스: firestore.googleapis.com

이 서비스를 호출하려면 Google에서 제공하는 클라이언트 라이브러리를 사용하는 것이 좋습니다. 애플리케이션에서 자체 라이브러리를 사용하여 이 서비스를 호출해야 한다면 API를 요청할 때 다음 정보를 사용하세요.

검색 문서

검색 문서는 머신에서 읽을 수 있는 사양이며 REST API를 설명하고 사용하는 데 참조할 수 있습니다. 또한 클라이언트 라이브러리, IDE 플러그인, 기타 Google API와 상호작용하는 도구를 빌드하는 데 사용됩니다. 하나의 서비스는 여러 개의 검색 문서를 제공할 수 있습니다. 이 서비스는 다음 검색 문서를 제공합니다.

서비스 엔드포인트

서비스 엔드포인트는 API 서비스의 네트워크 주소를 지정하는 기본 URL입니다. 하나의 서비스에 여러 서비스 엔드포인트가 있을 수 있습니다. 이 서비스에는 다음 서비스 엔드포인트가 포함되고, 그 아래의 모든 URI가 이 서비스 엔드포인트와 관련됩니다.

  • https://firestore.googleapis.com

REST 리소스: v1beta2.projects.databases

방법
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
Google Cloud Firestore에서 Google Cloud Storage와 같은 다른 스토리지 시스템으로 문서 전체 또는 일부의 사본을 내보냅니다.
importDocuments POST /v1beta2/{name=projects/*/databases/*}:importDocuments
Google Cloud Firestore로 문서를 가져옵니다.

REST 리소스: v1beta2.projects.databases.collectionGroups.fields

방법
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}
필드의 메타데이터 및 구성을 가져옵니다.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
이 데이터베이스의 필드 구성 및 메타데이터를 나열합니다.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
필드 구성을 업데이트합니다.

REST 리소스: v1beta2.projects.databases.collectionGroups.indexes

방법
create POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
복합 색인을 만듭니다.
delete DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
복합 색인을 삭제합니다.
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
복합 색인을 가져옵니다.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
복합 색인을 나열합니다.

REST 리소스: v1beta1.projects.databases

방법
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
Google Cloud Firestore에서 Google Cloud Storage와 같은 다른 스토리지 시스템으로 문서 전체 또는 일부의 사본을 내보냅니다.
importDocuments POST /v1beta1/{name=projects/*/databases/*}:importDocuments
Google Cloud Firestore로 문서를 가져옵니다.

REST 리소스: v1beta1.projects.databases.documents

방법
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
여러 문서를 가져옵니다.
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
일괄 쓰기 작업을 적용합니다.
beginTransaction POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction
새 트랜잭션을 시작합니다.
commit POST /v1beta1/{database=projects/*/databases/*}/documents:commit
트랜잭션을 커밋하며 선택적으로 문서를 업데이트합니다.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
새 문서를 만듭니다.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
문서를 삭제합니다.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
단일 문서를 가져옵니다.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
문서를 나열합니다.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
문서 아래에 있는 모든 컬렉션 ID를 나열합니다.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
문서를 나열합니다.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
쿼리를 병렬로 실행하는 데 사용할 수 있는 파티션 커서를 반환하여 쿼리 파티션을 나눕니다.
patch PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}
문서를 업데이트하거나 삽입합니다.
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
트랜잭션을 롤백합니다.
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
집계 쿼리를 실행합니다.
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
쿼리를 실행합니다.

REST 리소스: v1beta1.projects.databases.indexes

방법
create POST /v1beta1/{parent=projects/*/databases/*}/indexes
지정된 색인을 만듭니다.
delete DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}
색인을 삭제합니다.
get GET /v1beta1/{name=projects/*/databases/*/indexes/*}
색인을 가져옵니다.
list GET /v1beta1/{parent=projects/*/databases/*}/indexes
지정된 필터와 일치하는 색인을 나열합니다.

REST 리소스: v1.projects.databases

방법
create POST /v1/{parent=projects/*}/databases
데이터베이스를 만듭니다.
delete DELETE /v1/{name=projects/*/databases/*}
데이터베이스를 삭제합니다.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Google Cloud Firestore에서 Google Cloud Storage와 같은 다른 스토리지 시스템으로 문서 전체 또는 일부의 사본을 내보냅니다.
get GET /v1/{name=projects/*/databases/*}
데이터베이스에 대한 정보를 가져옵니다.
importDocuments POST /v1/{name=projects/*/databases/*}:importDocuments
Google Cloud Firestore로 문서를 가져옵니다.
list GET /v1/{parent=projects/*}/databases
프로젝트의 모든 데이터베이스를 나열합니다.
patch PATCH /v1/{database.name=projects/*/databases/*}
데이터베이스를 업데이트합니다.
restore POST /v1/{parent=projects/*}/databases:restore
기존 백업에서 복원하여 새 데이터베이스를 만듭니다.

REST 리소스: v1.projects.databases.backupSchedules

방법
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
데이터베이스에 백업 일정을 만듭니다.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
백업 일정을 삭제합니다.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
백업 일정 정보를 가져옵니다.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
백업 일정을 나열합니다.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
백업 일정을 업데이트합니다.

REST 리소스: v1.projects.databases.collectionGroups.fields

방법
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
필드의 메타데이터 및 구성을 가져옵니다.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
이 데이터베이스의 필드 구성 및 메타데이터를 나열합니다.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
필드 구성을 업데이트합니다.

REST 리소스: v1.projects.databases.collectionGroups.indexes

방법
create POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
복합 색인을 만듭니다.
delete DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
복합 색인을 삭제합니다.
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
복합 색인을 가져옵니다.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
복합 색인을 나열합니다.

REST 리소스: v1.projects.databases.documents

방법
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
여러 문서를 가져옵니다.
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
일괄 쓰기 작업을 적용합니다.
beginTransaction POST /v1/{database=projects/*/databases/*}/documents:beginTransaction
새 트랜잭션을 시작합니다.
commit POST /v1/{database=projects/*/databases/*}/documents:commit
트랜잭션을 커밋하며 선택적으로 문서를 업데이트합니다.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
새 문서를 만듭니다.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
문서를 삭제합니다.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
단일 문서를 가져옵니다.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
문서를 나열합니다.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
문서 아래에 있는 모든 컬렉션 ID를 나열합니다.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
문서를 나열합니다.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
쿼리를 병렬로 실행하는 데 사용할 수 있는 파티션 커서를 반환하여 쿼리 파티션을 나눕니다.
patch PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}
문서를 업데이트하거나 삽입합니다.
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
트랜잭션을 롤백합니다.
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
집계 쿼리를 실행합니다.
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
쿼리를 실행합니다.

REST 리소스: v1.projects.databases.operations

방법
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
장기 실행 작업에 대한 비동기 취소를 시작합니다.
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
장기 실행 작업을 삭제합니다.
get GET /v1/{name=projects/*/databases/*/operations/*}
장기 실행 작업의 최신 상태를 가져옵니다.
list GET /v1/{name=projects/*/databases/*}/operations
요청에 지정된 필터와 일치하는 작업을 나열합니다.

REST 리소스: v1.projects.locations

메서드
get GET /v1/{name=projects/*/locations/*}
위치 정보를 가져옵니다.
list GET /v1/{name=projects/*}/locations
이 서비스에 지원되는 위치 정보를 나열합니다.

REST 리소스: v1.projects.locations.backups

방법
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
백업을 삭제합니다.
get GET /v1/{name=projects/*/locations/*/backups/*}
백업 정보를 가져옵니다.
list GET /v1/{parent=projects/*/locations/*}/backups
모든 백업을 나열합니다.