Cloud Firestore API

자동 확장, 고성능 및 간편한 애플리케이션 개발을 위해 구축 된 NoSQL 문서 데이터베이스에 액세스합니다.

서비스 : firestore.googleapis.com

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

발견 문서

Discovery Document 는 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` 복합 색인을 나열합니다.

서비스 : firestore.googleapis.com

발견 문서

서비스 엔드 포인트

https://firestore.googleapis.com

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를 나열합니다.
`partitionQuery`	`POST /v1beta1/{parent=projects//databases//documents}:partitionQuery` 쿼리를 병렬로 실행하는 데 사용할 수있는 파티션 커서를 반환하여 쿼리를 파티션합니다.
`patch`	`PATCH /v1beta1/{document.name=projects//databases//documents//*}` 문서를 업데이트하거나 삽입합니다.
`rollback`	`POST /v1beta1/{database=projects//databases/}/documents:rollback` 트랜잭션을 롤백합니다.
`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` 지정된 필터와 일치하는 인덱스를 나열합니다.

서비스 : firestore.googleapis.com

발견 문서

서비스 엔드 포인트

https://firestore.googleapis.com

REST 리소스 : v1.projects.databases

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

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를 나열합니다.
`partitionQuery`	`POST /v1/{parent=projects//databases//documents}:partitionQuery` 쿼리를 병렬로 실행하는 데 사용할 수있는 파티션 커서를 반환하여 쿼리를 파티션합니다.
`patch`	`PATCH /v1/{document.name=projects//databases//documents//*}` 문서를 업데이트하거나 삽입합니다.
`rollback`	`POST /v1/{database=projects//databases/}/documents:rollback` 트랜잭션을 롤백합니다.
`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` 이 서비스에 대해 지원되는 위치에 대한 정보를 나열합니다.