Cloud Firestore API

Accede al database di documenti NoSQL creato per offrire scalabilità automatica, prestazioni elevate e facilità di sviluppo delle applicazioni.

Servizio: firestore.googleapis.com

Per chiamare questo servizio, ti consigliamo di utilizzare le librerie client fornite da Google. Se l'applicazione deve utilizzare le tue librerie per chiamare questo servizio, usa le seguenti informazioni quando effettui le richieste API.

Documento di rilevamento

Un documento di rilevamento è una specifica leggibile dalle macchine per la descrizione e l'utilizzo delle API REST. Viene utilizzato per creare librerie client, plug-in IDE e altri strumenti che interagiscono con le API di Google. Un servizio può fornire più documenti di rilevamento. Questo servizio fornisce i seguenti documenti di rilevamento:

Endpoint di servizio

Un endpoint di servizio è un URL di base che specifica l'indirizzo di rete di un servizio API. Un servizio può avere più endpoint di servizio. Questo servizio ha il seguente endpoint di servizio e tutti gli URI seguenti sono relativi a questo endpoint di servizio:

  • https://firestore.googleapis.com

Risorsa REST: v1beta2.projects.databases

Metodi
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
Esporta una copia di tutti i documenti o di un sottoinsieme di documenti da Google Cloud Firestore a un altro sistema di archiviazione, come Google Cloud Storage.
importDocuments POST /v1beta2/{name=projects/*/databases/*}:importDocuments
Importa documenti in Google Cloud Firestore.

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

Metodi
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Recupera i metadati e la configurazione di un campo.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
Elenca la configurazione dei campi e i metadati per questo database.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Aggiorna la configurazione di un campo.

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

Metodi
create POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Crea un indice composto.
delete DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Elimina un indice composto.
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Recupera un indice composto.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Elenca gli indici composti.

Risorsa REST: v1beta1.projects.databases

Metodi
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
Esporta una copia di tutti i documenti o di un sottoinsieme di documenti da Google Cloud Firestore a un altro sistema di archiviazione, come Google Cloud Storage.
importDocuments POST /v1beta1/{name=projects/*/databases/*}:importDocuments
Importa documenti in Google Cloud Firestore.

Risorsa REST: v1beta1.projects.databases.documents

Metodi
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
Recupera più documenti.
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
Applica un gruppo di operazioni di scrittura.
beginTransaction POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction
Avvia una nuova transazione.
commit POST /v1beta1/{database=projects/*/databases/*}/documents:commit
Esegue il commit di una transazione e, facoltativamente, aggiorna i documenti.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Crea un nuovo documento.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
Elimina un documento.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
Recupera un singolo documento.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Elenca i documenti.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Elenca tutti gli ID raccolta in un documento.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Elenca i documenti.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
Esegue il partizionamento di una query restituendo i cursori di partizione che possono essere utilizzati per eseguire la query in parallelo.
patch PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}
Aggiorna o inserisce un documento.
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
Esegue il rollback di una transazione.
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Esegue una query di aggregazione.
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
Esegue una query.

Risorsa REST: v1beta1.projects.databases.indexes

Metodi
create POST /v1beta1/{parent=projects/*/databases/*}/indexes
Crea l'indice specificato.
delete DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}
Elimina un indice.
get GET /v1beta1/{name=projects/*/databases/*/indexes/*}
Recupera un indice.
list GET /v1beta1/{parent=projects/*/databases/*}/indexes
Elenca gli indici che corrispondono ai filtri specificati.

Risorsa REST: v1.projects.databases

Metodi
create POST /v1/{parent=projects/*}/databases
Crea un database.
delete DELETE /v1/{name=projects/*/databases/*}
Elimina un database.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Esporta una copia di tutti i documenti o di un sottoinsieme di documenti da Google Cloud Firestore a un altro sistema di archiviazione, come Google Cloud Storage.
get GET /v1/{name=projects/*/databases/*}
Recupera informazioni su un database.
importDocuments POST /v1/{name=projects/*/databases/*}:importDocuments
Importa documenti in Google Cloud Firestore.
list GET /v1/{parent=projects/*}/databases
Elenca tutti i database presenti nel progetto.
patch PATCH /v1/{database.name=projects/*/databases/*}
Aggiorna un database.
restore POST /v1/{parent=projects/*}/databases:restore
Crea un nuovo database ripristinando un backup esistente.

Risorsa REST: v1.projects.databases.backupSchedules

Metodi
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
Crea una pianificazione del backup su un database.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
Elimina una pianificazione del backup.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
Recupera le informazioni su una pianificazione del backup.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
Elenca le pianificazioni dei backup.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
Aggiorna una pianificazione del backup.

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

Metodi
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Recupera i metadati e la configurazione di un campo.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
Elenca la configurazione dei campi e i metadati per questo database.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Aggiorna la configurazione di un campo.

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

Metodi
create POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Crea un indice composto.
delete DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Elimina un indice composto.
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Recupera un indice composto.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Elenca gli indici composti.

Risorsa REST: v1.projects.databases.documents

Metodi
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
Recupera più documenti.
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
Applica un gruppo di operazioni di scrittura.
beginTransaction POST /v1/{database=projects/*/databases/*}/documents:beginTransaction
Avvia una nuova transazione.
commit POST /v1/{database=projects/*/databases/*}/documents:commit
Esegue il commit di una transazione e, facoltativamente, aggiorna i documenti.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Crea un nuovo documento.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
Elimina un documento.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
Recupera un singolo documento.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Elenca i documenti.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
Elenca tutti gli ID raccolta in un documento.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Elenca i documenti.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
Esegue il partizionamento di una query restituendo i cursori di partizione che possono essere utilizzati per eseguire la query in parallelo.
patch PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}
Aggiorna o inserisce un documento.
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
Esegue il rollback di una transazione.
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Esegue una query di aggregazione.
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
Esegue una query.

Risorsa REST: v1.projects.databases.operations

Metodi
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
Avvia l'annullamento asincrono di un'operazione a lunga esecuzione.
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
Elimina un'operazione a lunga esecuzione.
get GET /v1/{name=projects/*/databases/*/operations/*}
Recupera lo stato più recente di un'operazione a lunga esecuzione.
list GET /v1/{name=projects/*/databases/*}/operations
Elenca le operazioni che corrispondono al filtro specificato nella richiesta.

Risorsa REST: v1.projects.locations

Metodi
get GET /v1/{name=projects/*/locations/*}
Recupera le informazioni su una località.
list GET /v1/{name=projects/*}/locations
Elenca le informazioni sulle località supportate per questo servizio.

Risorsa REST: v1.projects.locations.backups

Metodi
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
Elimina un backup.
get GET /v1/{name=projects/*/locations/*/backups/*}
Recupera le informazioni su un backup.
list GET /v1/{parent=projects/*/locations/*}/backups
Elenca tutti i backup.