Cette page a été traduite par l'API Cloud Translation.

Cloud Firestore API

Accède à la base de données de documents NoSQL. Conçue pour le scaling automatique et les hautes performances, elle simplifie le développement d'applications.

Service: Firestore.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, utilisez les informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification exploitable par un ordinateur qui permet de décrire et de consommer les API REST. Ce document permet de créer des bibliothèques clientes, des plug-ins IDE et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs documents de découverte. Ce service fournit les documents de découverte suivants :

Point de terminaison du service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. Un service peut posséder plusieurs points de terminaison de service. Ce service possède le point de terminaison de service suivant, et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

https://firestore.googleapis.com

Ressource REST: v1beta2.projects.databases

Méthodes
`exportDocuments`	`POST /v1beta2/{name=projects//databases/}:exportDocuments` Exporte une copie de tout ou d'un sous-ensemble des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage.
`importDocuments`	`POST /v1beta2/{name=projects//databases/}:importDocuments` Importe des documents dans Google Cloud Firestore.

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

Méthodes
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//fields/}` Récupère les métadonnées et la configuration d'un champ.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/fields` Répertorie la configuration et les métadonnées des champs pour cette base de données.
`patch`	`PATCH /v1beta2/{field.name=projects//databases//collectionGroups//fields/}` Met à jour la configuration d'un champ.

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

Méthodes
`create`	`POST /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Crée un index composite.
`delete`	`DELETE /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Supprime un index composite.
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Récupère un index composite.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Répertorie les index composites.

Ressource REST: v1beta1.projects.databases

Méthodes
`exportDocuments`	`POST /v1beta1/{name=projects//databases/}:exportDocuments` Exporte une copie de tout ou d'un sous-ensemble des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage.
`importDocuments`	`POST /v1beta1/{name=projects//databases/}:importDocuments` Importe des documents dans Google Cloud Firestore.

Ressource REST: v1beta1.projects.databases.documents

Méthodes
`batchGet`	`POST /v1beta1/{database=projects//databases/}/documents:batchGet` Récupère plusieurs documents.
`batchWrite`	`POST /v1beta1/{database=projects//databases/}/documents:batchWrite` Applique un lot d'opérations d'écriture.
`beginTransaction`	`POST /v1beta1/{database=projects//databases/}/documents:beginTransaction` Démarre une nouvelle transaction.
`commit`	`POST /v1beta1/{database=projects//databases/}/documents:commit` Valide une transaction et met à jour des documents si vous le souhaitez.
`createDocument`	`POST /v1beta1/{parent=projects//databases//documents/**}/{collectionId}` Crée un document.
`delete`	`DELETE /v1beta1/{name=projects//databases//documents//*}` Supprime un document.
`get`	`GET /v1beta1/{name=projects//databases//documents//*}` Récupère un seul document.
`list`	`GET /v1beta1/{parent=projects//databases//documents//*}/{collectionId}` Répertorie les documents.
`listCollectionIds`	`POST /v1beta1/{parent=projects//databases//documents}:listCollectionIds` Répertorie tous les ID de collection d'un document.
`listDocuments`	`GET /v1beta1/{parent=projects//databases//documents}/{collectionId}` Répertorie les documents.
`partitionQuery`	`POST /v1beta1/{parent=projects//databases//documents}:partitionQuery` Partitionne une requête en renvoyant des curseurs de partition pouvant être utilisés pour exécuter la requête en parallèle.
`patch`	`PATCH /v1beta1/{document.name=projects//databases//documents//*}` Met à jour ou insère un document.
`rollback`	`POST /v1beta1/{database=projects//databases/}/documents:rollback` Annule une transaction.
`runAggregationQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runAggregationQuery` Exécute une requête d'agrégation.
`runQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runQuery` Exécute une requête.

Ressource REST: v1beta1.projects.databases.indexes

Méthodes
`create`	`POST /v1beta1/{parent=projects//databases/}/indexes` Crée l'index spécifié.
`delete`	`DELETE /v1beta1/{name=projects//databases//indexes/*}` Supprime un index.
`get`	`GET /v1beta1/{name=projects//databases//indexes/*}` Récupère un index.
`list`	`GET /v1beta1/{parent=projects//databases/}/indexes` Répertorie les index correspondant aux filtres spécifiés.

Ressource REST: v1.projects.databases

Méthodes
`create`	`POST /v1/{parent=projects/*}/databases` Créez une base de données.
`delete`	`DELETE /v1/{name=projects//databases/}` Supprime une base de données.
`exportDocuments`	`POST /v1/{name=projects//databases/}:exportDocuments` Exporte une copie de tout ou d'un sous-ensemble des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage.
`get`	`GET /v1/{name=projects//databases/}` Récupère des informations sur une base de données.
`importDocuments`	`POST /v1/{name=projects//databases/}:importDocuments` Importe des documents dans Google Cloud Firestore.
`list`	`GET /v1/{parent=projects/*}/databases` Répertoriez toutes les bases de données du projet.
`patch`	`PATCH /v1/{database.name=projects//databases/}` Met à jour une base de données.
`restore`	`POST /v1/{parent=projects/*}/databases:restore` Crée une base de données en restaurant à partir d'une sauvegarde existante.

