Users.dataSources

Définition d'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 inséré dans ce service ou lu à partir de celui-ci est associé à une source de données.

La source de données contient suffisamment d'informations pour identifier ses données de façon unique, y compris le matériel et l'application qui ont collecté et/ou transformé les données. Il contient également des métadonnées utiles, telles que les versions du matériel et des applications, ainsi que le type d'appareil.

Chaque source de données génère un flux de données unique, avec un identifiant unique. Toutes les modifications apportées à la source de données n'affectent pas l'identifiant de flux. 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 au même flux de données.

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

{
  "dataStreamId": string,
  "name": string,
  "dataStreamName": string,
  "type": string,
  "dataType": {
    "name": string,
    "field": [
      {
        "name": string,
        "format": string,
        "optional": boolean
      }
    ]
  },
  "device": {
    "uid": string,
    "type": string,
    "version": string,
    "model": string,
    "manufacturer": string
  },
  "application": {
    "packageName": string,
    "version": string,
    "detailsUrl": string,
    "name": string
  },
  "dataQualityStandard": [
    string
  ]
}
Nom de propriété Value Description Remarques
application nested object Informations sur une application qui transmet les données des capteurs à la plate-forme.
application.detailsUrl string URI facultatif pouvant être utilisé pour créer un lien vers l'application.
application.name string Nom de cette application. Cette étape est obligatoire pour les clients REST, mais nous n'imposons pas l'unicité de ce nom. Elle est fournie pour faciliter l'identification des développeurs qui souhaitent créer une application ou une source de données.
application.packageName string Nom du package de cette application. Il est utilisé comme identifiant unique lorsqu'il est créé par des applications Android, mais ne peut pas être spécifié par les clients REST. Le numéro de projet du développeur client REST sera reflété dans les ID de flux de données de la source de données plutôt que dans le champ packageName.
application.version string Version de l'application. Vous devez mettre à jour ce champ chaque fois que les modifications apportées à l'application affectent le calcul des données.
dataQualityStandard[] list NE REMPLACEZ PAS CE CHAMP. Il n'est jamais renseigné dans les réponses de la plate-forme et est ignoré dans les requêtes. Il sera complètement supprimé dans une prochaine version.
dataStreamId string Identifiant unique du flux de données produit par cette source de données. Cet identifiant inclut:

  • Fabricant, modèle et numéro de série (UID) de l'appareil physique.
  • Nom ou nom du package de l'application. Le nom de package est utilisé lorsque la source de données a été créée par une application Android. Le numéro de projet du développeur est utilisé lorsque la source de données a été créée par un client REST.
  • Type de la source de données.
  • Nom du flux de la source de données.
Notez que tous les attributs de la source de données ne sont pas utilisés dans l'identifiant de flux. Plus particulièrement, la version du matériel/de l'application n'est pas utilisée. Cela nous permet de conserver le même flux grâce aux mises à jour. Cela signifie également que deux objets DataSource peuvent représenter le même flux de données, même s'ils ne sont pas égaux.

Le format exact de l'ID de flux de données créé par une application Android est le suivant : type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName

Le format exact de l'ID de flux de données créé par un client REST est le suivant : type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName

Lorsque l'un des champs facultatifs qui composent l'ID de flux de données est absent, il est omis de l'ID de flux de données. L'ID de flux de données minimal minimal serait: type:dataType.name:developer project number

Enfin, le numéro de projet du développeur et l'ID utilisateur de l'appareil sont obscurcis lorsqu'ils sont lus par un client REST ou Android qui n'a pas créé la source de données. Seul le créateur de la source de données peut voir le numéro du projet de développeur sous une forme normale et claire. Cela signifie qu'un client verra un ensemble de données "data_stream_id" différent d'un autre client avec des identifiants différents.

dataStreamName string Le nom de flux identifie cette source de données de manière unique parmi toutes les sources du même type provenant du même producteur sous-jacent. Vous n'êtes pas obligé de définir le nom du flux, mais vous devez le faire chaque fois qu'une application expose deux flux pour le même type de données, ou lorsqu'un appareil est équipé de deux capteurs équivalents.
dataType nested object Le type de données définit le schéma d'un flux de données collecté par, inséré dans ou demandé par l'API Fitness.
dataType.field[] list Un champ représente une dimension d'un type de données.
dataType.field[].format string Différents formats compatibles pour chaque champ d'un type de données.

Les valeurs autorisées sont les suivantes :
  • "blob"
  • "floatList"
  • "floatPoint"
  • "integer"
  • "integerList"
  • "map"
  • "string"
dataType.field[].name string Définit le nom et le format des données. Contrairement aux noms de type de données, les noms de champs ne sont pas liés à un espace de noms et doivent être uniques au sein du type de données.
dataType.field[].optional boolean
dataType.name string Chaque type de données a un nom d'espace de noms unique. Tous les types de données de l'espace de noms com.google sont partagés au sein de la plate-forme.
device nested object Représentation d'un appareil intégré (tel qu'un téléphone ou un accessoire connecté) pouvant accueillir des capteurs.
device.manufacturer string Fabricant du produit/matériel.
device.model string Nom du modèle visible par l'utilisateur final pour l'appareil.
device.type string Constante représentant le type de l'appareil.

Les valeurs autorisées sont les suivantes :
  • "chestStrap"
  • "headMounted"
  • "phone"
  • "scale"
  • "smartDisplay"
  • "tablet"
  • "unknown"
  • "watch"
device.uid string Numéro de série ou autre identifiant unique du matériel. Ce champ est obscurci lorsqu'il est lu par un client REST ou Android qui n'a pas créé la source de données. Seul le créateur de la source de données verra le champ "uid" de manière claire et normale.

L'obscurcissement préserve l'égalité, c'est-à-dire, pour deux ID, si id1 == id2, obscurci(id1) == obscurci(id2).

device.version string Chaîne de version du matériel/logiciel de l'appareil.
name string Nom visible de l'utilisateur final pour cette source de données.
type string Constante décrivant le type de cette source de données. Indique si cette source de données produit des données brutes ou dérivées.

Les valeurs autorisées sont les suivantes :
  • "derived"
  • "raw"

Méthodes

créer
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
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
Renvoie la source de données spécifiée.
list
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
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.