Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / fitness_v1.users.dataSources.dataPointChanges.html
blob: 083dc5735ad78a81d367e5d60653963c56db936e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]75<h1><a href="fitness_v1.html">Fitness API</a> . <a href="fitness_v1.users.html">users</a> . <a href="fitness_v1.users.dataSources.html">dataSources</a> . <a href="fitness_v1.users.dataSources.dataPointChanges.html">dataPointChanges</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]78 <code><a href="#list">list(userId, dataSourceId, pageToken=None, limit=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Queries for user's data point changes for a particular data source.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]85 <code class="details" id="list">list(userId, dataSourceId, pageToken=None, limit=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86 <pre>Queries for user&#x27;s data point changes for a particular data source.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87
88Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]89 userId: string, List data points for the person identified. Use &lt;code&gt;me&lt;/code&gt; to indicate
90the authenticated user. Only &lt;code&gt;me&lt;/code&gt; is supported at this time. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 dataSourceId: string, The data stream ID of the data source that created the dataset. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]92 pageToken: string, The continuation token, which is used to page through large result sets.
93To get the next page of results, set this parameter to the value of
94&lt;code&gt;nextPageToken&lt;/code&gt; from the previous response.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]95 limit: integer, If specified, no more than this many data point changes will be included
96in the response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]97 x__xgafv: string, V1 error format.
98 Allowed values
99 1 - v1 error format
100 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101
102Returns:
103 An object of the form:
104
105 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]106 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, which is used to page through large result sets.
107 # Provide this value in a subsequent request to return the next page of
108 # results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;insertedDataPoint&quot;: [ # Inserted data points for the user.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]110 { # Represents a single data point, generated by a particular data source. A
111 # data point holds a value for each field, an end timestamp and an optional
112 # start time. The exact semantics of each of these attributes are specified in
113 # the documentation for the particular data type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]115 # A data point can represent an instantaneous measurement, reading or input
116 # observation, as well as averages or aggregates over a time interval. Check
117 # the data type documentation to determine which is the case for a particular
118 # data type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 #
120 # Data points always contain one value for each field of the data type.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121 &quot;computationTimeMillis&quot;: &quot;A String&quot;, # DO NOT USE THIS FIELD. It is ignored, and not stored.
122 &quot;dataTypeName&quot;: &quot;A String&quot;, # The data type defining the format of the values in this data point.
123 &quot;endTimeNanos&quot;: &quot;A String&quot;, # The end time of the interval represented by this data point, in
124 # nanoseconds since epoch.
125 &quot;startTimeNanos&quot;: &quot;A String&quot;, # The start time of the interval represented by this data point, in
126 # nanoseconds since epoch.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]127 &quot;originDataSourceId&quot;: &quot;A String&quot;, # If the data point is contained in a dataset for a derived data source,
128 # this field will be populated with the data source stream ID that created
129 # the data point originally.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]131 # WARNING: do not rely on this field for anything other than debugging. The
132 # value of this field, if it is set at all, is an implementation detail and
133 # is not guaranteed to remain consistent.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]134 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # Indicates the last time this data point was modified. Useful only in
135 # contexts where we are listing the data changes, rather than representing
136 # the current state of the data.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;rawTimestampNanos&quot;: &quot;A String&quot;, # The raw timestamp from the original SensorEvent.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]138 &quot;value&quot;: [ # Values of each data type field for the data point. It is expected that each
139 # value corresponding to a data type field will occur in the same order that
140 # the field is listed with in the data type specified in a data source.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]142 # Only one of integer and floating point fields will be populated, depending
143 # on the format enum value within data source&#x27;s type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 { # Holder object for the value of a single field in a data point.
145 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]146 # A field value has a particular format and is only ever set to one of an
147 # integer or a floating point value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]148 &quot;stringVal&quot;: &quot;A String&quot;, # String value. When this is set, other values must not be set.
149 # Strings should be kept small whenever possible. Data streams with large
150 # string values and high data frequency may be down sampled.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]151 &quot;mapVal&quot;: [ # Map value. The valid key space and units for the corresponding value
152 # of each entry should be documented as part of the data type definition.
153 # Keys should be kept small whenever possible. Data streams with large keys
154 # and high data frequency may be down sampled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &quot;value&quot;: { # Holder object for the value of an entry in a map field of a data point.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 #
158 # A map value supports a subset of the formats that the regular Value supports.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;fpVal&quot;: 3.14, # Floating point value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]161 &quot;key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 },
163 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]164 &quot;fpVal&quot;: 3.14, # Floating point value. When this is set, other values must not be set.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]165 &quot;intVal&quot;: 42, # Integer value. When this is set, other values must not be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 },
167 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 },
169 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]170 &quot;deletedDataPoint&quot;: [ # Deleted data points for the user. Note, for modifications this should be
171 # parsed before handling insertions.
172 { # Represents a single data point, generated by a particular data source. A
173 # data point holds a value for each field, an end timestamp and an optional
174 # start time. The exact semantics of each of these attributes are specified in
175 # the documentation for the particular data type.
176 #
177 # A data point can represent an instantaneous measurement, reading or input
178 # observation, as well as averages or aggregates over a time interval. Check
179 # the data type documentation to determine which is the case for a particular
180 # data type.
181 #
182 # Data points always contain one value for each field of the data type.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]183 &quot;computationTimeMillis&quot;: &quot;A String&quot;, # DO NOT USE THIS FIELD. It is ignored, and not stored.
184 &quot;dataTypeName&quot;: &quot;A String&quot;, # The data type defining the format of the values in this data point.
185 &quot;endTimeNanos&quot;: &quot;A String&quot;, # The end time of the interval represented by this data point, in
186 # nanoseconds since epoch.
187 &quot;startTimeNanos&quot;: &quot;A String&quot;, # The start time of the interval represented by this data point, in
188 # nanoseconds since epoch.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 &quot;originDataSourceId&quot;: &quot;A String&quot;, # If the data point is contained in a dataset for a derived data source,
190 # this field will be populated with the data source stream ID that created
191 # the data point originally.
192 #
193 # WARNING: do not rely on this field for anything other than debugging. The
194 # value of this field, if it is set at all, is an implementation detail and
195 # is not guaranteed to remain consistent.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]196 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # Indicates the last time this data point was modified. Useful only in
197 # contexts where we are listing the data changes, rather than representing
198 # the current state of the data.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]199 &quot;rawTimestampNanos&quot;: &quot;A String&quot;, # The raw timestamp from the original SensorEvent.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]200 &quot;value&quot;: [ # Values of each data type field for the data point. It is expected that each
201 # value corresponding to a data type field will occur in the same order that
202 # the field is listed with in the data type specified in a data source.
203 #
204 # Only one of integer and floating point fields will be populated, depending
205 # on the format enum value within data source&#x27;s type field.
206 { # Holder object for the value of a single field in a data point.
207 #
208 # A field value has a particular format and is only ever set to one of an
209 # integer or a floating point value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]210 &quot;stringVal&quot;: &quot;A String&quot;, # String value. When this is set, other values must not be set.
211 # Strings should be kept small whenever possible. Data streams with large
212 # string values and high data frequency may be down sampled.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]213 &quot;mapVal&quot;: [ # Map value. The valid key space and units for the corresponding value
214 # of each entry should be documented as part of the data type definition.
215 # Keys should be kept small whenever possible. Data streams with large keys
216 # and high data frequency may be down sampled.
217 {
218 &quot;value&quot;: { # Holder object for the value of an entry in a map field of a data point.
219 #
220 # A map value supports a subset of the formats that the regular Value supports.
221 &quot;fpVal&quot;: 3.14, # Floating point value.
222 },
223 &quot;key&quot;: &quot;A String&quot;,
224 },
225 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]226 &quot;fpVal&quot;: 3.14, # Floating point value. When this is set, other values must not be set.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]227 &quot;intVal&quot;: 42, # Integer value. When this is set, other values must not be set.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]228 },
229 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]230 },
231 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]232 &quot;dataSourceId&quot;: &quot;A String&quot;, # The data stream ID of the data source with data point changes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 }</pre>
234</div>
235
236<div class="method">
237 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
238 <pre>Retrieves the next page of results.
239
240Args:
241 previous_request: The request for the previous page. (required)
242 previous_response: The response from the request for the previous page. (required)
243
244Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 page. Returns None if there are no more items in the collection.
247 </pre>
248</div>
249
250</body></html>