Users.dataSources

Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source. 

The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type. 

Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "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
  ]
}
Property name Value Description Notes
application nested object Information about an application which feeds sensor data into the platform.
application.detailsUrl string An optional URI that can be used to link back to the application.
application.name string The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
application.packageName string Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
application.version string Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
dataQualityStandard[] list

dataStreamId string A unique identifier for the data stream produced by this data source. The identifier includes:

  • The physical device's manufacturer, model, and serial number (UID).
  • The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client.
  • The data source's type.
  • The data source's stream name.
Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal.

The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName

The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName

When any of the optional fields that comprise of the data stream ID are blank, they will be omitted from the data stream ID. The minimum viable data stream ID would be: type:dataType.name:developer project number

Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form.

dataStreamName string The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
dataType nested object The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
dataType.field[] list A field represents one dimension of a data type.
dataType.field[].format string The different supported formats for each field in a data type.

Acceptable values are:
  • "blob"
  • "floatList"
  • "floatPoint"
  • "integer"
  • "integerList"
  • "map"
  • "string"
dataType.field[].name string Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
dataType.field[].optional boolean
dataType.name string Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
device nested object Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
device.manufacturer string Manufacturer of the product/hardware.
device.model string End-user visible model name for the device.
device.type string A constant representing the type of the device.

Acceptable values are:
  • "chestStrap"
  • "headMounted"
  • "phone"
  • "scale"
  • "tablet"
  • "unknown"
  • "watch"
device.uid string The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.

device.version string Version string for the device hardware/software.
name string An end-user visible name for this data source.
type string A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.

Acceptable values are:
  • "derived"
  • "raw"

Methods

create
Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.
delete
Deletes the specified data source. The request will fail if the data source contains any data points.
get
Returns the specified data source.
list
Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes.
patch
Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.

Data sources are identified by their dataStreamId. This method supports patch semantics.
update
Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.

Data sources are identified by their dataStreamId.

发送以下问题的反馈:

此网页
Google Fit
Google Fit