API Reference

Cette documentation de référence de l'API est organisée par type de ressource. Chaque type de ressource comporte une ou plusieurs représentations de données, ainsi qu'une ou plusieurs méthodes.

Types de ressources

  1. Users.dataSources
  2. Users.dataSources.dataPointChanges
  3. Users.dataSources.datasets
  4. Users.dataset
  5. Users.sessions

Users.dataSources

Pour en savoir plus sur la ressource "Users.dataSources", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/fitness/v1/users, sauf indication contraire
créer POST  /userId/dataSources Crée une source de données unique parmi toutes les sources de données appartenant à cet utilisateur.

Une source de données est une source unique de données de capteurs. Les sources de données peuvent exposer des données brutes provenant de capteurs matériels sur des appareils locaux ou associés. Elles peuvent également exposer des données dérivées, créées par transformation ou fusion d'autres sources de données. Plusieurs sources de données peuvent exister pour le même type de données. Chaque point de données de chaque ensemble de données inséré dans l'API Fitness ou lu à partir de celui-ci est associé à une source de données.

Chaque source de données génère un flux unique de mises à jour d'ensembles de données, avec un identifiant de source de données unique. Toutes les modifications apportées à la source de données n'affectent pas l'ID du flux de données. Par conséquent, les données collectées par les versions mises à jour de la même application ou du même appareil peuvent toujours être considérées comme appartenant à la même source de données.

Les sources de données sont identifiées à l'aide d'une chaîne générée par le serveur, en fonction du contenu de la source en cours de création. Le champ dataStreamId ne doit pas être défini lors de l'appel de cette méthode. Il sera automatiquement généré par le serveur au bon format. Si un dataStreamId est défini, il doit correspondre au format généré par le serveur. Ce format, dans un ordre spécifique, combine certains champs de la source de données. En l'absence de correspondance, la requête échoue et renvoie une erreur.

Si vous spécifiez un DataType non connu (à partir de "com.google."), vous créerez une DataSource avec un type de données personnalisé. Les types de données personnalisés ne sont lisibles que par l'application qui les a créés. Les types de données personnalisés sont obsolètes. Utilisez plutôt des types de données standards.

En plus des champs de source de données inclus dans l'ID de la source de données, le numéro de projet de développeur authentifié lors de la création de la source de données est inclus. Ce numéro de projet de développeur est obscurci lorsqu'il est lu par tout autre développeur lisant des types de données publiques.
supprimer DELETE  /userId/dataSources/dataSourceId Supprime la source de données spécifiée. La requête échouera si la source de données contient des points de données.
get GET  /userId/dataSources/dataSourceId Renvoie la source de données spécifiée.
liste GET  /userId/dataSources Répertorie toutes les sources de données visibles par le développeur à l'aide des champs d'application OAuth fournis. Cette liste n'est pas exhaustive. L'utilisateur peut disposer de sources de données privées visibles uniquement par d'autres développeurs ou d'appels utilisant d'autres champs d'application.
mise à jour PUT  /userId/dataSources/dataSourceId Met à jour la source de données spécifiée. Les propriétés dataStreamId, dataType, type, dataStreamName et device, à l'exception de version, ne peuvent pas être modifiées.

Les sources de données sont identifiées par leur dataStreamId.

Users.dataSources.dataPointChanges

Pour en savoir plus sur la ressource Users.dataSources.dataPointChanges, consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/fitness/v1/users, sauf indication contraire
liste GET  /userId/dataSources/dataSourceId/dataPointChanges Requêtes concernant les modifications du point de données d'un utilisateur pour une source de données particulière

Users.dataSources.datasets

Pour en savoir plus sur la ressource "Users.dataSources.datasets", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/fitness/v1/users, sauf indication contraire
supprimer DELETE  /userId/dataSources/dataSourceId/datasets/datasetId Effectue une suppression inclusive de tous les points de données dont les heures de début et de fin chevauchent la période spécifiée par l'ID de l'ensemble de données. Pour la plupart des types de données, l'intégralité du point de données sera supprimée. Pour les types de données où la période représente une valeur cohérente (par exemple, com.google.activity.segment) et où un point de données chevauche l'un ou l'autre des points de terminaison de l'ensemble de données, seule la partie chevauchant le point de données est supprimée.
get GET  /userId/dataSources/dataSourceId/datasets/datasetId Renvoie un ensemble de données contenant tous les points de données dont les heures de début et de fin coïncident avec la plage spécifiée d'heures de début minimale et maximale de l'ensemble de données. Plus précisément, tout point de données dont l'heure de début est inférieure ou égale à l'heure de fin de l'ensemble de données et dont l'heure de fin est supérieure ou égale à l'heure de début de l'ensemble de données.
patch PATCH  /userId/dataSources/dataSourceId/datasets/datasetId Ajoute des points de données à un ensemble de données. Il n'est pas nécessaire de créer l'ensemble de données au préalable. Tous les points de l'ensemble de données donné seront renvoyés avec les appels ultérieurs pour récupérer cet ensemble de données. Les points de données peuvent appartenir à plusieurs ensembles de données.

Cette méthode n'utilise pas la sémantique "patch" : les points de données fournis sont simplement insérés, et aucune donnée existante n'est remplacée.

Users.dataset

Pour en savoir plus sur la ressource "Users.dataset", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/fitness/v1/users, sauf indication contraire
agréger POST  /userId/dataset:aggregate agrège les données d'un certain type ou flux dans des buckets divisés par un type de limite donné. Plusieurs ensembles de données de différents types et provenant de plusieurs sources peuvent être agrégés dans un seul type de bucket par requête.

Users.sessions

Pour en savoir plus sur la ressource "Users.sessions", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/fitness/v1/users, sauf indication contraire
supprimer DELETE  /userId/sessions/sessionId Supprime une session spécifiée par l'ID de session donné.
liste GET  /userId/sessions Répertorie les sessions précédemment créées.
mise à jour PUT  /userId/sessions/sessionId Met à jour ou insère une session donnée.