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,并且 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 开始时间,以从公元纪年开始计算的毫秒数(含边界值)进行表示。
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,并且省略了 startTime 和 endTime,那么其中将包含自上次同步后删除的会话。
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 用于同步后续更改的同步令牌。仅当请求中同时省略 startTime 和 endTime 时,系统才会提供此参数。
session[].activeTimeMillis long 会话活动时间。虽然 start_time_millis 和 end_time_millis 定义完整的会话时间,但活动时间可以缩短,并通过 active_time_millis 指定。如果会话期间的不活动时间已知,则还应通过 com.google.activity.segment 数据点插入,并将 STILL 活动值设为

deletedSession[].activeTimeMillis long 会话活动时间。虽然 start_time_millis 和 end_time_millis 定义完整的会话时间,但活动时间可以缩短,并通过 active_time_millis 指定。如果会话期间的不活动时间已知,则还应通过 com.google.activity.segment 数据点插入,并将 STILL 活动值设为

hasMoreData boolean 用于指示服务器有更多数据要传输的标志。请勿使用此字段。服务器响应中绝不会填充此字段。

试试看!

使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。