Cloud Firestore API

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

Serviço: firestore.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas cliente fornecidas pelo Google. Se seu aplicativo precisar usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir ao fazer as solicitações de 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 construir bibliotecas de clientes, plug-ins IDE e outras ferramentas que interagem com APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço fornece os seguintes documentos de descoberta:

Ponto final de serviço

Um terminal de serviço é uma URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários terminais de serviço. Este serviço tem o seguinte terminal de serviço e todos os URIs abaixo são relativos a este terminal de serviço:

  • 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 de 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/*}
Obtém 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 deste 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/*}
Obtém 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 de 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
Obtém 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, enquanto opcionalmente atualiza documentos.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Cria um novo documento.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
Exclui um documento.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
Obtém um único documento.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Lista documentos.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Lista todos os IDs de coleção abaixo de um documento.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Lista 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/*}
Obtém 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
Crie 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 de um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage.
get GET /v1/{name=projects/*/databases/*}
Obtém 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 do 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 existente.

Recurso REST: v1.projects.databases.backupSchedules

Métodos
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
Cria um agendamento de backup em um banco de dados.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
Exclui um agendamento de backup.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
Obtém informações sobre um agendamento de backup.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
Liste programações de backup.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
Atualiza um agendamento de backup.

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

Métodos
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Obtém 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 deste 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/*}
Obtém 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
Obtém 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, enquanto opcionalmente atualiza documentos.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Cria um novo documento.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
Exclui um documento.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
Obtém um único documento.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Lista documentos.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
Lista todos os IDs de coleção abaixo de um documento.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Lista 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.operações

Métodos
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
Inicia o cancelamento assíncrono em 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/*}
Obtém 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 REST: v1.projects.locations

Métodos
get GET /v1/{name=projects/*/locations/*}
Obtém informações sobre um local.
list GET /v1/{name=projects/*}/locations
Lista informações sobre os locais com suporte para 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/*}
Obtém informações sobre um backup.
list GET /v1/{parent=projects/*/locations/*}/backups
Lista todos os backups.