1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
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>
<h1><a href="fitness_v1.html">Fitness API</a> . <a href="fitness_v1.users.html">users</a> . <a href="fitness_v1.users.sessions.html">sessions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(userId, sessionId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a session specified by the given session ID.</p>
<p class="toc_element">
<code><a href="#list">list(userId, activityType=None, endTime=None, includeDeleted=None, pageToken=None, startTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists sessions previously created.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(userId, sessionId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates or insert a given session.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(userId, sessionId, x__xgafv=None)</code>
<pre>Deletes a session specified by the given session ID.
Args:
userId: string, Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
sessionId: string, The ID of the session to be deleted. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="list">list(userId, activityType=None, endTime=None, includeDeleted=None, pageToken=None, startTime=None, x__xgafv=None)</code>
<pre>Lists sessions previously created.
Args:
userId: string, List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
activityType: integer, If non-empty, only sessions with these activity types should be returned. (repeated)
endTime: string, An RFC3339 timestamp. Only sessions starting before endTime and ending after startTime up to (endTime + 1 day) will be included in the response. If this time is omitted but startTime is specified, all sessions ending after startTime to the end of time will be returned.
includeDeleted: boolean, If true, and if both startTime and endTime are omitted, session deletions will be returned.
pageToken: string, The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 30 days are returned.
startTime: string, An RFC3339 timestamp. Only sessions starting before endTime and ending after startTime up to (endTime + 1 day) will be included in the response. If this time is omitted but endTime is specified, all sessions starting before endTime and ending after the start of time up to (endTime + 1 day) will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"deletedSession": [ # If includeDeleted is set to true in the request, and startTime and endTime are omitted, this will include sessions which were deleted since the last sync.
{ # Sessions contain metadata, such as a user-friendly name and time interval information.
"activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"activityType": 42, # The type of activity this session represents.
"application": { # The application that created the session.
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
"name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
"packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
"version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
},
"description": "A String", # A description for this session.
"endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
"name": "A String", # A human readable name of the session.
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
},
],
"hasMoreData": True or False, # Flag to indicate server has more data to transfer. DO NOT USE THIS FIELD. It is never populated in responses from the server.
"nextPageToken": "A String", # The sync token which is used to sync further changes. This will only be provided if both startTime and endTime are omitted from the request.
"session": [ # Sessions starting before endTime of the request and ending after startTime of the request up to (endTime of the request + 1 day).
{ # Sessions contain metadata, such as a user-friendly name and time interval information.
"activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"activityType": 42, # The type of activity this session represents.
"application": { # The application that created the session.
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
"name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
"packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
"version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
},
"description": "A String", # A description for this session.
"endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
"name": "A String", # A human readable name of the session.
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(userId, sessionId, body=None, x__xgafv=None)</code>
<pre>Updates or insert a given session.
Args:
userId: string, Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
sessionId: string, The ID of the session to be created. (required)
body: object, The request body.
The object takes the form of:
{ # Sessions contain metadata, such as a user-friendly name and time interval information.
"activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"activityType": 42, # The type of activity this session represents.
"application": { # The application that created the session.
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
"name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
"packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
"version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
},
"description": "A String", # A description for this session.
"endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
"name": "A String", # A human readable name of the session.
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Sessions contain metadata, such as a user-friendly name and time interval information.
"activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
"activityType": 42, # The type of activity this session represents.
"application": { # The application that created the session.
"detailsUrl": "A String", # An optional URI that can be used to link back to the application.
"name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
"packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
"version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
},
"description": "A String", # A description for this session.
"endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
"id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
"modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
"name": "A String", # A human readable name of the session.
"startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
}</pre>
</div>
</body></html>
|
