Users.dataSources

Définition d'une source unique de données de capteurs. Les sources de données peuvent exposer des données brutes provenant de capteurs matériels installés 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. Plusieurs sources de données peuvent exister 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 l'appareil matériel et l'application qui les a collectées et/ou transformé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, associé à un identifiant unique. Toutes les modifications apportées à la source de données n'ont pas d'incidence sur l'identifiant de flux. Par conséquent, les données collectées par les versions mises à jour d'une même application ou d'un 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é Valeur Description Remarques
application nested object Informations sur une application qui transmet les données des capteurs à la plate-forme.
application.detailsUrl string URI facultatif permettant de renvoyer vers l'application.
application.name string Nom de cette application. Ce nom est obligatoire pour les clients REST, mais nous n'imposons pas l'unicité de ce nom. Il est fourni pour plus de commodité aux autres développeurs qui souhaitent identifier quel REST a créé une application ou une source de données.
application.packageName string Nom de package de cette application. Il est utilisé comme identifiant unique lorsqu'il est créé par les applications Android, mais ne peut pas être spécifié par les clients REST. Le numéro de projet de développeur des clients REST est reflété dans les ID de flux de données de la source de données, au lieu du nom de package.
application.version string Version de l'application. Vous devez mettre à jour ce champ chaque fois que l'application change d'une manière qui affecte le calcul des données.
dataQualityStandard[] list NE PAS AJOUTER CE CHAMP. Il n'est jamais renseigné dans les réponses de la plate-forme et est ignoré dans les requêtes. Elle sera complètement supprimée 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 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 de 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 de 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 du flux. En particulier, la version du matériel/de l'application n'est pas utilisée. Cela nous permet de conserver le même flux via des mises à jour de version. 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: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName

Lorsque l'un des champs facultatifs composant l'ID de flux de données est absent, il est omis de l'ID du flux de données. L'ID de flux de données viable minimal est le suivant: type:dataType.name:numéro de projet du développeur

Enfin, le numéro de projet du développeur et l'UID 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 verra le numéro de projet de développeur dans un format clair et normal. Cela signifie qu'un client voit un ensemble de data_stream_id différent de celui d'un autre client avec des identifiants différents.

dataStreamName string Le nom du flux identifie cette source de données de manière unique parmi les autres sources de données du même type provenant du même producteur sous-jacent. La définition du nom du flux est facultative, mais doit être effectuée chaque fois qu'une application expose deux flux pour le même type de données ou lorsqu'un appareil dispose de deux capteurs équivalents.
dataType nested object Le type de données définit le schéma d'un flux de données recueillies par l'API Fitness, qui y sont insérées ou qui y sont interrogées.
dataType.field[] list Un champ représente une dimension d'un type de données.
dataType.field[].format string Les différents formats acceptés pour chaque champ d'un type de données.

Les valeurs accepté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 uniquement être uniques au sein du type de données.
dataType.field[].optional boolean
dataType.name string Chaque type de données possède un nom unique et associé à un espace de noms. 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 de l'appareil visible par l'utilisateur final.
device.type string Constante représentant le type d'appareil

Les valeurs accepté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 voit le champ UID dans un format clair et normal.

L'obscurcissement préserve l'égalité ; c'est-à-dire avec 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 par 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 accepté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 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
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
Renvoie la source de données spécifiée.
liste
Liste 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
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.