列出之前创建的会话。 立即尝试。
请求
HTTP 请求
GET https://www.googleapis.com/fitness/v1/users/userId/sessions
参数
参数名称 | 值 | 说明 |
---|---|---|
路径参数 | ||
userId |
string |
列出所识别的人员的会话。使用 me 指示经过身份验证的用户。目前仅支持 me 。
|
可选的查询参数 | ||
activityType |
integer |
如果为非空,系统应仅返回具有这些活动类型的会话。 |
endTime |
string |
RFC3339 时间戳。只有介于开始时间和结束时间之间的会话才会包含在响应中。如果省略了这个时间,但指定了 startTime,系统将返回从 startTime 到结束时间的所有会话。 |
includeDeleted |
boolean |
如果为 true,并且省略 startTime 和 endTime,则返回会话删除。 |
pageToken |
string |
用于增量同步的继续令牌。如需获取下一批更改,请将此参数设置为上一个响应中 nextPageToken 的值。如果指定了开始时间或结束时间,则系统会忽略页面令牌。如果开始时间、结束时间和页面令牌都未指定,则返回过去 30 天内修改的会话。
|
startTime |
string |
RFC3339 时间戳。只有介于开始时间和结束时间之间的会话才会包含在响应中。如果省略了这个时间,但指定了 endTime,则系统将返回从开始时间到 endTime 的所有会话。 |
授权
此请求需要获得以下至少一个范围的授权:
范围 |
---|
https://www.googleapis.com/auth/fitness.activity.read |
https://www.googleapis.com/auth/fitness.activity.write |
https://www.googleapis.com/auth/fitness.location.read |
https://www.googleapis.com/auth/fitness.location.write |
https://www.googleapis.com/auth/fitness.body.read |
https://www.googleapis.com/auth/fitness.body.write |
https://www.googleapis.com/auth/fitness.nutrition.read |
https://www.googleapis.com/auth/fitness.nutrition.write |
https://www.googleapis.com/auth/fitness.blood_pressure.read |
https://www.googleapis.com/auth/fitness.blood_pressure.write |
https://www.googleapis.com/auth/fitness.blood_glucose.read |
https://www.googleapis.com/auth/fitness.blood_glucose.write |
https://www.googleapis.com/auth/fitness.oxygen_saturation.read |
https://www.googleapis.com/auth/fitness.oxygen_saturation.write |
https://www.googleapis.com/auth/fitness.body_temperature.read |
https://www.googleapis.com/auth/fitness.body_temperature.write |
https://www.googleapis.com/auth/fitness.reproductive_health.read |
https://www.googleapis.com/auth/fitness.reproductive_health.write |
如需了解详情,请参阅身份验证和授权页面。
请求正文
使用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "session": [ { "id": string, "name": string, "description": string, "startTimeMillis": long, "endTimeMillis": long, "modifiedTimeMillis": long, "application": { "packageName": string, "version": string, "detailsUrl": string, "name": string }, "activityType": integer, "activeTimeMillis": long } ], "deletedSession": [ { "id": string, "name": string, "description": string, "startTimeMillis": long, "endTimeMillis": long, "modifiedTimeMillis": long, "application": { "packageName": string, "version": string, "detailsUrl": string, "name": string }, "activityType": integer, "activeTimeMillis": long } ], "nextPageToken": string, "hasMoreData": boolean }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
session[] |
list |
结束时间介于请求的 startTime 到 endTime 之间的会话。 |
|
session[].id |
string |
客户端生成的标识符,该标识符在该用户拥有的所有会话中是唯一的。 | |
session[].name |
string |
直观易懂的会话名称。 | |
session[].description |
string |
此会话的说明。 | |
session[].startTimeMillis |
long |
开始时间(以毫秒为单位,从 Epoch 起算)。 | |
session[].endTimeMillis |
long |
结束时间(以毫秒为单位,从 Epoch 起算)。 | |
session[].modifiedTimeMillis |
long |
指明会话上次修改时间的时间戳。 | |
session[].application |
nested object |
创建会话的应用。 | |
session[].application.packageName |
string |
此应用的软件包名称。该标识符在 Android 应用创建时用作唯一标识符,但 REST 客户端不能指定该标识符。REST 客户端会将其开发者项目编号(而非 packageName)反映到数据源数据流 ID 中。 | |
session[].application.version |
string |
应用的版本。当应用以影响数据计算的方式发生变化时,您都应更新此字段。 | |
session[].application.detailsUrl |
string |
可选 URI,可用于链接回应用。 | |
session[].application.name |
string |
此应用的名称。REST 客户端必须填写此字段,但我们不强制要求此名称的唯一性。我们提供它只是为了方便其他开发者确定是哪一个 REST 创建了应用程序或数据源。 | |
session[].activityType |
integer |
此会话所代表的活动类型。 | |
deletedSession[] |
list |
如果在请求中将 includeDeleted 设为 true,并省略 startTime 和 endTime,则这包括自上次同步后删除的会话。 |
|
deletedSession[].id |
string |
客户端生成的标识符,该标识符在该用户拥有的所有会话中是唯一的。 | |
deletedSession[].name |
string |
直观易懂的会话名称。 | |
deletedSession[].description |
string |
此会话的说明。 | |
deletedSession[].startTimeMillis |
long |
开始时间(以毫秒为单位,从 Epoch 起算)。 | |
deletedSession[].endTimeMillis |
long |
结束时间(以毫秒为单位,从 Epoch 起算)。 | |
deletedSession[].modifiedTimeMillis |
long |
指明会话上次修改时间的时间戳。 | |
deletedSession[].application |
nested object |
创建会话的应用。 | |
deletedSession[].application.packageName |
string |
此应用的软件包名称。该标识符在 Android 应用创建时用作唯一标识符,但 REST 客户端不能指定该标识符。REST 客户端会将其开发者项目编号(而非 packageName)反映到数据源数据流 ID 中。 | |
deletedSession[].application.version |
string |
应用的版本。当应用以影响数据计算的方式发生变化时,您都应更新此字段。 | |
deletedSession[].application.detailsUrl |
string |
可选 URI,可用于链接回应用。 | |
deletedSession[].application.name |
string |
此应用的名称。REST 客户端必须填写此字段,但我们不强制要求此名称的唯一性。我们提供它只是为了方便其他开发者确定是哪一个 REST 创建了应用程序或数据源。 | |
deletedSession[].activityType |
integer |
此会话所代表的活动类型。 | |
nextPageToken |
string |
用于同步进一步更改的同步令牌。仅当请求中同时省略了 startTime 和 endTime 时,系统才会提供此字段。 | |
session[].activeTimeMillis |
long |
会话活跃时间。虽然 start_time_millis 和 end_time_millis 定义了完整的会话时间,但活跃时间可以更短,可以通过 active_time_millis 指定。如果会话期间的非活动时间已知,则还应通过具有 STILL activity 值 的 com.google.activity.segment 数据点插入 |
|
deletedSession[].activeTimeMillis |
long |
会话活跃时间。虽然 start_time_millis 和 end_time_millis 定义了完整的会话时间,但活跃时间可以更短,可以通过 active_time_millis 指定。如果会话期间的非活动时间已知,则还应通过具有 STILL activity 值 的 com.google.activity.segment 数据点插入 |
|
hasMoreData |
boolean |
此标记指示服务器还有更多数据要传输。请勿使用此字段。永远不会在来自服务器的响应中填充它。 |
试试看!
请使用下面的 API Explorer 对实际数据调用此方法,并查看响应。