Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e52ea21dea8ae127d4e4fbfa54a1056c45cf69b5 / . / docs / dyn / fitness_v1.users.sessions.html
blob: 27afc3d3de62d591180d212a05666d2ea39e45d9 [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
75<h1><a href="fitness_v1.html">Fitness</a> . <a href="fitness_v1.users.html">users</a> . <a href="fitness_v1.users.sessions.html">sessions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(userId, sessionId, currentTimeMillis=None)</a></code></p>
79<p class="firstline">Deletes a session specified by the given session ID.</p>
80<p class="toc_element">
81 <code><a href="#list">list(userId, includeDeleted=None, pageToken=None, startTime=None, endTime=None)</a></code></p>
82<p class="firstline">Lists sessions previously created.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
87 <code><a href="#update">update(userId, sessionId, body, currentTimeMillis=None)</a></code></p>
88<p class="firstline">Updates or insert a given session.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(userId, sessionId, currentTimeMillis=None)</code>
92 <pre>Deletes a session specified by the given session ID.
93
94Args:
95 userId: string, Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
96 sessionId: string, The ID of the session to be deleted. (required)
97 currentTimeMillis: string, The client's current time in milliseconds since epoch.
98</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="list">list(userId, includeDeleted=None, pageToken=None, startTime=None, endTime=None)</code>
103 <pre>Lists sessions previously created.
104
105Args:
106 userId: string, List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
107 includeDeleted: boolean, If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields.
108 pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
109 startTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response.
110 endTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response.
111
112Returns:
113 An object of the form:
114
115 {
116 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
117 "deletedSession": [ # If includeDeleted is set to true in the request, this list will contain sessions deleted with original end times that are within the startTime and endTime frame.
118 { # Sessions contain metadata, such as a user-friendly name and time interval information.
119 "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
120 "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
121 "description": "A String", # A description for this session.
122 "activityType": 42, # The type of activity this session represents.
123 "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # The application that created the session.
124 "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.
125 "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.
126 "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.
127 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
128 },
129 "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
130 "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
131 "name": "A String", # A human readable name of the session.
132 },
133 ],
134 "session": [ # 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.
136 "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
137 "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
138 "description": "A String", # A description for this session.
139 "activityType": 42, # The type of activity this session represents.
140 "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # The application that created the session.
141 "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.
142 "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.
143 "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.
144 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
145 },
146 "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
147 "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
148 "name": "A String", # A human readable name of the session.
149 },
150 ],
151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
156 <pre>Retrieves the next page of results.
157
158Args:
159 previous_request: The request for the previous page. (required)
160 previous_response: The response from the request for the previous page. (required)
161
162Returns:
163 A request object that you can call 'execute()' on to request the next
164 page. Returns None if there are no more items in the collection.
165 </pre>
166</div>
167
168<div class="method">
169 <code class="details" id="update">update(userId, sessionId, body, currentTimeMillis=None)</code>
170 <pre>Updates or insert a given session.
171
172Args:
173 userId: string, Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
174 sessionId: string, The ID of the session to be created. (required)
175 body: object, The request body. (required)
176 The object takes the form of:
177
178{ # Sessions contain metadata, such as a user-friendly name and time interval information.
179 "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
180 "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
181 "description": "A String", # A description for this session.
182 "activityType": 42, # The type of activity this session represents.
183 "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # The application that created the session.
184 "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.
185 "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.
186 "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.
187 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
188 },
189 "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
190 "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
191 "name": "A String", # A human readable name of the session.
192}
193
194 currentTimeMillis: string, The client's current time in milliseconds since epoch.
195
196Returns:
197 An object of the form:
198
199 { # Sessions contain metadata, such as a user-friendly name and time interval information.
200 "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
201 "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
202 "description": "A String", # A description for this session.
203 "activityType": 42, # The type of activity this session represents.
204 "application": { # See: google3/java/com/google/android/apps/heart/platform/api/Application.java # The application that created the session.
205 "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.
206 "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.
207 "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.
208 "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
209 },
210 "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
211 "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
212 "name": "A String", # A human readable name of the session.
213 }</pre>
214</div>
215
216</body></html>