Cloud Firestore API

Accede al database di documenti NoSQL creato per 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 la tua applicazione deve utilizzare le tue librerie per chiamare questo servizio, utilizza le seguenti informazioni quando effettui le richieste API.

Documento di scoperta

Un documento di rilevamento è una specifica leggibile dalla macchina per descrivere e utilizzare le 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 del servizio

Un endpoint del servizio è un URL di base che specifica l'indirizzo di rete di un servizio API. Un servizio potrebbe 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 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/*}
Ottiene i metadati e la configurazione per un campo.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
Elenca la configurazione del campo e i metadati per questo database.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Aggiorna una configurazione di campo.

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

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

Risorsa REST: v1beta1.projects.databases

Metodi
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
Esporta una copia di tutti 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
Ottiene più documenti.
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
Applica un batch 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, aggiornando facoltativamente 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/*/**}
Ottiene 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 di raccolta sotto un documento.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Elenca i documenti.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
Partiziona una query restituendo 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
Ripristina 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/*}
Ottiene 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
Creare una banca dati.
delete DELETE /v1/{name=projects/*/databases/*}
Elimina un database.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Esporta una copia di tutti 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/*}
Ottiene 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 nel progetto.
patch PATCH /v1/{database.name=projects/*/databases/*}
Aggiorna un database.
restore POST /v1/{parent=projects/*}/databases:restore
Crea un nuovo database ripristinando da un backup esistente.

Risorsa REST: v1.projects.databases.backupSchedules

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

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

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

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

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

Risorsa REST: v1.projects.databases.documents

Metodi
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
Ottiene più documenti.
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
Applica un batch 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, aggiornando facoltativamente 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/*/**}
Ottiene 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 di raccolta sotto un documento.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Elenca i documenti.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
Partiziona una query restituendo 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
Ripristina 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.operazioni

Metodi
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
Avvia l'annullamento asincrono su 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/*}
Ottiene 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/*}
Ottiene informazioni su una posizione.
list GET /v1/{name=projects/*}/locations
Elenca le informazioni sulle posizioni 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/*}
Ottiene informazioni su un backup.
list GET /v1/{parent=projects/*/locations/*}/backups
Elenca tutti i backup.