Users.sessions: list

列出之前创建的会话。 立即尝试

请求

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,并且同时省略 startTimeendTime,则返回会话删除事件。
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 结束时间介于请求的 startTimeendTime 之间的会话。

session[].id string 客户端生成的标识符,在该特定用户拥有的所有会话中具有唯一性。
session[].name string 简单易懂的会话名称。
session[].description string 此课程的说明。
session[].startTimeMillis long 开始时间(以毫秒为单位,从新纪元开始,含边界值)。
session[].endTimeMillis long 结束时间(以毫秒为单位,从新纪元开始,含边界值)。
session[].modifiedTimeMillis long 指明会话上次修改时间的时间戳。
session[].application nested object 创建会话的应用。
session[].application.packageName string 此应用的软件包名称。此标识符在 Android 应用创建时用作唯一标识符,但 REST 客户端无法指定它。REST 客户端的开发者项目编号会反映在数据源数据流 ID 中,而不是体现在 packageName 中。
session[].application.version string 应用的版本。每当应用以影响数据计算的方式发生更改时,您都应该更新此字段。
session[].application.detailsUrl string 可选 URI,可用于链接回应用。
session[].application.name string 此应用的名称。此名称对 REST 客户端是必需的,但我们不强制使用此名称的唯一性。为方便其他开发者识别哪个 REST 创建了应用程序或数据源,我们特此提供了此信息。
session[].activityType integer 此会话所代表的活动类型。
deletedSession[] list 如果请求中的 includeDeleted 设为 true,且省略了 startTimeendTime,则会包含自上次同步后删除的会话。
deletedSession[].id string 客户端生成的标识符,在该特定用户拥有的所有会话中具有唯一性。
deletedSession[].name string 简单易懂的会话名称。
deletedSession[].description string 此课程的说明。
deletedSession[].startTimeMillis long 开始时间(以毫秒为单位,从新纪元开始,含边界值)。
deletedSession[].endTimeMillis long 结束时间(以毫秒为单位,从新纪元开始,含边界值)。
deletedSession[].modifiedTimeMillis long 指明会话上次修改时间的时间戳。
deletedSession[].application nested object 创建会话的应用。
deletedSession[].application.packageName string 此应用的软件包名称。此标识符在 Android 应用创建时用作唯一标识符,但 REST 客户端无法指定它。REST 客户端的开发者项目编号会反映在数据源数据流 ID 中,而不是体现在 packageName 中。
deletedSession[].application.version string 应用的版本。每当应用以影响数据计算的方式发生更改时,您都应该更新此字段。
deletedSession[].application.detailsUrl string 可选 URI,可用于链接回应用。
deletedSession[].application.name string 此应用的名称。此名称对 REST 客户端是必需的,但我们不强制使用此名称的唯一性。为方便其他开发者识别哪个 REST 创建了应用程序或数据源,我们特此提供了此信息。
deletedSession[].activityType integer 此会话所代表的活动类型。
nextPageToken string 用于同步进一步更改的同步令牌。仅当请求中同时省略 startTimeendTime 时,系统才会提供此值。
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 针对实际数据调用此方法并查看响应。