Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / fitness_v1.users.sessions.html
blob: b2bb4e1eae37e14b837bcfefff29e1f760e51922 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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
Bu Sun Kim4ed7d3f2020-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.sessions.html">sessions</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]81 <code><a href="#delete">delete(userId, sessionId, currentTimeMillis=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]82<p class="firstline">Deletes a session specified by the given session ID.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]84 <code><a href="#list">list(userId, includeDeleted=None, activityType=None, pageToken=None, endTime=None, startTime=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]85<p class="firstline">Lists sessions previously created.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]90 <code><a href="#update">update(userId, sessionId, body=None, currentTimeMillis=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]91<p class="firstline">Updates or insert a given session.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]99 <code class="details" id="delete">delete(userId, sessionId, currentTimeMillis=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]100 <pre>Deletes a session specified by the given session ID.
101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]103 userId: string, Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]104 sessionId: string, The ID of the session to be deleted. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 currentTimeMillis: string, The client&#x27;s current time in milliseconds since epoch.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]110</pre>
111</div>
112
113<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]114 <code class="details" id="list">list(userId, includeDeleted=None, activityType=None, pageToken=None, endTime=None, startTime=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]115 <pre>Lists sessions previously created.
116
117Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]118 userId: string, List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
119 includeDeleted: boolean, If true, and if both startTime and endTime are omitted, session deletions will be returned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 activityType: integer, If non-empty, only sessions with these activity types should be returned. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]121 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.
122 endTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but startTime is specified, all sessions from startTime to the end of time will be returned.
123 startTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but endTime is specified, all sessions from the start of time up to endTime will be returned.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]128
129Returns:
130 An object of the form:
131
132 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]133 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
134 &quot;session&quot;: [ # Sessions with an end time that is between startTime and endTime of the request.
135 { # Sessions contain metadata, such as a user-friendly name and time interval information.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]136 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # A timestamp that indicates when the session was last modified.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]137 &quot;id&quot;: &quot;A String&quot;, # A client-generated identifier that is unique across all sessions owned by this particular user.
138 &quot;activityType&quot;: 42, # The type of activity this session represents.
139 &quot;description&quot;: &quot;A String&quot;, # A description for this session.
140 &quot;application&quot;: { # The application that created the session.
141 &quot;packageName&quot;: &quot;A String&quot;, # 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.
142 &quot;detailsUrl&quot;: &quot;A String&quot;, # An optional URI that can be used to link back to the application.
143 &quot;version&quot;: &quot;A String&quot;, # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
144 &quot;name&quot;: &quot;A String&quot;, # 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.
145 },
146 &quot;startTimeMillis&quot;: &quot;A String&quot;, # A start time, in milliseconds since epoch, inclusive.
147 &quot;endTimeMillis&quot;: &quot;A String&quot;, # An end time, in milliseconds since epoch, inclusive.
148 &quot;activeTimeMillis&quot;: &quot;A String&quot;, # 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
149 &quot;name&quot;: &quot;A String&quot;, # A human readable name of the session.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]150 },
151 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]152 &quot;hasMoreData&quot;: 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.
153 &quot;deletedSession&quot;: [ # 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.
154 { # Sessions contain metadata, such as a user-friendly name and time interval information.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]155 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # A timestamp that indicates when the session was last modified.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]156 &quot;id&quot;: &quot;A String&quot;, # A client-generated identifier that is unique across all sessions owned by this particular user.
157 &quot;activityType&quot;: 42, # The type of activity this session represents.
158 &quot;description&quot;: &quot;A String&quot;, # A description for this session.
159 &quot;application&quot;: { # The application that created the session.
160 &quot;packageName&quot;: &quot;A String&quot;, # 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.
161 &quot;detailsUrl&quot;: &quot;A String&quot;, # An optional URI that can be used to link back to the application.
162 &quot;version&quot;: &quot;A String&quot;, # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
163 &quot;name&quot;: &quot;A String&quot;, # 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.
164 },
165 &quot;startTimeMillis&quot;: &quot;A String&quot;, # A start time, in milliseconds since epoch, inclusive.
166 &quot;endTimeMillis&quot;: &quot;A String&quot;, # An end time, in milliseconds since epoch, inclusive.
167 &quot;activeTimeMillis&quot;: &quot;A String&quot;, # 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
168 &quot;name&quot;: &quot;A String&quot;, # A human readable name of the session.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]169 },
170 ],
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176 <pre>Retrieves the next page of results.
177
178Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]184 page. Returns None if there are no more items in the collection.
185 </pre>
186</div>
187
188<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 <code class="details" id="update">update(userId, sessionId, body=None, currentTimeMillis=None, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190 <pre>Updates or insert a given session.
191
192Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]193 userId: string, Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]194 sessionId: string, The ID of the session to be created. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]196 The object takes the form of:
197
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]198{ # Sessions contain metadata, such as a user-friendly name and time interval information.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]199 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # A timestamp that indicates when the session was last modified.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]200 &quot;id&quot;: &quot;A String&quot;, # A client-generated identifier that is unique across all sessions owned by this particular user.
201 &quot;activityType&quot;: 42, # The type of activity this session represents.
202 &quot;description&quot;: &quot;A String&quot;, # A description for this session.
203 &quot;application&quot;: { # The application that created the session.
204 &quot;packageName&quot;: &quot;A String&quot;, # 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.
205 &quot;detailsUrl&quot;: &quot;A String&quot;, # An optional URI that can be used to link back to the application.
206 &quot;version&quot;: &quot;A String&quot;, # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
207 &quot;name&quot;: &quot;A String&quot;, # 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.
208 },
209 &quot;startTimeMillis&quot;: &quot;A String&quot;, # A start time, in milliseconds since epoch, inclusive.
210 &quot;endTimeMillis&quot;: &quot;A String&quot;, # An end time, in milliseconds since epoch, inclusive.
211 &quot;activeTimeMillis&quot;: &quot;A String&quot;, # 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
212 &quot;name&quot;: &quot;A String&quot;, # A human readable name of the session.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]213}
214
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]215 currentTimeMillis: string, The client&#x27;s current time in milliseconds since epoch.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]216 x__xgafv: string, V1 error format.
217 Allowed values
218 1 - v1 error format
219 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]220
221Returns:
222 An object of the form:
223
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]224 { # Sessions contain metadata, such as a user-friendly name and time interval information.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]225 &quot;modifiedTimeMillis&quot;: &quot;A String&quot;, # A timestamp that indicates when the session was last modified.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]226 &quot;id&quot;: &quot;A String&quot;, # A client-generated identifier that is unique across all sessions owned by this particular user.
227 &quot;activityType&quot;: 42, # The type of activity this session represents.
228 &quot;description&quot;: &quot;A String&quot;, # A description for this session.
229 &quot;application&quot;: { # The application that created the session.
230 &quot;packageName&quot;: &quot;A String&quot;, # 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.
231 &quot;detailsUrl&quot;: &quot;A String&quot;, # An optional URI that can be used to link back to the application.
232 &quot;version&quot;: &quot;A String&quot;, # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
233 &quot;name&quot;: &quot;A String&quot;, # 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.
234 },
235 &quot;startTimeMillis&quot;: &quot;A String&quot;, # A start time, in milliseconds since epoch, inclusive.
236 &quot;endTimeMillis&quot;: &quot;A String&quot;, # An end time, in milliseconds since epoch, inclusive.
237 &quot;activeTimeMillis&quot;: &quot;A String&quot;, # 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
238 &quot;name&quot;: &quot;A String&quot;, # A human readable name of the session.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]239 }</pre>
240</div>
241
242</body></html>