Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7d5badbac4f925c1867e20b50cf0a1a70a5fb573 / . / docs / dyn / fitness_v1.users.dataSources.html
blob: 2d9311e6d32b1adf4c2eef1e280f40ddb6f74fd2 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="fitness_v1.html">Fitness</a> . <a href="fitness_v1.users.html">users</a> . <a href="fitness_v1.users.dataSources.html">dataSources</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="fitness_v1.users.dataSources.datasets.html">datasets()</a></code>
79</p>
80<p class="firstline">Returns the datasets Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#create">create(userId, body)</a></code></p>
84<p class="firstline">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.</p>
85<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86 <code><a href="#delete">delete(userId, dataSourceId)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]87<p class="firstline">Deletes the specified data source. The request will fail if the data source contains any data points.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]88<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89 <code><a href="#get">get(userId, dataSourceId)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]90<p class="firstline">Returns the specified data source.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]91<p class="toc_element">
92 <code><a href="#list">list(userId, dataTypeName=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]93<p class="firstline">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.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]94<p class="toc_element">
95 <code><a href="#patch">patch(userId, dataSourceId, body)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]96<p class="firstline">Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]97<p class="toc_element">
98 <code><a href="#update">update(userId, dataSourceId, body)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]99<p class="firstline">Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]100<h3>Method Details</h3>
101<div class="method">
102 <code class="details" id="create">create(userId, body)</code>
103 <pre>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.
104
105Args:
106 userId: string, Create the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{ # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]111 #
112 # 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.
113 #
114 # 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.
115 "name": "A String", # An end-user visible name for this data source.
116 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]117 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]118 "field": [ # A field represents one dimension of a data type.
119 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
120 #
121 # This message is only instantiated in code and not used for wire comms or stored in any way.
122 "optional": True or False,
123 "name": "A 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.
124 "format": "A String", # The different supported formats for each field in a data type.
125 },
126 ],
127 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
128 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]129 "dataQualityStandard": [
130 "A String",
131 ],
132 "application": { # Information about an application which feeds sensor data into the platform.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]133 "packageName": "A 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.
134 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
135 "name": "A 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.
136 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
137 },
138 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
139 #
140 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
141 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
142 # - Display the source of data to the user (by using the device make / model)
143 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
144 # - Build different analysis models for each device/version.
145 "model": "A String", # End-user visible model name for the device.
146 "version": "A String", # Version string for the device hardware/software.
147 "type": "A String", # A constant representing the type of the device.
148 "uid": "A 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.
149 "manufacturer": "A String", # Manufacturer of the product/hardware.
150 },
151 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]152 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]153 #
154 # - The physical device's manufacturer, model, and serial number (UID).
155 # - 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.
156 # - The data source's type.
157 # - 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.
158 #
159 # 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
160 #
161 # 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
162 #
163 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
164 #
165 # 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.
166 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
167}
168
169
170Returns:
171 An object of the form:
172
173 { # 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.
174 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]175 # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]176 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]177 # 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.
178 "name": "A String", # An end-user visible name for this data source.
179 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]180 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]181 "field": [ # A field represents one dimension of a data type.
182 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
183 #
184 # This message is only instantiated in code and not used for wire comms or stored in any way.
185 "optional": True or False,
186 "name": "A 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.
187 "format": "A String", # The different supported formats for each field in a data type.
188 },
189 ],
190 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
191 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]192 "dataQualityStandard": [
193 "A String",
194 ],
195 "application": { # Information about an application which feeds sensor data into the platform.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]196 "packageName": "A 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.
197 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
198 "name": "A 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.
199 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
200 },
201 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
202 #
203 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
204 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
205 # - Display the source of data to the user (by using the device make / model)
206 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
207 # - Build different analysis models for each device/version.
208 "model": "A String", # End-user visible model name for the device.
209 "version": "A String", # Version string for the device hardware/software.
210 "type": "A String", # A constant representing the type of the device.
211 "uid": "A 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.
212 "manufacturer": "A String", # Manufacturer of the product/hardware.
213 },
214 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]215 #
216 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]217 # - The physical device's manufacturer, model, and serial number (UID).
218 # - 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.
219 # - The data source's type.
220 # - 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]221 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222 # 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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]223 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]224 # 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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]225 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]226 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]227 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]228 # 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.
229 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]230 }</pre>
231</div>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]232
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]233<div class="method">
234 <code class="details" id="delete">delete(userId, dataSourceId)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]235 <pre>Deletes the specified data source. The request will fail if the data source contains any data points.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]236
237Args:
238 userId: string, Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
239 dataSourceId: string, The data stream ID of the data source to delete. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]240
241Returns:
242 An object of the form:
243
244 { # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]245 #
246 # 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.
247 #
248 # 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.
249 "name": "A String", # An end-user visible name for this data source.
250 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]251 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]252 "field": [ # A field represents one dimension of a data type.
253 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
254 #
255 # This message is only instantiated in code and not used for wire comms or stored in any way.
256 "optional": True or False,
257 "name": "A 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.
258 "format": "A String", # The different supported formats for each field in a data type.
259 },
260 ],
261 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
262 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]263 "dataQualityStandard": [
264 "A String",
265 ],
266 "application": { # Information about an application which feeds sensor data into the platform.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]267 "packageName": "A 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.
268 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
269 "name": "A 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.
270 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
271 },
272 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]273 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]274 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
275 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
276 # - Display the source of data to the user (by using the device make / model)
277 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
278 # - Build different analysis models for each device/version.
279 "model": "A String", # End-user visible model name for the device.
280 "version": "A String", # Version string for the device hardware/software.
281 "type": "A String", # A constant representing the type of the device.
282 "uid": "A 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.
283 "manufacturer": "A String", # Manufacturer of the product/hardware.
284 },
285 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]286 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]287 #
288 # - The physical device's manufacturer, model, and serial number (UID).
289 # - 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.
290 # - The data source's type.
291 # - 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.
292 #
293 # 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
294 #
295 # 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
296 #
297 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
298 #
299 # 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.
300 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
301 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]302</div>
303
304<div class="method">
305 <code class="details" id="get">get(userId, dataSourceId)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]306 <pre>Returns the specified data source.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]307
308Args:
309 userId: string, Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
310 dataSourceId: string, The data stream ID of the data source to retrieve. (required)
311
312Returns:
313 An object of the form:
314
315 { # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]316 #
317 # 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.
318 #
319 # 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.
320 "name": "A String", # An end-user visible name for this data source.
321 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]322 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]323 "field": [ # A field represents one dimension of a data type.
324 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
325 #
326 # This message is only instantiated in code and not used for wire comms or stored in any way.
327 "optional": True or False,
328 "name": "A 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.
329 "format": "A String", # The different supported formats for each field in a data type.
330 },
331 ],
332 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
333 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]334 "dataQualityStandard": [
335 "A String",
336 ],
337 "application": { # Information about an application which feeds sensor data into the platform.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]338 "packageName": "A 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.
339 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
340 "name": "A 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.
341 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
342 },
343 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]344 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]345 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
346 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
347 # - Display the source of data to the user (by using the device make / model)
348 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
349 # - Build different analysis models for each device/version.
350 "model": "A String", # End-user visible model name for the device.
351 "version": "A String", # Version string for the device hardware/software.
352 "type": "A String", # A constant representing the type of the device.
353 "uid": "A 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.
354 "manufacturer": "A String", # Manufacturer of the product/hardware.
355 },
356 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]357 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]358 #
359 # - The physical device's manufacturer, model, and serial number (UID).
360 # - 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.
361 # - The data source's type.
362 # - 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.
363 #
364 # 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
365 #
366 # 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
367 #
368 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
369 #
370 # 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.
371 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
372 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]373</div>
374
375<div class="method">
376 <code class="details" id="list">list(userId, dataTypeName=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]377 <pre>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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]378
379Args:
380 userId: string, List data sources for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
381 dataTypeName: string, The names of data types to include in the list. If not specified, all data sources will be returned. (repeated)
382
383Returns:
384 An object of the form:
385
386 {
387 "dataSource": [ # A previously created data source.
388 { # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]389 #
390 # 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.
391 #
392 # 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.
393 "name": "A String", # An end-user visible name for this data source.
394 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]395 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]396 "field": [ # A field represents one dimension of a data type.
397 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
398 #
399 # This message is only instantiated in code and not used for wire comms or stored in any way.
400 "optional": True or False,
401 "name": "A 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.
402 "format": "A String", # The different supported formats for each field in a data type.
403 },
404 ],
405 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]406 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]407 "dataQualityStandard": [
408 "A String",
409 ],
410 "application": { # Information about an application which feeds sensor data into the platform.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]411 "packageName": "A 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.
412 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
413 "name": "A 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.
414 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
415 },
416 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
417 #
418 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
419 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
420 # - Display the source of data to the user (by using the device make / model)
421 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
422 # - Build different analysis models for each device/version.
423 "model": "A String", # End-user visible model name for the device.
424 "version": "A String", # Version string for the device hardware/software.
425 "type": "A String", # A constant representing the type of the device.
426 "uid": "A 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.
427 "manufacturer": "A String", # Manufacturer of the product/hardware.
428 },
429 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
430 #
431 #
432 # - The physical device's manufacturer, model, and serial number (UID).
433 # - 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.
434 # - The data source's type.
435 # - 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.
436 #
437 # 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
438 #
439 # 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
440 #
441 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
442 #
443 # 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.
444 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
445 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]446 ],
447 }</pre>
448</div>
449
450<div class="method">
451 <code class="details" id="patch">patch(userId, dataSourceId, body)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]452 <pre>Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]453
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]454Data sources are identified by their dataStreamId. This method supports patch semantics.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]455
456Args:
457 userId: string, Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
458 dataSourceId: string, The data stream ID of the data source to update. (required)
459 body: object, The request body. (required)
460 The object takes the form of:
461
462{ # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]463 #
464 # 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.
465 #
466 # 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.
467 "name": "A String", # An end-user visible name for this data source.
468 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]469 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]470 "field": [ # A field represents one dimension of a data type.
471 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
472 #
473 # This message is only instantiated in code and not used for wire comms or stored in any way.
474 "optional": True or False,
475 "name": "A 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.
476 "format": "A String", # The different supported formats for each field in a data type.
477 },
478 ],
479 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
480 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]481 "dataQualityStandard": [
482 "A String",
483 ],
484 "application": { # Information about an application which feeds sensor data into the platform.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]485 "packageName": "A 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.
486 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
487 "name": "A 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.
488 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
489 },
490 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
491 #
492 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
493 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
494 # - Display the source of data to the user (by using the device make / model)
495 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
496 # - Build different analysis models for each device/version.
497 "model": "A String", # End-user visible model name for the device.
498 "version": "A String", # Version string for the device hardware/software.
499 "type": "A String", # A constant representing the type of the device.
500 "uid": "A 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.
501 "manufacturer": "A String", # Manufacturer of the product/hardware.
502 },
503 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]504 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]505 #
506 # - The physical device's manufacturer, model, and serial number (UID).
507 # - 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.
508 # - The data source's type.
509 # - 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.
510 #
511 # 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
512 #
513 # 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
514 #
515 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
516 #
517 # 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.
518 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
519}
520
521
522Returns:
523 An object of the form:
524
525 { # 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.
526 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]527 # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]528 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]529 # 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.
530 "name": "A String", # An end-user visible name for this data source.
531 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]532 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]533 "field": [ # A field represents one dimension of a data type.
534 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
535 #
536 # This message is only instantiated in code and not used for wire comms or stored in any way.
537 "optional": True or False,
538 "name": "A 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.
539 "format": "A String", # The different supported formats for each field in a data type.
540 },
541 ],
542 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
543 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]544 "dataQualityStandard": [
545 "A String",
546 ],
547 "application": { # Information about an application which feeds sensor data into the platform.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]548 "packageName": "A 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.
549 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
550 "name": "A 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.
551 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
552 },
553 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
554 #
555 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
556 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
557 # - Display the source of data to the user (by using the device make / model)
558 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
559 # - Build different analysis models for each device/version.
560 "model": "A String", # End-user visible model name for the device.
561 "version": "A String", # Version string for the device hardware/software.
562 "type": "A String", # A constant representing the type of the device.
563 "uid": "A 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.
564 "manufacturer": "A String", # Manufacturer of the product/hardware.
565 },
566 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]567 #
568 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]569 # - The physical device's manufacturer, model, and serial number (UID).
570 # - 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.
571 # - The data source's type.
572 # - 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]573 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]574 # 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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]575 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]576 # 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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]577 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]578 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]579 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]580 # 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.
581 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]582 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]583</div>
584
585<div class="method">
586 <code class="details" id="update">update(userId, dataSourceId, body)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]587 <pre>Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]588
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]589Data sources are identified by their dataStreamId.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]590
591Args:
592 userId: string, Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
593 dataSourceId: string, The data stream ID of the data source to update. (required)
594 body: object, The request body. (required)
595 The object takes the form of:
596
597{ # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]598 #
599 # 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.
600 #
601 # 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.
602 "name": "A String", # An end-user visible name for this data source.
603 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]604 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]605 "field": [ # A field represents one dimension of a data type.
606 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
607 #
608 # This message is only instantiated in code and not used for wire comms or stored in any way.
609 "optional": True or False,
610 "name": "A 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.
611 "format": "A String", # The different supported formats for each field in a data type.
612 },
613 ],
614 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
615 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]616 "dataQualityStandard": [
617 "A String",
618 ],
619 "application": { # Information about an application which feeds sensor data into the platform.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]620 "packageName": "A 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.
621 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
622 "name": "A 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.
623 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
624 },
625 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
626 #
627 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
628 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
629 # - Display the source of data to the user (by using the device make / model)
630 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
631 # - Build different analysis models for each device/version.
632 "model": "A String", # End-user visible model name for the device.
633 "version": "A String", # Version string for the device hardware/software.
634 "type": "A String", # A constant representing the type of the device.
635 "uid": "A 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.
636 "manufacturer": "A String", # Manufacturer of the product/hardware.
637 },
638 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]639 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]640 #
641 # - The physical device's manufacturer, model, and serial number (UID).
642 # - 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.
643 # - The data source's type.
644 # - 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.
645 #
646 # 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
647 #
648 # 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
649 #
650 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
651 #
652 # 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.
653 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
654}
655
656
657Returns:
658 An object of the form:
659
660 { # 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.
661 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]662 # 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]663 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]664 # 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.
665 "name": "A String", # An end-user visible name for this data source.
666 "dataStreamName": "A 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]667 "dataType": { # The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]668 "field": [ # A field represents one dimension of a data type.
669 { # In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.).
670 #
671 # This message is only instantiated in code and not used for wire comms or stored in any way.
672 "optional": True or False,
673 "name": "A 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.
674 "format": "A String", # The different supported formats for each field in a data type.
675 },
676 ],
677 "name": "A String", # Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
678 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]679 "dataQualityStandard": [
680 "A String",
681 ],
682 "application": { # Information about an application which feeds sensor data into the platform.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]683 "packageName": "A 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.
684 "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
685 "name": "A 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.
686 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
687 },
688 "device": { # Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. # Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
689 #
690 # The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including:
691 # - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance)
692 # - Display the source of data to the user (by using the device make / model)
693 # - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone)
694 # - Build different analysis models for each device/version.
695 "model": "A String", # End-user visible model name for the device.
696 "version": "A String", # Version string for the device hardware/software.
697 "type": "A String", # A constant representing the type of the device.
698 "uid": "A 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.
699 "manufacturer": "A String", # Manufacturer of the product/hardware.
700 },
701 "dataStreamId": "A String", # A unique identifier for the data stream produced by this data source. The identifier includes:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]702 #
703 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]704 # - The physical device's manufacturer, model, and serial number (UID).
705 # - 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.
706 # - The data source's type.
707 # - 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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]708 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]709 # 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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]710 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]711 # 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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]712 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]713 # 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 minnimum viable data stream ID would be: type:dataType.name:developer project number
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]714 #
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]715 # 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.
716 "type": "A String", # A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]717 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]718</div>
719
720</body></html>