Esta página foi traduzida pela API Cloud Translation.

Cloud Firestore API

Acessa o banco de dados de documentos NoSQL criado para oferecer escalonamento automático, alto desempenho e facilidade no desenvolvimento de aplicativos.

Serviço: firestore.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço apresenta os documentos de descoberta abaixo:

Endpoint de serviço

Um endpoint de serviço é um URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

https://firestore.googleapis.com

Recurso REST: v1beta2.projects.databases

Métodos
`exportDocuments`	`POST /v1beta2/{name=projects//databases/}:exportDocuments` Exporta uma cópia de todos ou um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage.
`importDocuments`	`POST /v1beta2/{name=projects//databases/}:importDocuments` Importa documentos para o Google Cloud Firestore.

Recurso REST: v1beta2.projects.databases.collectionGroups.fields

Métodos
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//fields/}` Recebe os metadados e a configuração de um campo.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/fields` Lista a configuração de campo e os metadados para este banco de dados.
`patch`	`PATCH /v1beta2/{field.name=projects//databases//collectionGroups//fields/}` Atualiza uma configuração de campo.

Recurso REST: v1beta2.projects.databases.collectionGroups.indexes

Métodos
`create`	`POST /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Cria um índice composto.
`delete`	`DELETE /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Exclui um índice composto.
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Recebe um índice composto.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Lista índices compostos.

Recurso REST: v1beta1.projects.databases

Métodos
`exportDocuments`	`POST /v1beta1/{name=projects//databases/}:exportDocuments` Exporta uma cópia de todos ou um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage.
`importDocuments`	`POST /v1beta1/{name=projects//databases/}:importDocuments` Importa documentos para o Google Cloud Firestore.

Recurso REST: v1beta1.projects.databases.documents

Métodos
`batchGet`	`POST /v1beta1/{database=projects//databases/}/documents:batchGet` Recebe vários documentos.
`batchWrite`	`POST /v1beta1/{database=projects//databases/}/documents:batchWrite` Aplica um lote de operações de gravação.
`beginTransaction`	`POST /v1beta1/{database=projects//databases/}/documents:beginTransaction` Inicia uma nova transação.
`commit`	`POST /v1beta1/{database=projects//databases/}/documents:commit` Confirma uma transação e, opcionalmente, atualiza documentos.
`createDocument`	`POST /v1beta1/{parent=projects//databases//documents/**}/{collectionId}` Cria um documento.
`delete`	`DELETE /v1beta1/{name=projects//databases//documents//*}` Exclui um documento.
`get`	`GET /v1beta1/{name=projects//databases//documents//*}` Recebe um único documento.
`list`	`GET /v1beta1/{parent=projects//databases//documents//*}/{collectionId}` Lista os documentos.
`listCollectionIds`	`POST /v1beta1/{parent=projects//databases//documents}:listCollectionIds` Lista todos os IDs de coleções abaixo de um documento.
`listDocuments`	`GET /v1beta1/{parent=projects//databases//documents}/{collectionId}` Lista os documentos.
`partitionQuery`	`POST /v1beta1/{parent=projects//databases//documents}:partitionQuery` Particiona uma consulta retornando cursores de partição que podem ser usados para executar a consulta em paralelo.
`patch`	`PATCH /v1beta1/{document.name=projects//databases//documents//*}` Atualiza ou insere um documento.
`rollback`	`POST /v1beta1/{database=projects//databases/}/documents:rollback` Reverte uma transação.
`runAggregationQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runAggregationQuery` Executa uma consulta de agregação.
`runQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runQuery` Executa uma consulta.

Recurso REST: v1beta1.projects.databases.indexes

Métodos
`create`	`POST /v1beta1/{parent=projects//databases/}/indexes` Cria o índice especificado.
`delete`	`DELETE /v1beta1/{name=projects//databases//indexes/*}` Exclui um índice.
`get`	`GET /v1beta1/{name=projects//databases//indexes/*}` Recebe um índice.
`list`	`GET /v1beta1/{parent=projects//databases/}/indexes` Lista os índices que correspondem aos filtros especificados.

Recurso REST: v1.projects.databases

Métodos
`create`	`POST /v1/{parent=projects/*}/databases` Criar um banco de dados.
`delete`	`DELETE /v1/{name=projects//databases/}` Exclui um banco de dados.
`exportDocuments`	`POST /v1/{name=projects//databases/}:exportDocuments` Exporta uma cópia de todos ou um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage.
`get`	`GET /v1/{name=projects//databases/}` Extrai informações sobre um banco de dados.
`importDocuments`	`POST /v1/{name=projects//databases/}:importDocuments` Importa documentos para o Google Cloud Firestore.
`list`	`GET /v1/{parent=projects/*}/databases` Liste todos os bancos de dados no projeto.
`patch`	`PATCH /v1/{database.name=projects//databases/}` Atualiza um banco de dados.
`restore`	`POST /v1/{parent=projects/*}/databases:restore` Cria um novo banco de dados restaurando a partir de um backup atual.

