Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Kim | 4ed7d3f | 2020-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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 78 | <code><a href="#list">list(userId, dataSourceId, limit=None, pageToken=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-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 Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 85 | <code class="details" id="list">list(userId, dataSourceId, limit=None, pageToken=None, x__xgafv=None)</code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 86 | <pre>Queries for user's data point changes for a particular data source. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 87 | |
| 88 | Args: |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 89 | userId: string, List data points for the person identified. Use <code>me</code> to indicate |
| 90 | the authenticated user. Only <code>me</code> is supported at this time. (required) |
Bu Sun Kim | 715bd7f | 2019-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 Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 92 | limit: integer, If specified, no more than this many data point changes will be included |
| 93 | in the response. |
| 94 | pageToken: string, The continuation token, which is used to page through large result sets. |
| 95 | To get the next page of results, set this parameter to the value of |
| 96 | <code>nextPageToken</code> from the previous response. |
| 97 | x__xgafv: string, V1 error format. |
| 98 | Allowed values |
| 99 | 1 - v1 error format |
| 100 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 101 | |
| 102 | Returns: |
| 103 | An object of the form: |
| 104 | |
| 105 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 106 | "dataSourceId": "A String", # The data stream ID of the data source with data point changes. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 107 | "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. |
| 108 | # Provide this value in a subsequent request to return the next page of |
| 109 | # results. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | "insertedDataPoint": [ # Inserted data points for the user. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 111 | { # Represents a single data point, generated by a particular data source. A |
| 112 | # data point holds a value for each field, an end timestamp and an optional |
| 113 | # start time. The exact semantics of each of these attributes are specified in |
| 114 | # the documentation for the particular data type. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | # |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 116 | # A data point can represent an instantaneous measurement, reading or input |
| 117 | # observation, as well as averages or aggregates over a time interval. Check |
| 118 | # the data type documentation to determine which is the case for a particular |
| 119 | # data type. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | # |
| 121 | # Data points always contain one value for each field of the data type. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 122 | "modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in |
| 123 | # contexts where we are listing the data changes, rather than representing |
| 124 | # the current state of the data. |
| 125 | "originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source, |
| 126 | # this field will be populated with the data source stream ID that created |
| 127 | # the data point originally. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 128 | # |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 129 | # WARNING: do not rely on this field for anything other than debugging. The |
| 130 | # value of this field, if it is set at all, is an implementation detail and |
| 131 | # is not guaranteed to remain consistent. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 133 | "dataTypeName": "A String", # The data type defining the format of the values in this data point. |
| 134 | "startTimeNanos": "A String", # The start time of the interval represented by this data point, in |
| 135 | # nanoseconds since epoch. |
| 136 | "value": [ # Values of each data type field for the data point. It is expected that each |
| 137 | # value corresponding to a data type field will occur in the same order that |
| 138 | # the field is listed with in the data type specified in a data source. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 139 | # |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 140 | # Only one of integer and floating point fields will be populated, depending |
| 141 | # on the format enum value within data source's type field. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 142 | { # Holder object for the value of a single field in a data point. |
| 143 | # |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 144 | # A field value has a particular format and is only ever set to one of an |
| 145 | # integer or a floating point value. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | "fpVal": 3.14, # Floating point value. When this is set, other values must not be set. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 147 | "mapVal": [ # Map value. The valid key space and units for the corresponding value |
| 148 | # of each entry should be documented as part of the data type definition. |
| 149 | # Keys should be kept small whenever possible. Data streams with large keys |
| 150 | # and high data frequency may be down sampled. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "value": { # Holder object for the value of an entry in a map field of a data point. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 153 | # |
| 154 | # A map value supports a subset of the formats that the regular Value supports. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 155 | "fpVal": 3.14, # Floating point value. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 156 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 157 | "key": "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 158 | }, |
| 159 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 160 | "intVal": 42, # Integer value. When this is set, other values must not be set. |
| 161 | "stringVal": "A String", # String value. When this is set, other values must not be set. |
| 162 | # Strings should be kept small whenever possible. Data streams with large |
| 163 | # string values and high data frequency may be down sampled. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 164 | }, |
| 165 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 166 | "computationTimeMillis": "A String", # DO NOT USE THIS FIELD. It is ignored, and not stored. |
| 167 | "endTimeNanos": "A String", # The end time of the interval represented by this data point, in |
| 168 | # nanoseconds since epoch. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 169 | }, |
| 170 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 171 | "deletedDataPoint": [ # Deleted data points for the user. Note, for modifications this should be |
| 172 | # parsed before handling insertions. |
| 173 | { # Represents a single data point, generated by a particular data source. A |
| 174 | # data point holds a value for each field, an end timestamp and an optional |
| 175 | # start time. The exact semantics of each of these attributes are specified in |
| 176 | # the documentation for the particular data type. |
| 177 | # |
| 178 | # A data point can represent an instantaneous measurement, reading or input |
| 179 | # observation, as well as averages or aggregates over a time interval. Check |
| 180 | # the data type documentation to determine which is the case for a particular |
| 181 | # data type. |
| 182 | # |
| 183 | # Data points always contain one value for each field of the data type. |
| 184 | "modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in |
| 185 | # contexts where we are listing the data changes, rather than representing |
| 186 | # the current state of the data. |
| 187 | "originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source, |
| 188 | # this field will be populated with the data source stream ID that created |
| 189 | # the data point originally. |
| 190 | # |
| 191 | # WARNING: do not rely on this field for anything other than debugging. The |
| 192 | # value of this field, if it is set at all, is an implementation detail and |
| 193 | # is not guaranteed to remain consistent. |
| 194 | "rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent. |
| 195 | "dataTypeName": "A String", # The data type defining the format of the values in this data point. |
| 196 | "startTimeNanos": "A String", # The start time of the interval represented by this data point, in |
| 197 | # nanoseconds since epoch. |
| 198 | "value": [ # Values of each data type field for the data point. It is expected that each |
| 199 | # value corresponding to a data type field will occur in the same order that |
| 200 | # the field is listed with in the data type specified in a data source. |
| 201 | # |
| 202 | # Only one of integer and floating point fields will be populated, depending |
| 203 | # on the format enum value within data source's type field. |
| 204 | { # Holder object for the value of a single field in a data point. |
| 205 | # |
| 206 | # A field value has a particular format and is only ever set to one of an |
| 207 | # integer or a floating point value. |
| 208 | "fpVal": 3.14, # Floating point value. When this is set, other values must not be set. |
| 209 | "mapVal": [ # 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 | "value": { # 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 | "fpVal": 3.14, # Floating point value. |
| 218 | }, |
| 219 | "key": "A String", |
| 220 | }, |
| 221 | ], |
| 222 | "intVal": 42, # Integer value. When this is set, other values must not be set. |
| 223 | "stringVal": "A String", # String value. When this is set, other values must not be set. |
| 224 | # Strings should be kept small whenever possible. Data streams with large |
| 225 | # string values and high data frequency may be down sampled. |
| 226 | }, |
| 227 | ], |
| 228 | "computationTimeMillis": "A String", # DO NOT USE THIS FIELD. It is ignored, and not stored. |
| 229 | "endTimeNanos": "A String", # The end time of the interval represented by this data point, in |
| 230 | # nanoseconds since epoch. |
| 231 | }, |
| 232 | ], |
Bu Sun Kim | 715bd7f | 2019-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 | |
| 240 | Args: |
| 241 | previous_request: The request for the previous page. (required) |
| 242 | previous_response: The response from the request for the previous page. (required) |
| 243 | |
| 244 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 245 | A request object that you can call 'execute()' on to request the next |
Bu Sun Kim | 715bd7f | 2019-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> |