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 sur des appareils locaux ou associés. Elles peuvent également exposer des données dérivées, créées par la transformation ou la 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 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 dispositif 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 produit 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 du flux. 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 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 des données de 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. Ce nom est obligatoire pour les clients REST, mais nous n'appliquons pas l'unicité de ce nom. Elle est fournie à des fins de commodité pour les autres développeurs qui souhaitent identifier quel REST a créé 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 les applications Android, mais ne peut pas être spécifié par les clients REST. Pour les clients REST, le numéro de leur projet de développeur est reflété dans les ID des flux de données de la source de données, au lieu du nom du package.
application.version string Version de l'application. Vous devez mettre à jour ce champ chaque fois que l'application change d'une façon qui affecte le calcul des données.
dataQualityStandard[] list NE METTEZ PAS CE CHAMP. Il n'est jamais renseigné dans les réponses de la plate-forme et est ignoré dans les requêtes. Elle sera entièrement 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 les éléments suivants:

  • Fabricant, modèle et numéro de série (UID) de l'appareil physique.
  • Nom du package ou 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 du flux. Plus précisément, la version du matériel/de l'application n'est pas utilisée. Cela nous permet de conserver le même flux lors 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 le suivant: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName

Si l'un des champs facultatifs qui constituent l'ID du flux de données est absent, il est omis de l'ID. L'ID de flux de données minimum viable serait le suivant: type:dataType.name:developer project number

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 peut voir le numéro de projet du développeur sous une forme claire et normale. Cela signifie qu'un client verra un ensemble d'ID data_stream_id différent de celui d'un autre client avec des identifiants différents.

dataStreamName string Le nom du flux identifie de manière unique cette source de données spécifique parmi d'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 possède deux capteurs équivalents.
dataType nested object Le type de données définit le schéma d'un flux de données collectées, insérées ou interrogées à partir de l'API Fitness.
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 possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "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 associés à des espaces de noms et ne doivent être uniques qu'au sein du type de données.
dataType.field[].optional boolean
dataType.name string Chaque type de données possède un nom unique, associé à un espace de noms. Tous les types de données de l'espace de noms com.google sont partagés dans 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 de modèle visible par l'utilisateur final de l'appareil.
device.type string Constante représentant le type d'appareil

Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "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 de l'UID sous forme claire et normale.

L'obscurcissement préserve l'égalité. c'est-à-dire, pour deux ID donnés, 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 possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "derived"
  • "raw"

Méthodes

créer
Crée une source de données unique parmi toutes celles 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. Ils peuvent également exposer des données dérivées, créées en transformant ou en fusionnant d'autres données sources. Plusieurs sources de données peuvent exister pour le même type de données. Toutes les données dans chaque ensemble de données inséré dans Fitness API ou lu à partir de celle-ci possède une la source de données associée.

Chaque source de données produit un flux unique de mises à jour de l'ensemble de données, avec l'identifiant unique de la source de données. Toutes les modifications apportées à la source de données n'affectent pas de flux de données, de sorte que les données collectées par les versions mises à jour application/appareil peuvent toujours être considérés comme appartenant aux mêmes source.

Les sources de données sont identifiées à l'aide d'une chaîne générée par le serveur, basée sur sur le contenu de la source en cours de création. dataStreamId ne doit pas être défini lors de l'appel de cette méthode. Il généré automatiquement par le serveur au format correct. Si dataStreamId est défini, il doit correspondre au format que généré par le serveur. Ce format est une combinaison de certains champs source de données, et a un ordre spécifique. Dans le cas contraire, la requête échoue et génère une erreur.

spécifier un DataType qui n'est pas un type connu (commençant par "com.google.") crée 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. utiliser des types de données standards à la place.

En plus des champs de source de données inclus dans l'ID de la source de données, Numéro de projet du développeur authentifié lors de la création des données source est incluse. Ce numéro de projet de développeur est obscurci lors de la lecture par tout 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 les données la source contient des points de données.
get
Renvoie la source de données spécifiée.
liste
Répertorie toutes les sources de données visibles par le développeur à l'aide du protocole OAuth champs d'application fournis. Cette liste n'est pas exhaustive. l'utilisateur peut avoir les sources de données visibles uniquement par les autres développeurs ou les appels utilisant d'autres champs d'application.
mise à jour
Met à jour la source de données spécifiée. dataStreamId dataType, type, dataStreamName et device, à l'exception de version, ne peut pas être modifié.

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