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