Cloud Firestore API

Accede a la base de datos de documentos NoSQL creada para escalado automático, alto rendimiento y facilidad de desarrollo de aplicaciones.

Servicio: firestore.googleapis.com

Para llamar a este servicio, le recomendamos que utilice las bibliotecas cliente proporcionadas por Google. Si su aplicación necesita usar sus propias bibliotecas para llamar a este servicio, use la siguiente información cuando realice las solicitudes de API.

documento de descubrimiento

Un documento de descubrimiento es una especificación legible por máquina para describir y consumir API REST. Se utiliza para crear bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona los siguientes documentos de descubrimiento:

Punto final del servicio

Un punto final de servicio es una URL base que especifica la dirección de red de un servicio API. Un servicio puede tener varios puntos finales de servicio. Este servicio tiene el siguiente punto final de servicio y todos los URI siguientes son relativos a este punto final de servicio:

  • https://firestore.googleapis.com

Recurso REST: v1beta2.projects.databases

Métodos
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage.
importDocuments POST /v1beta2/{name=projects/*/databases/*}:importDocuments
Importa documentos a Google Cloud Firestore.

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

Métodos
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Obtiene los metadatos y la configuración de un campo.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
Enumera la configuración de campo y los metadatos de esta base de datos.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Actualiza una configuración de campo.

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

Métodos
create POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Crea un índice compuesto.
delete DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Elimina un índice compuesto.
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Obtiene un índice compuesto.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Enumera índices compuestos.

Recurso REST: v1beta1.projects.databases

Métodos
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage.
importDocuments POST /v1beta1/{name=projects/*/databases/*}:importDocuments
Importa documentos a Google Cloud Firestore.

Recurso REST: v1beta1.projects.databases.documents

Métodos
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
Obtiene múltiples documentos.
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
Aplica un lote de operaciones de escritura.
beginTransaction POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction
Inicia una nueva transacción.
commit POST /v1beta1/{database=projects/*/databases/*}/documents:commit
Confirma una transacción y, opcionalmente, actualiza los documentos.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Crea un nuevo documento.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
Elimina un documento.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
Obtiene un solo documento.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Enumera documentos.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Enumera todos los ID de colección debajo de un documento.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Enumera documentos.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
Particiona una consulta devolviendo cursores de partición que se pueden usar para ejecutar la consulta en paralelo.
patch PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}
Actualiza o inserta un documento.
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
Deshace una transacción.
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Ejecuta una consulta de agregación.
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
Ejecuta una consulta.

Recurso REST: v1beta1.projects.databases.indexes

Métodos
create POST /v1beta1/{parent=projects/*/databases/*}/indexes
Crea el índice especificado.
delete DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}
Elimina un índice.
get GET /v1beta1/{name=projects/*/databases/*/indexes/*}
Obtiene un índice.
list GET /v1beta1/{parent=projects/*/databases/*}/indexes
Enumera los índices que coinciden con los filtros especificados.

Recurso REST: v1.projects.databases

Métodos
create POST /v1/{parent=projects/*}/databases
Crea una base de datos.
delete DELETE /v1/{name=projects/*/databases/*}
Elimina una base de datos.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage.
get GET /v1/{name=projects/*/databases/*}
Obtiene información sobre una base de datos.
importDocuments POST /v1/{name=projects/*/databases/*}:importDocuments
Importa documentos a Google Cloud Firestore.
list GET /v1/{parent=projects/*}/databases
Enumere todas las bases de datos del proyecto.
patch PATCH /v1/{database.name=projects/*/databases/*}
Actualiza una base de datos.
restore POST /v1/{parent=projects/*}/databases:restore
Crea una nueva base de datos restaurando desde una copia de seguridad existente.

Recurso REST: v1.projects.databases.backupSchedules

Métodos
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
Crea una programación de copias de seguridad en una base de datos.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
Elimina una programación de copias de seguridad.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
Obtiene información sobre una programación de copias de seguridad.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
Enumere los cronogramas de respaldo.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
Actualiza una programación de copias de seguridad.

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

Métodos
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Obtiene los metadatos y la configuración de un campo.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
Enumera la configuración de campo y los metadatos de esta base de datos.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Actualiza una configuración de campo.

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

Métodos
create POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Crea un índice compuesto.
delete DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Elimina un índice compuesto.
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Obtiene un índice compuesto.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Enumera índices compuestos.

Recurso REST: v1.projects.databases.documents

Métodos
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
Obtiene múltiples documentos.
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
Aplica un lote de operaciones de escritura.
beginTransaction POST /v1/{database=projects/*/databases/*}/documents:beginTransaction
Inicia una nueva transacción.
commit POST /v1/{database=projects/*/databases/*}/documents:commit
Confirma una transacción y, opcionalmente, actualiza los documentos.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Crea un nuevo documento.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
Elimina un documento.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
Obtiene un solo documento.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Enumera documentos.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
Enumera todos los ID de colección debajo de un documento.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Enumera documentos.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
Particiona una consulta devolviendo cursores de partición que se pueden usar para ejecutar la consulta en paralelo.
patch PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}
Actualiza o inserta un documento.
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
Deshace una transacción.
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Ejecuta una consulta de agregación.
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
Ejecuta una consulta.

Recurso REST: v1.projects.databases.operaciones

Métodos
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
Inicia la cancelación asincrónica en una operación de larga duración.
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
Elimina una operación de larga duración.
get GET /v1/{name=projects/*/databases/*/operations/*}
Obtiene el estado más reciente de una operación de larga duración.
list GET /v1/{name=projects/*/databases/*}/operations
Enumera las operaciones que coinciden con el filtro especificado en la solicitud.

Recurso REST: v1.projects.locations

Métodos
get GET /v1/{name=projects/*/locations/*}
Obtiene información sobre una ubicación.
list GET /v1/{name=projects/*}/locations
Muestra información sobre las ubicaciones admitidas para este servicio.

Recurso REST: v1.projects.locations.backups

Métodos
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
Elimina una copia de seguridad.
get GET /v1/{name=projects/*/locations/*/backups/*}
Obtiene información sobre una copia de seguridad.
list GET /v1/{parent=projects/*/locations/*}/backups
Enumera todas las copias de seguridad.