Cloud Firestore API

Accede a la base de datos de documentos NoSQL creada a fin de proporcionar ajuste de escala automático, alto rendimiento y facilidad para el desarrollo de aplicaciones.

Servicio: firestore.googleapis.com

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la siguiente información cuando realices las solicitudes a la API.

Documento de descubrimiento

Un Documento de descubrimiento es una especificación procesable para describir y consumir las API de REST. Se usa para compilar 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 Discovery:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de la red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://firestore.googleapis.com

Recurso de REST: v1beta2.projects.databases

Métodos
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
Exporta una copia de todos los documentos o de un subconjunto de ellos 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 de 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 del campo y los metadatos para esta base de datos.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Actualiza la configuración de un campo.

Recurso de 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/*}
Borra un índice compuesto.
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Obtiene un índice compuesto.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Muestra una lista de los índices compuestos.

Recurso de REST: v1beta1.projects.databases

Métodos
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
Exporta una copia de todos los documentos o de un subconjunto de ellos 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 de REST: v1beta1.projects.databases.documents

Métodos
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
Obtiene varios 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, de forma opcional, actualiza los documentos.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Crea un documento nuevo.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
Borra un documento.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
Obtiene un solo documento.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Muestra una lista de los documentos.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Muestra una lista de todos los IDs de colección de un documento.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Muestra una lista de los documentos.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
Particiona una consulta mediante la devolución de 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
Revierte 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 de 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/*}
Borra 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 de REST: v1.projects.databases

Métodos
create POST /v1/{parent=projects/*}/databases
Crea una base de datos.
delete DELETE /v1/{name=projects/*/databases/*}
Borra una base de datos.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Exporta una copia de todos los documentos o de un subconjunto de ellos 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
Obtén una lista de 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 base de datos nueva mediante el restablecimiento de una copia de seguridad existente.

Recurso de REST: v1.projects.databases.backupSchedules

Métodos
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
Crea un programa de copia de seguridad en una base de datos.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
Borra una programación de copia de seguridad.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
Obtiene información sobre un programa de copia de seguridad.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
Enumera las programaciones de copias de seguridad.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
Actualiza una programación de copia de seguridad.

Recurso de 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 del campo y los metadatos para esta base de datos.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Actualiza la configuración de un campo.

Recurso de 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/*}
Borra un índice compuesto.
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Obtiene un índice compuesto.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Muestra una lista de los índices compuestos.

Recurso de REST: v1.projects.databases.documents

Métodos
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
Obtiene varios 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, de forma opcional, actualiza los documentos.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Crea un documento nuevo.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
Borra un documento.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
Obtiene un solo documento.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Muestra una lista de los documentos.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
Muestra una lista de todos los IDs de colección de un documento.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Muestra una lista de los documentos.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
Particiona una consulta mediante la devolución de 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
Revierte 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 de REST: v1.projects.databases.operations

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/*}
Borra una operación de larga duración.
get GET /v1/{name=projects/*/databases/*/operations/*}
Obtiene el último estado 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 de 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 una lista con información sobre las ubicaciones compatibles con este servicio.

Recurso de REST: v1.projects.locations.backups

Métodos
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
Borra 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.