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

Utilisateurs.Sources de données

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 les données brutes provenant de capteurs matériels sur des appareils locaux ou associés. Ils peuvent également exposer des données dérivées, créées en transformant ou en fusionnant d'autres sources de données. Il peut exister plusieurs sources de données pour le même type de données. Chaque point de données de chaque ensemble de données inséré dans ou lu à partir de l'API Fitness est associé à une source de données.

Chaque source de données génère un flux unique de mises à jour des 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 des 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 est généré automatiquement par le serveur au format approprié. Si un dataStreamId est défini, il doit correspondre au format que le serveur générera. Ce format combine certains champs de la source de données et présente un ordre spécifique. Si ce n'est pas le cas, la requête échouera et générera une erreur.

La spécification d'un type de données (dont le type n'est pas connu (commençant par "com.google.")) crée une source de données 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 à la place les 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 du développeur qui est 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 un autre développeur lisant des types de données publics.
supprimer DELETE  /userId/dataSources/dataSourceId Supprime la source de données spécifiée. La requête échoue si la source de données contient des points de données.
obtenir GET  /userId/dataSources/dataSourceId Renvoie la source de données spécifiée.
list GET  /userId/dataSources Répertorie toutes les sources de données visibles par le développeur à l'aide des habilitations OAuth fournies. La 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 niveaux d'accès.
mettre à 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.

Utilisateurs.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.
list GET  /userId/dataSources/dataSourceId/dataPointChanges Requêtes de modification des points de données des utilisateurs pour une source de données particulière.

Users.dataSources.datasets

Pour en savoir plus sur la ressource "Users.dataSources.datasets", consultez la page Représentation de la ressource.

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 Supprime tous les points de données dont les heures de début et de fin ont un chevauchement avec 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 est supprimée. Pour les types de données dans lesquels la période représente une valeur cohérente (telle que com.google.activity.segment) et un point de données chevauche l'un des points de terminaison de l'ensemble de données, seule la partie chevauchant le point de données est supprimée.
obtenir 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 se chevauchent avec la plage spécifiée des heures de début et de fin minimales 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.
correctif PATCH  /userId/dataSources/dataSourceId/datasets/datasetId Ajoute des points de données à un ensemble de données. Vous n'avez pas besoin de créer l'ensemble de données précédemment. Tous les points de l'ensemble de données seront renvoyés avec des 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.

Utilisateurs.Ensemble de données

Pour en savoir plus sur la ressource "Users.dataset", consultez la page Représentation de la ressource.

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

Utilisateurs

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é.
list GET  /userId/sessions Répertorie les sessions déjà créées.
mettre à jour PUT  /userId/sessions/sessionId Met à jour ou insère une session donnée.