Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / fitness_v1.users.dataSources.dataPointChanges.html
blob: 6dcf3a755617db9892f3c037d262143d06cb16ef [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
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> . <a href="fitness_v1.users.dataSources.dataPointChanges.html">dataPointChanges</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#list">list(userId, dataSourceId, limit=None, pageToken=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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]85 <code class="details" id="list">list(userId, dataSourceId, limit=None, pageToken=None)</code>
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:
89 userId: string, List data points for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
90 dataSourceId: string, The data stream ID of the data source that created the dataset. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 limit: integer, If specified, no more than this many data point changes will be included in the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93
94Returns:
95 An object of the form:
96
97 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98 &quot;dataSourceId&quot;: &quot;A String&quot;, # The data stream ID of the data source with data point changes.
99 &quot;deletedDataPoint&quot;: [ # Deleted data points for the user. Note, for modifications this should be parsed before handling insertions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100 { # Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type.
101 #
102 # A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type.
103 #
104 # Data points always contain one value for each field of the data type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;computationTimeMillis&quot;: &quot;A String&quot;, # DO NOT USE THIS FIELD. It is ignored, and not stored.
106 &quot;dataTypeName&quot;: &quot;A String&quot;, # The data type defining the format of the values in this data point.
107 &quot;endTimeNanos&quot;: &quot;A String&quot;, # The end time of the interval represented by this data point, in nanoseconds since epoch.
108 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.
109 &quot;originDataSourceId&quot;: &quot;A String&quot;, # If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]111 # WARNING: do not rely on this field for anything other than debugging. The value of this field, if it is set at all, is an implementation detail and is not guaranteed to remain consistent.
112 &quot;rawTimestampNanos&quot;: &quot;A String&quot;, # The raw timestamp from the original SensorEvent.
113 &quot;startTimeNanos&quot;: &quot;A String&quot;, # The start time of the interval represented by this data point, in nanoseconds since epoch.
114 &quot;value&quot;: [ # Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source.
115 #
116 # Only one of integer and floating point fields will be populated, depending on the format enum value within data source&#x27;s type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 { # Holder object for the value of a single field in a data point.
118 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 # A field value has a particular format and is only ever set to one of an integer or a floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;fpVal&quot;: 3.14, # Floating point value. When this is set, other values must not be set.
121 &quot;intVal&quot;: 42, # Integer value. When this is set, other values must not be set.
122 &quot;mapVal&quot;: [ # Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 &quot;key&quot;: &quot;A String&quot;,
125 &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]126 #
127 # 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]128 &quot;fpVal&quot;: 3.14, # Floating point value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 },
131 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;stringVal&quot;: &quot;A String&quot;, # String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 },
134 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 },
136 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;insertedDataPoint&quot;: [ # Inserted data points for the user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 { # Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type.
139 #
140 # A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type.
141 #
142 # Data points always contain one value for each field of the data type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;computationTimeMillis&quot;: &quot;A String&quot;, # DO NOT USE THIS FIELD. It is ignored, and not stored.
144 &quot;dataTypeName&quot;: &quot;A String&quot;, # The data type defining the format of the values in this data point.
145 &quot;endTimeNanos&quot;: &quot;A String&quot;, # The end time of the interval represented by this data point, in nanoseconds since epoch.
146 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data.
147 &quot;originDataSourceId&quot;: &quot;A String&quot;, # If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 # WARNING: do not rely on this field for anything other than debugging. The value of this field, if it is set at all, is an implementation detail and is not guaranteed to remain consistent.
150 &quot;rawTimestampNanos&quot;: &quot;A String&quot;, # The raw timestamp from the original SensorEvent.
151 &quot;startTimeNanos&quot;: &quot;A String&quot;, # The start time of the interval represented by this data point, in nanoseconds since epoch.
152 &quot;value&quot;: [ # Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source.
153 #
154 # Only one of integer and floating point fields will be populated, depending on the format enum value within data source&#x27;s type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 { # Holder object for the value of a single field in a data point.
156 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]157 # A field value has a particular format and is only ever set to one of an integer or a floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;fpVal&quot;: 3.14, # Floating point value. When this is set, other values must not be set.
159 &quot;intVal&quot;: 42, # Integer value. When this is set, other values must not be set.
160 &quot;mapVal&quot;: [ # Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;key&quot;: &quot;A String&quot;,
163 &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]164 #
165 # 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]166 &quot;fpVal&quot;: 3.14, # Floating point value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 },
169 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;stringVal&quot;: &quot;A String&quot;, # String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 },
172 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 },
174 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 }</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
181 <pre>Retrieves the next page of results.
182
183Args:
184 previous_request: The request for the previous page. (required)
185 previous_response: The response from the request for the previous page. (required)
186
187Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 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]189 page. Returns None if there are no more items in the collection.
190 </pre>
191</div>
192
193</body></html>