Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / fitness_v1.users.dataSources.datasets.html
blob: bab8b49a77946e35797acb08a1d979cbf89ab660 [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
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.datasets.html">datasets</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]78 <code><a href="#delete">delete(userId, dataSourceId, datasetId, modifiedTimeMillis=None, currentTimeMillis=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Performs an inclusive delete of all data points whose start and end times</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]80<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]81 <code><a href="#get">get(userId, dataSourceId, datasetId, limit=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns a dataset containing all data points whose start and end times</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]83<p class="toc_element">
84 <code><a href="#get_next">get_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]87 <code><a href="#patch">patch(userId, dataSourceId, datasetId, body=None, currentTimeMillis=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Adds data points to a dataset. The dataset need not be previously created.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]89<p class="toc_element">
90 <code><a href="#patch_next">patch_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]94 <code class="details" id="delete">delete(userId, dataSourceId, datasetId, modifiedTimeMillis=None, currentTimeMillis=None, x__xgafv=None)</code>
95 <pre>Performs an inclusive delete of all data points whose start and end times
96have any overlap with the time range specified by the dataset ID. For most
97data types, the entire data point will be deleted. For data types where the
98time span represents a consistent value (such as
99&lt;code&gt;com.google.activity.segment&lt;/code&gt;), and a data point straddles
100either end point of the dataset, only the overlapping portion of the data
101point will be deleted.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]102
103Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]104 userId: string, Delete a dataset for the person identified. Use &lt;code&gt;me&lt;/code&gt; to indicate
105the authenticated user. Only &lt;code&gt;me&lt;/code&gt; is supported at this time. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]106 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]107 datasetId: string, Dataset identifier that is a composite of the minimum data point start time
108and maximum data point end time represented as nanoseconds from the epoch.
109The ID is formatted like: &quot;&lt;var&gt;startTime&lt;/var&gt;-&lt;var&gt;endTime&lt;/var&gt;&quot;
110where &lt;var&gt;startTime&lt;/var&gt; and &lt;var&gt;endTime&lt;/var&gt; are 64 bit integers. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111 modifiedTimeMillis: string, When the operation was performed on the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]112 currentTimeMillis: string, The client&#x27;s current time in milliseconds since epoch.
113 x__xgafv: string, V1 error format.
114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]117</pre>
118</div>
119
120<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]121 <code class="details" id="get">get(userId, dataSourceId, datasetId, limit=None, pageToken=None, x__xgafv=None)</code>
122 <pre>Returns a dataset containing all data points whose start and end times
123overlap with the specified range of the dataset minimum start time and
124maximum end time. Specifically, any data point whose start time is less
125than or equal to the dataset end time and whose end time is greater than or
126equal to the dataset start time.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]127
128Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]129 userId: string, Retrieve a dataset for the person identified. Use &lt;code&gt;me&lt;/code&gt; to
130indicate the authenticated user. Only &lt;code&gt;me&lt;/code&gt; is supported at this
131time. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]132 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]133 datasetId: string, Dataset identifier that is a composite of the minimum data point start time
134and maximum data point end time represented as nanoseconds from the epoch.
135The ID is formatted like: &quot;&lt;var&gt;startTime&lt;/var&gt;-&lt;var&gt;endTime&lt;/var&gt;&quot;
136where &lt;var&gt;startTime&lt;/var&gt; and &lt;var&gt;endTime&lt;/var&gt; are 64 bit integers. (required)
137 limit: integer, If specified, no more than this many data points will be included in the
138dataset. If there are more data points in the dataset, nextPageToken
139will be set in the dataset response.
140 pageToken: string, The continuation token, which is used to page through large datasets.
141To get the next page of a dataset, set this parameter to the value of
142&lt;code&gt;nextPageToken&lt;/code&gt; from the previous response. Each subsequent
143call will yield a partial dataset with data point end timestamps that are
144strictly smaller than those in the previous partial response.
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]149
150Returns:
151 An object of the form:
152
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]153 { # A dataset represents a projection container for data points. They do not
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]154 # carry any info of their own. Datasets represent a set of data points from a
155 # particular data source. A data point can be found in more than one dataset.
156 &quot;dataSourceId&quot;: &quot;A String&quot;, # The data stream ID of the data source that created the points in this
157 # dataset.
158 &quot;maxEndTimeNs&quot;: &quot;A String&quot;, # The largest end time of all data points in this possibly partial
159 # representation of the dataset. Time is in nanoseconds from epoch. This
160 # should also match the second part of the dataset identifier.
161 &quot;minStartTimeNs&quot;: &quot;A String&quot;, # The smallest start time of all data points in this possibly partial
162 # representation of the dataset. Time is in nanoseconds from epoch. This
163 # should also match the first part of the dataset identifier.
164 &quot;point&quot;: [ # A partial list of data points contained in the dataset, ordered by largest
165 # endTimeNanos first. This list is considered complete when retrieving a
166 # small dataset and partial when patching a dataset or retrieving a dataset
167 # that is too large to include in a single response.
168 { # Represents a single data point, generated by a particular data source. A
169 # data point holds a value for each field, an end timestamp and an optional
170 # start time. The exact semantics of each of these attributes are specified in
171 # the documentation for the particular data type.
172 #
173 # A data point can represent an instantaneous measurement, reading or input
174 # observation, as well as averages or aggregates over a time interval. Check
175 # the data type documentation to determine which is the case for a particular
176 # data type.
177 #
178 # Data points always contain one value for each field of the data type.
179 &quot;computationTimeMillis&quot;: &quot;A String&quot;, # DO NOT USE THIS FIELD. It is ignored, and not stored.
180 &quot;dataTypeName&quot;: &quot;A String&quot;, # The data type defining the format of the values in this data point.
181 &quot;endTimeNanos&quot;: &quot;A String&quot;, # The end time of the interval represented by this data point, in
182 # nanoseconds since epoch.
183 &quot;startTimeNanos&quot;: &quot;A String&quot;, # The start time of the interval represented by this data point, in
184 # nanoseconds since epoch.
185 &quot;originDataSourceId&quot;: &quot;A String&quot;, # If the data point is contained in a dataset for a derived data source,
186 # this field will be populated with the data source stream ID that created
187 # the data point originally.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]188 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 # WARNING: do not rely on this field for anything other than debugging. The
190 # value of this field, if it is set at all, is an implementation detail and
191 # is not guaranteed to remain consistent.
192 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # Indicates the last time this data point was modified. Useful only in
193 # contexts where we are listing the data changes, rather than representing
194 # the current state of the data.
195 &quot;rawTimestampNanos&quot;: &quot;A String&quot;, # The raw timestamp from the original SensorEvent.
196 &quot;value&quot;: [ # Values of each data type field for the data point. It is expected that each
197 # value corresponding to a data type field will occur in the same order that
198 # the field is listed with in the data type specified in a data source.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]199 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]200 # Only one of integer and floating point fields will be populated, depending
201 # on the format enum value within data source&#x27;s type field.
202 { # Holder object for the value of a single field in a data point.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]203 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]204 # A field value has a particular format and is only ever set to one of an
205 # integer or a floating point value.
206 &quot;stringVal&quot;: &quot;A String&quot;, # String value. When this is set, other values must not be set.
207 # Strings should be kept small whenever possible. Data streams with large
208 # string values and high data frequency may be down sampled.
209 &quot;mapVal&quot;: [ # Map value. The valid key space and units for the corresponding value
210 # of each entry should be documented as part of the data type definition.
211 # Keys should be kept small whenever possible. Data streams with large keys
212 # and high data frequency may be down sampled.
213 {
214 &quot;value&quot;: { # Holder object for the value of an entry in a map field of a data point.
215 #
216 # A map value supports a subset of the formats that the regular Value supports.
217 &quot;fpVal&quot;: 3.14, # Floating point value.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]218 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]219 &quot;key&quot;: &quot;A String&quot;,
220 },
221 ],
222 &quot;fpVal&quot;: 3.14, # Floating point value. When this is set, other values must not be set.
223 &quot;intVal&quot;: 42, # Integer value. When this is set, other values must not be set.
224 },
225 ],
226 },
227 ],
228 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token will be set when a dataset is received in response to a GET
229 # request and the dataset is too large to be included in a single response.
230 # Provide this value in a subsequent GET request to return the next page of
231 # data points within this dataset.
232 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]233</div>
234
235<div class="method">
236 <code class="details" id="get_next">get_next(previous_request, previous_response)</code>
237 <pre>Retrieves the next page of results.
238
239Args:
240 previous_request: The request for the previous page. (required)
241 previous_response: The response from the request for the previous page. (required)
242
243Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]244 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]245 page. Returns None if there are no more items in the collection.
246 </pre>
247</div>
248
249<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]250 <code class="details" id="patch">patch(userId, dataSourceId, datasetId, body=None, currentTimeMillis=None, x__xgafv=None)</code>
251 <pre>Adds data points to a dataset. The dataset need not be previously created.
252All points within the given dataset will be returned with subsquent calls
253to retrieve this dataset. Data points can belong to more than one dataset.
254This method does not use patch semantics.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]255
256Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]257 userId: string, Patch a dataset for the person identified. Use &lt;code&gt;me&lt;/code&gt; to indicate
258the authenticated user. Only &lt;code&gt;me&lt;/code&gt; is supported at this time. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]259 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]260 datasetId: string, Dataset identifier that is a composite of the minimum data point start time
261and maximum data point end time represented as nanoseconds from the epoch.
262The ID is formatted like: &quot;&lt;var&gt;startTime&lt;/var&gt;-&lt;var&gt;endTime&lt;/var&gt;&quot;
263where &lt;var&gt;startTime&lt;/var&gt; and &lt;var&gt;endTime&lt;/var&gt; are 64 bit integers. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]264 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]265 The object takes the form of:
266
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]267{ # A dataset represents a projection container for data points. They do not
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]268 # carry any info of their own. Datasets represent a set of data points from a
269 # particular data source. A data point can be found in more than one dataset.
270 &quot;dataSourceId&quot;: &quot;A String&quot;, # The data stream ID of the data source that created the points in this
271 # dataset.
272 &quot;maxEndTimeNs&quot;: &quot;A String&quot;, # The largest end time of all data points in this possibly partial
273 # representation of the dataset. Time is in nanoseconds from epoch. This
274 # should also match the second part of the dataset identifier.
275 &quot;minStartTimeNs&quot;: &quot;A String&quot;, # The smallest start time of all data points in this possibly partial
276 # representation of the dataset. Time is in nanoseconds from epoch. This
277 # should also match the first part of the dataset identifier.
278 &quot;point&quot;: [ # A partial list of data points contained in the dataset, ordered by largest
279 # endTimeNanos first. This list is considered complete when retrieving a
280 # small dataset and partial when patching a dataset or retrieving a dataset
281 # that is too large to include in a single response.
282 { # Represents a single data point, generated by a particular data source. A
283 # data point holds a value for each field, an end timestamp and an optional
284 # start time. The exact semantics of each of these attributes are specified in
285 # the documentation for the particular data type.
286 #
287 # A data point can represent an instantaneous measurement, reading or input
288 # observation, as well as averages or aggregates over a time interval. Check
289 # the data type documentation to determine which is the case for a particular
290 # data type.
291 #
292 # Data points always contain one value for each field of the data type.
293 &quot;computationTimeMillis&quot;: &quot;A String&quot;, # DO NOT USE THIS FIELD. It is ignored, and not stored.
294 &quot;dataTypeName&quot;: &quot;A String&quot;, # The data type defining the format of the values in this data point.
295 &quot;endTimeNanos&quot;: &quot;A String&quot;, # The end time of the interval represented by this data point, in
296 # nanoseconds since epoch.
297 &quot;startTimeNanos&quot;: &quot;A String&quot;, # The start time of the interval represented by this data point, in
298 # nanoseconds since epoch.
299 &quot;originDataSourceId&quot;: &quot;A String&quot;, # If the data point is contained in a dataset for a derived data source,
300 # this field will be populated with the data source stream ID that created
301 # the data point originally.
302 #
303 # WARNING: do not rely on this field for anything other than debugging. The
304 # value of this field, if it is set at all, is an implementation detail and
305 # is not guaranteed to remain consistent.
306 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # Indicates the last time this data point was modified. Useful only in
307 # contexts where we are listing the data changes, rather than representing
308 # the current state of the data.
309 &quot;rawTimestampNanos&quot;: &quot;A String&quot;, # The raw timestamp from the original SensorEvent.
310 &quot;value&quot;: [ # Values of each data type field for the data point. It is expected that each
311 # value corresponding to a data type field will occur in the same order that
312 # the field is listed with in the data type specified in a data source.
313 #
314 # Only one of integer and floating point fields will be populated, depending
315 # on the format enum value within data source&#x27;s type field.
316 { # Holder object for the value of a single field in a data point.
317 #
318 # A field value has a particular format and is only ever set to one of an
319 # integer or a floating point value.
320 &quot;stringVal&quot;: &quot;A String&quot;, # String value. When this is set, other values must not be set.
321 # Strings should be kept small whenever possible. Data streams with large
322 # string values and high data frequency may be down sampled.
323 &quot;mapVal&quot;: [ # Map value. The valid key space and units for the corresponding value
324 # of each entry should be documented as part of the data type definition.
325 # Keys should be kept small whenever possible. Data streams with large keys
326 # and high data frequency may be down sampled.
327 {
328 &quot;value&quot;: { # Holder object for the value of an entry in a map field of a data point.
329 #
330 # A map value supports a subset of the formats that the regular Value supports.
331 &quot;fpVal&quot;: 3.14, # Floating point value.
332 },
333 &quot;key&quot;: &quot;A String&quot;,
334 },
335 ],
336 &quot;fpVal&quot;: 3.14, # Floating point value. When this is set, other values must not be set.
337 &quot;intVal&quot;: 42, # Integer value. When this is set, other values must not be set.
338 },
339 ],
340 },
341 ],
342 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token will be set when a dataset is received in response to a GET
343 # request and the dataset is too large to be included in a single response.
344 # Provide this value in a subsequent GET request to return the next page of
345 # data points within this dataset.
346}
347
348 currentTimeMillis: string, The client&#x27;s current time in milliseconds since epoch. Note that the
349&lt;code&gt;minStartTimeNs&lt;/code&gt; and &lt;code&gt;maxEndTimeNs&lt;/code&gt; properties in
350the request body are in nanoseconds instead of milliseconds.
351 x__xgafv: string, V1 error format.
352 Allowed values
353 1 - v1 error format
354 2 - v2 error format
355
356Returns:
357 An object of the form:
358
359 { # A dataset represents a projection container for data points. They do not
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]360 # carry any info of their own. Datasets represent a set of data points from a
361 # particular data source. A data point can be found in more than one dataset.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]362 &quot;dataSourceId&quot;: &quot;A String&quot;, # The data stream ID of the data source that created the points in this
363 # dataset.
364 &quot;maxEndTimeNs&quot;: &quot;A String&quot;, # The largest end time of all data points in this possibly partial
365 # representation of the dataset. Time is in nanoseconds from epoch. This
366 # should also match the second part of the dataset identifier.
367 &quot;minStartTimeNs&quot;: &quot;A String&quot;, # The smallest start time of all data points in this possibly partial
368 # representation of the dataset. Time is in nanoseconds from epoch. This
369 # should also match the first part of the dataset identifier.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]370 &quot;point&quot;: [ # A partial list of data points contained in the dataset, ordered by largest
371 # endTimeNanos first. This list is considered complete when retrieving a
372 # small dataset and partial when patching a dataset or retrieving a dataset
373 # that is too large to include in a single response.
374 { # Represents a single data point, generated by a particular data source. A
375 # data point holds a value for each field, an end timestamp and an optional
376 # start time. The exact semantics of each of these attributes are specified in
377 # the documentation for the particular data type.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]378 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]379 # A data point can represent an instantaneous measurement, reading or input
380 # observation, as well as averages or aggregates over a time interval. Check
381 # the data type documentation to determine which is the case for a particular
382 # data type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]383 #
384 # Data points always contain one value for each field of the data type.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]385 &quot;computationTimeMillis&quot;: &quot;A String&quot;, # DO NOT USE THIS FIELD. It is ignored, and not stored.
386 &quot;dataTypeName&quot;: &quot;A String&quot;, # The data type defining the format of the values in this data point.
387 &quot;endTimeNanos&quot;: &quot;A String&quot;, # The end time of the interval represented by this data point, in
388 # nanoseconds since epoch.
389 &quot;startTimeNanos&quot;: &quot;A String&quot;, # The start time of the interval represented by this data point, in
390 # nanoseconds since epoch.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]391 &quot;originDataSourceId&quot;: &quot;A String&quot;, # If the data point is contained in a dataset for a derived data source,
392 # this field will be populated with the data source stream ID that created
393 # the data point originally.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]394 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]395 # WARNING: do not rely on this field for anything other than debugging. The
396 # value of this field, if it is set at all, is an implementation detail and
397 # is not guaranteed to remain consistent.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]398 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # Indicates the last time this data point was modified. Useful only in
399 # contexts where we are listing the data changes, rather than representing
400 # the current state of the data.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]401 &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]402 &quot;value&quot;: [ # Values of each data type field for the data point. It is expected that each
403 # value corresponding to a data type field will occur in the same order that
404 # the field is listed with in the data type specified in a data source.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]405 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]406 # Only one of integer and floating point fields will be populated, depending
407 # on the format enum value within data source&#x27;s type field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]408 { # Holder object for the value of a single field in a data point.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]409 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]410 # A field value has a particular format and is only ever set to one of an
411 # integer or a floating point value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]412 &quot;stringVal&quot;: &quot;A String&quot;, # String value. When this is set, other values must not be set.
413 # Strings should be kept small whenever possible. Data streams with large
414 # string values and high data frequency may be down sampled.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]415 &quot;mapVal&quot;: [ # Map value. The valid key space and units for the corresponding value
416 # of each entry should be documented as part of the data type definition.
417 # Keys should be kept small whenever possible. Data streams with large keys
418 # and high data frequency may be down sampled.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]419 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]420 &quot;value&quot;: { # Holder object for the value of an entry in a map field of a data point.
421 #
422 # A map value supports a subset of the formats that the regular Value supports.
423 &quot;fpVal&quot;: 3.14, # Floating point value.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]424 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]425 &quot;key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]426 },
427 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]428 &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]429 &quot;intVal&quot;: 42, # Integer value. When this is set, other values must not be set.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 },
431 ],
432 },
433 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]434 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token will be set when a dataset is received in response to a GET
435 # request and the dataset is too large to be included in a single response.
436 # Provide this value in a subsequent GET request to return the next page of
437 # data points within this dataset.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]438 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]439</div>
440
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]441<div class="method">
442 <code class="details" id="patch_next">patch_next(previous_request, previous_response)</code>
443 <pre>Retrieves the next page of results.
444
445Args:
446 previous_request: The request for the previous page. (required)
447 previous_response: The response from the request for the previous page. (required)
448
449Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]450 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]451 page. Returns None if there are no more items in the collection.
452 </pre>
453</div>
454
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]455</body></html>