Blame - docs/dyn/fitness_v1.users.dataset.html - platform/external/python/google-api-python-client

2015-06-15 16:44:50 +0000

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

Bu Sun Kim

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.dataset.html">dataset</a></h1>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

78

<code><a href="#aggregate">aggregate(userId, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Aggregates data of a certain type or stream into buckets divided by a given</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

80

<h3>Method Details</h3>

81

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

82

<code class="details" id="aggregate">aggregate(userId, body=None, x__xgafv=None)</code>

83

<pre>Aggregates data of a certain type or stream into buckets divided by a given

84

type of boundary. Multiple data sets of multiple types and from multiple

85

sources can be aggregated into exactly one bucket type per request.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

86

87

Args:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

88

userId: string, Aggregate data for the person identified. Use <code>me</code> to indicate

89

the authenticated user. Only <code>me</code> is supported at this time. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

90

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

91

The object takes the form of:

92

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

93

{ # Next id: 10

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

94

"bucketByTime": { # Specifies that data be aggregated by a single time interval. Mutually

95

# exclusive of other bucketing specifications.

"period": {

"type": "A String",

"value": 42,

"timeZoneId": "A String", # org.joda.timezone.DateTimeZone

100

},

101

"durationMillis": "A String", # Specifies that result buckets aggregate data by exactly durationMillis time

102

# frames. Time frames that contain no data will be included in the response

103

# with an empty dataset.

104

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

"filteredDataQualityStandard": [ # DO NOT POPULATE THIS FIELD. It is ignored.

106

"A String",

107

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

108

"bucketByActivityType": { # Specifies that data be aggregated by the type of activity being performed

109

# when the data was recorded. All data that was recorded during a certain

110

# activity type (.for the given time range) will be aggregated into the same

111

# bucket. Data that was recorded while the user was not active will not be

112

# included in the response. Mutually exclusive of other bucketing

113

# specifications.

114

"activityDataSourceId": "A String", # The default activity stream will be used if a specific activityDataSourceId

115

# is not specified.

116

"minDurationMillis": "A String", # Specifies that only activity segments of duration longer than

117

# minDurationMillis are considered and used as a container for aggregated

118

# data.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

119

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

120

"aggregateBy": [ # The specification of data to be aggregated. At least one aggregateBy spec

121

# must be provided. All data that is specified will be aggregated using the

122

# same bucketing criteria. There will be one dataset in the response for

123

# every aggregateBy spec.

124

{ # The specification of which data to aggregate.

125

"dataTypeName": "A String", # The data type to aggregate. All data sources providing this data type will

126

# contribute data to the aggregation. The response will contain a single

127

# dataset for this data type name. The dataset will have a data source ID of

128

# derived:<output data type name>:com.google.android.gms:aggregated.

129

# If the user has no data for this data type, an empty data set will be

130

# returned. Note: Data can be aggregated by either the dataTypeName or the

131

# dataSourceId, not both.

132

"dataSourceId": "A String", # A data source ID to aggregate. Only data from the specified data source ID

133

# will be included in the aggregation. If specified, this data source must

134

# exist; the OAuth scopes in the supplied credentials must grant read access

135

# to this data type. The dataset in the response will have the same data

136

# source ID. Note: Data can be aggregated by either the dataTypeName or the

137

# dataSourceId, not both.

138

},

139

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

140

"bucketBySession": { # Specifies that data be aggregated by user sessions. Data that does not fall

141

# within the time range of a session will not be included in the response.

142

# Mutually exclusive of other bucketing specifications.

143

"minDurationMillis": "A String", # Specifies that only sessions of duration longer than minDurationMillis are

144

# considered and used as a container for aggregated data.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

145

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

146

"endTimeMillis": "A String", # The end of a window of time. Data that intersects with this time

147

# window will be aggregated. The time is in milliseconds since epoch,

148

# inclusive.

149

"startTimeMillis": "A String", # The start of a window of time. Data that intersects with this time

150

# window will be aggregated. The time is in milliseconds since epoch,

151

# inclusive.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

152

"bucketByActivitySegment": { # Specifies that data be aggregated each activity segment recored for a user.

153

# Similar to bucketByActivitySegment, but bucketing is done for each activity

154

# segment rather than all segments of the same type. Mutually exclusive of

155

# other bucketing specifications.

156

"activityDataSourceId": "A String", # The default activity stream will be used if a specific activityDataSourceId

157

# is not specified.

158

"minDurationMillis": "A String", # Specifies that only activity segments of duration longer than

159

# minDurationMillis are considered and used as a container for aggregated

160

# data.

161

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

162

}

163

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

164

x__xgafv: string, V1 error format.

165

Allowed values

166

1 - v1 error format

167

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

168

169

Returns:

170

An object of the form:

171

172

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

173

"bucket": [ # A list of buckets containing the aggregated data.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

174

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

175

"session": { # Sessions contain metadata, such as a user-friendly name and time interval # Available for Bucket.Type.SESSION

176

# information.

177

"id": "A String", # A client-generated identifier that is unique across all sessions owned by

178

# this particular user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

179

"activityType": 42, # The type of activity this session represents.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

180

"endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

181

"description": "A String", # A description for this session.

182

"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.

183

"name": "A String", # A human readable name of the session.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

184

"application": { # The application that created the session.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

185

"packageName": "A String", # Package name for this application. This is used as a unique

186

# identifier when created by Android applications, but cannot be specified

187

# by REST clients. REST clients will have their developer project number

188

# reflected into the Data Source data stream IDs, instead of the packageName.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

189

"detailsUrl": "A String", # An optional URI that can be used to link back to the application.

190

"version": "A String", # Version of the application. You should update this field whenever the

191

# application changes in a way that affects the computation of the data.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

192

"name": "A String", # The name of this application. This is required for REST clients, but we

193

# do not enforce uniqueness of this name. It is provided as a matter of

194

# convenience for other developers who would like to identify which REST

195

# created an Application or Data Source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

196

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

197

"activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define

198

# the full session time, the active time can be shorter and specified by

199

# active_time_millis.

200

# If the inactive time during the session is known, it should also be

201

# inserted via a com.google.activity.segment data point with a STILL

202

# activity value

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

203

"modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

204

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

205

"activity": 42, # Available for Bucket.Type.ACTIVITY_TYPE, Bucket.Type.ACTIVITY_SEGMENT

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

206

"endTimeMillis": "A String", # The end time for the aggregated data, in milliseconds since epoch,

207

# inclusive.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

208

"dataset": [ # There will be one dataset per AggregateBy in the request.

209

{ # A dataset represents a projection container for data points. They do not

210

# carry any info of their own. Datasets represent a set of data points from a

211

# particular data source. A data point can be found in more than one dataset.

212

"dataSourceId": "A String", # The data stream ID of the data source that created the points in this

213

# dataset.

214

"maxEndTimeNs": "A String", # The largest end time of all data points in this possibly partial

215

# representation of the dataset. Time is in nanoseconds from epoch. This

216

# should also match the second part of the dataset identifier.

217

"minStartTimeNs": "A String", # The smallest start time of all data points in this possibly partial

218

# representation of the dataset. Time is in nanoseconds from epoch. This

219

# should also match the first part of the dataset identifier.

220

"point": [ # A partial list of data points contained in the dataset, ordered by largest

221

# endTimeNanos first. This list is considered complete when retrieving a

222

# small dataset and partial when patching a dataset or retrieving a dataset

223

# that is too large to include in a single response.

224

{ # Represents a single data point, generated by a particular data source. A

225

# data point holds a value for each field, an end timestamp and an optional

226

# start time. The exact semantics of each of these attributes are specified in

227

# the documentation for the particular data type.

228

#

229

# A data point can represent an instantaneous measurement, reading or input

230

# observation, as well as averages or aggregates over a time interval. Check

231

# the data type documentation to determine which is the case for a particular

232

# data type.

233

#

234

# Data points always contain one value for each field of the data type.

235

"computationTimeMillis": "A String", # DO NOT USE THIS FIELD. It is ignored, and not stored.

236

"dataTypeName": "A String", # The data type defining the format of the values in this data point.

237

"endTimeNanos": "A String", # The end time of the interval represented by this data point, in

238

# nanoseconds since epoch.

239

"startTimeNanos": "A String", # The start time of the interval represented by this data point, in

240

# nanoseconds since epoch.

241

"originDataSourceId": "A String", # If the data point is contained in a dataset for a derived data source,

242

# this field will be populated with the data source stream ID that created

243

# the data point originally.

244

#

245

# WARNING: do not rely on this field for anything other than debugging. The

246

# value of this field, if it is set at all, is an implementation detail and

247

# is not guaranteed to remain consistent.

248

"modifiedTimeMillis": "A String", # Indicates the last time this data point was modified. Useful only in

249

# contexts where we are listing the data changes, rather than representing

250

# the current state of the data.

251

"rawTimestampNanos": "A String", # The raw timestamp from the original SensorEvent.

252

"value": [ # Values of each data type field for the data point. It is expected that each

253

# value corresponding to a data type field will occur in the same order that

254

# the field is listed with in the data type specified in a data source.

255

#

256

# Only one of integer and floating point fields will be populated, depending

257

# on the format enum value within data source's type field.

258

{ # Holder object for the value of a single field in a data point.

259

#

260

# A field value has a particular format and is only ever set to one of an

261

# integer or a floating point value.

262

"stringVal": "A String", # String value. When this is set, other values must not be set.

263

# Strings should be kept small whenever possible. Data streams with large

264

# string values and high data frequency may be down sampled.

265

"mapVal": [ # Map value. The valid key space and units for the corresponding value

266

# of each entry should be documented as part of the data type definition.

267

# Keys should be kept small whenever possible. Data streams with large keys

268

# and high data frequency may be down sampled.

269

{

270

"value": { # Holder object for the value of an entry in a map field of a data point.

271

#

272

# A map value supports a subset of the formats that the regular Value supports.

273

"fpVal": 3.14, # Floating point value.

},

"key": "A String",

},

],

"fpVal": 3.14, # Floating point value. When this is set, other values must not be set.

279

"intVal": 42, # Integer value. When this is set, other values must not be set.

},

],

},

],

"nextPageToken": "A String", # This token will be set when a dataset is received in response to a GET

285

# request and the dataset is too large to be included in a single response.

286

# Provide this value in a subsequent GET request to return the next page of

287

# data points within this dataset.

288

},

289

],

290

"startTimeMillis": "A String", # The start time for the aggregated data, in milliseconds since epoch,

291

# inclusive.

292

"type": "A String", # The type of a bucket signifies how the data aggregation is performed in the

293

# bucket.

Nathaniel Manista