Ressource REST: v1.projects.databases.backupSchedules

Méthodes
`create`	`POST /v1/{parent=projects//databases/}/backupSchedules` Crée un planning de sauvegarde sur une base de données.
`delete`	`DELETE /v1/{name=projects//databases//backupSchedules/*}` Supprime une programmation de sauvegarde.
`get`	`GET /v1/{name=projects//databases//backupSchedules/*}` Récupère des informations sur un planning de sauvegarde.
`list`	`GET /v1/{parent=projects//databases/}/backupSchedules` Répertorier les planifications de sauvegarde.
`patch`	`PATCH /v1/{backupSchedule.name=projects//databases//backupSchedules/*}` Met à jour un planning de sauvegarde.

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

Méthodes
`get`	`GET /v1/{name=projects//databases//collectionGroups//fields/}` Récupère les métadonnées et la configuration d'un champ.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/fields` Répertorie la configuration et les métadonnées des champs pour cette base de données.
`patch`	`PATCH /v1/{field.name=projects//databases//collectionGroups//fields/}` Met à jour la configuration d'un champ.

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

Méthodes
`create`	`POST /v1/{parent=projects//databases//collectionGroups/*}/indexes` Crée un index composite.
`delete`	`DELETE /v1/{name=projects//databases//collectionGroups//indexes/}` Supprime un index composite.
`get`	`GET /v1/{name=projects//databases//collectionGroups//indexes/}` Récupère un index composite.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/indexes` Répertorie les index composites.

Ressource REST: v1.projects.databases.documents

Méthodes
`batchGet`	`POST /v1/{database=projects//databases/}/documents:batchGet` Récupère plusieurs documents.
`batchWrite`	`POST /v1/{database=projects//databases/}/documents:batchWrite` Applique un lot d'opérations d'écriture.
`beginTransaction`	`POST /v1/{database=projects//databases/}/documents:beginTransaction` Démarre une nouvelle transaction.
`commit`	`POST /v1/{database=projects//databases/}/documents:commit` Valide une transaction et met à jour des documents si vous le souhaitez.
`createDocument`	`POST /v1/{parent=projects//databases//documents/**}/{collectionId}` Crée un document.
`delete`	`DELETE /v1/{name=projects//databases//documents//*}` Supprime un document.
`get`	`GET /v1/{name=projects//databases//documents//*}` Récupère un seul document.
`list`	`GET /v1/{parent=projects//databases//documents//*}/{collectionId}` Répertorie les documents.
`listCollectionIds`	`POST /v1/{parent=projects//databases//documents}:listCollectionIds` Répertorie tous les ID de collection d'un document.
`listDocuments`	`GET /v1/{parent=projects//databases//documents}/{collectionId}` Répertorie les documents.
`partitionQuery`	`POST /v1/{parent=projects//databases//documents}:partitionQuery` Partitionne une requête en renvoyant des curseurs de partition pouvant être utilisés pour exécuter la requête en parallèle.
`patch`	`PATCH /v1/{document.name=projects//databases//documents//*}` Met à jour ou insère un document.
`rollback`	`POST /v1/{database=projects//databases/}/documents:rollback` Annule une transaction.
`runAggregationQuery`	`POST /v1/{parent=projects//databases//documents}:runAggregationQuery` Exécute une requête d'agrégation.
`runQuery`	`POST /v1/{parent=projects//databases//documents}:runQuery` Exécute une requête.

Ressource REST: v1.projects.databases.operations

Méthodes
`cancel`	`POST /v1/{name=projects//databases//operations/*}:cancel` Démarre l'annulation asynchrone sur une opération de longue durée.
`delete`	`DELETE /v1/{name=projects//databases//operations/*}` Supprime une opération de longue durée.
`get`	`GET /v1/{name=projects//databases//operations/*}` Récupère le dernier état d'une opération de longue durée.
`list`	`GET /v1/{name=projects//databases/}/operations` Répertorie les opérations qui correspondent au filtre spécifié dans la requête.

Ressource REST : v1.projects.locations

Méthodes
`get`	`GET /v1/{name=projects//locations/}` Récupère des informations sur un emplacement.
`list`	`GET /v1/{name=projects/*}/locations` Répertorie les informations concernant les emplacements compatibles avec ce service.

Ressource REST: v1.projects.locations.backups

Méthodes
`delete`	`DELETE /v1/{name=projects//locations//backups/*}` Supprime une sauvegarde.
`get`	`GET /v1/{name=projects//locations//backups/*}` Récupère des informations sur une sauvegarde.
`list`	`GET /v1/{parent=projects//locations/}/backups` Répertorie toutes les sauvegardes.