Recurso REST: v1.projects.databases.backupSchedules

Métodos
`create`	`POST /v1/{parent=projects//databases/}/backupSchedules` Cria uma programação de backup em um banco de dados.
`delete`	`DELETE /v1/{name=projects//databases//backupSchedules/*}` Exclui uma programação de backup.
`get`	`GET /v1/{name=projects//databases//backupSchedules/*}` Extrai informações sobre uma programação de backup.
`list`	`GET /v1/{parent=projects//databases/}/backupSchedules` Lista as programações de backup.
`patch`	`PATCH /v1/{backupSchedule.name=projects//databases//backupSchedules/*}` Atualiza uma programação de backup.

Recurso REST: v1.projects.databases.collectionGroups.fields

Métodos
`get`	`GET /v1/{name=projects//databases//collectionGroups//fields/}` Recebe os metadados e a configuração de um campo.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/fields` Lista a configuração de campo e os metadados para este banco de dados.
`patch`	`PATCH /v1/{field.name=projects//databases//collectionGroups//fields/}` Atualiza uma configuração de campo.

Recurso REST: v1.projects.databases.collectionGroups.indexes

Métodos
`create`	`POST /v1/{parent=projects//databases//collectionGroups/*}/indexes` Cria um índice composto.
`delete`	`DELETE /v1/{name=projects//databases//collectionGroups//indexes/}` Exclui um índice composto.
`get`	`GET /v1/{name=projects//databases//collectionGroups//indexes/}` Recebe um índice composto.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/indexes` Lista índices compostos.

Recurso REST: v1.projects.databases.documents

Métodos
`batchGet`	`POST /v1/{database=projects//databases/}/documents:batchGet` Recebe vários documentos.
`batchWrite`	`POST /v1/{database=projects//databases/}/documents:batchWrite` Aplica um lote de operações de gravação.
`beginTransaction`	`POST /v1/{database=projects//databases/}/documents:beginTransaction` Inicia uma nova transação.
`commit`	`POST /v1/{database=projects//databases/}/documents:commit` Confirma uma transação e, opcionalmente, atualiza documentos.
`createDocument`	`POST /v1/{parent=projects//databases//documents/**}/{collectionId}` Cria um documento.
`delete`	`DELETE /v1/{name=projects//databases//documents//*}` Exclui um documento.
`get`	`GET /v1/{name=projects//databases//documents//*}` Recebe um único documento.
`list`	`GET /v1/{parent=projects//databases//documents//*}/{collectionId}` Lista os documentos.
`listCollectionIds`	`POST /v1/{parent=projects//databases//documents}:listCollectionIds` Lista todos os IDs de coleções abaixo de um documento.
`listDocuments`	`GET /v1/{parent=projects//databases//documents}/{collectionId}` Lista os documentos.
`partitionQuery`	`POST /v1/{parent=projects//databases//documents}:partitionQuery` Particiona uma consulta retornando cursores de partição que podem ser usados para executar a consulta em paralelo.
`patch`	`PATCH /v1/{document.name=projects//databases//documents//*}` Atualiza ou insere um documento.
`rollback`	`POST /v1/{database=projects//databases/}/documents:rollback` Reverte uma transação.
`runAggregationQuery`	`POST /v1/{parent=projects//databases//documents}:runAggregationQuery` Executa uma consulta de agregação.
`runQuery`	`POST /v1/{parent=projects//databases//documents}:runQuery` Executa uma consulta.

Recurso REST: v1.projects.databases.operations

Métodos
`cancel`	`POST /v1/{name=projects//databases//operations/*}:cancel` Inicia o cancelamento assíncrono de uma operação de longa duração.
`delete`	`DELETE /v1/{name=projects//databases//operations/*}` Exclui uma operação de longa duração.
`get`	`GET /v1/{name=projects//databases//operations/*}` Recebe o estado mais recente de uma operação de longa duração.
`list`	`GET /v1/{name=projects//databases/}/operations` Lista as operações que correspondem ao filtro especificado na solicitação.

Recurso da REST: v1.projects.locations

Métodos
`get`	`GET /v1/{name=projects//locations/}` Extrai informações sobre um local.
`list`	`GET /v1/{name=projects/*}/locations` Lista informações sobre os locais compatíveis com este serviço.

Recurso REST: v1.projects.locations.backups

Métodos
`delete`	`DELETE /v1/{name=projects//locations//backups/*}` Exclui um backup.
`get`	`GET /v1/{name=projects//locations//backups/*}` Extrai informações sobre um backup.
`list`	`GET /v1/{parent=projects//locations/}/backups` Lista todos os backups.