Users.dataset: aggregate

将特定类型的数据或数据流按给定类型的边界划分到不同的存储分区中。每个请求可以只将多种类型且来自多个来源的多个数据集汇总到一种类型的存储分区中。立即尝试。

请求

HTTP 请求

POST https://www.googleapis.com/fitness/v1/users/userId/dataset:aggregate

参数

参数名称 值 说明
路径参数
userId string 所识别用户的汇总数据。使用 me 指示经过身份验证的用户。目前仅支持 me。

授权

此请求需要获得以下至少一个范围的授权：

范围
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

如需了解详情，请参阅身份验证和授权页面。

请求正文

在请求正文中，请按以下结构提供数据：

{
  "startTimeMillis": long,
  "endTimeMillis": long,
  "aggregateBy": [
    {
      "dataTypeName": string,
      "dataSourceId": string
    }
  ],
  "filteredDataQualityStandard": [
    string
  ],
  "bucketByTime": {
    "durationMillis": long,
    "period": {
      "type": string,
      "value": integer,
      "timeZoneId": string
    }
  },
  "bucketBySession": {
    "minDurationMillis": long
  },
  "bucketByActivityType": {
    "minDurationMillis": long,
    "activityDataSourceId": string
  },
  "bucketByActivitySegment": {
    "minDurationMillis": long,
    "activityDataSourceId": string
  }
}
属性名称 值 说明 备注
startTimeMillis long 时间范围的开始时间。与此时间范围相交的数据将进行汇总。该时间是自纪元（含）以来的毫秒数。
endTimeMillis long 时段的结束时间。与此时间范围相交的数据将进行汇总。该时间是自纪元（含）以来的毫秒数。
aggregateBy[] list 指定要汇总的数据的规范。必须提供至少一项 aggregateBy 规范。指定的所有数据都将使用相同的分桶条件进行汇总。对于每个 aggregateBy 规范，响应中都会有一个数据集。
aggregateBy[].dataTypeName string 要汇总的数据类型。提供此数据类型的所有数据源都会为汇总提供数据。响应将包含此数据类型名称的单个数据集。数据集的数据源 ID 将是派生的：:com.google.android.gms:aggregated。如果用户没有此数据类型的数据，则返回空数据集。注意：数据可以按 dataTypeName 或 dataSourceId 进行聚合，不能同时按两者。
aggregateBy[].dataSourceId string 要汇总的数据源 ID。只有来自指定数据源 ID 的数据才会包含在汇总中。如果指定，此数据源必须存在；所提供凭据中的 OAuth 范围必须授予对此数据类型的读取权限。响应中的数据集将具有相同的数据源 ID。注意：数据可以按 dataTypeName 或 dataSourceId 进行聚合，不能同时按两者。
filteredDataQualityStandard[] list 请勿填写此字段。会被忽略。
bucketByTime nested object 指定按单个时间间隔进行汇总。与其他分桶规范相互排斥。
bucketByTime.durationMillis long 指定结果分区正好按照 durationMillis 时间范围汇总数据。不含数据的时间范围将包含在响应中，其中包含一个空数据集。
bucketByTime.period nested object
bucketByTime.period.type string

可接受的值：
  • "day"
  • "month"
  • "week"
bucketByTime.period.value integer
bucketByTime.period.timeZoneId string org.joda.timezone.DateTimeZone
bucketBySession nested object 指定按用户会话汇总数据。不在会话时间范围内的数据将不会包含在响应中。与其他分桶规范相互排斥。
bucketBySession.minDurationMillis long 指定仅时长超过 minDurationMillis 的会话被视为并用作汇总数据的容器。
bucketByActivityType nested object 指定按记录数据时所执行活动的类型对数据进行汇总。在特定活动类型期间（在给定的时间范围内）记录的所有数据会汇总到同一存储分区中。响应不包含在用户未活动时记录的数据。与其他分桶规范相互排斥。
bucketByActivityType.minDurationMillis long 指定仅将时长超过 minDurationMillis 的活动细分视为汇总数据的容器。
bucketByActivityType.activityDataSourceId string 如果未指定特定的 activityDataSourceId，系统将使用默认活动流。
bucketByActivitySegment nested object 指定对用户记录的每个活动细分进行汇总。与 bucketByActivitySegment 类似，但分桶是针对每个活动细分（而非同一类型的所有细分）完成的。与其他分桶规范相互排斥。
bucketByActivitySegment.minDurationMillis long 指定仅将时长超过 minDurationMillis 的活动细分视为汇总数据的容器。
bucketByActivitySegment.activityDataSourceId string 如果未指定特定的 activityDataSourceId，系统将使用默认活动流。

响应

如果成功，此方法将返回采用以下结构的响应正文：

{
  "bucket": [
    {
      "type": string,
      "startTimeMillis": long,
      "endTimeMillis": long,
      "dataset": [
        users.dataSources.datasets Resource
      ],
      "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
      },
      "activity": integer
    }
  ]
}
属性名称 值 说明 备注
bucket[] list 包含汇总数据的存储分区列表。
bucket[].type string 存储分区的类型表示数据汇总在存储分区中是如何执行的。

可接受的值：
  • "activitySegment"
  • "activityType"
  • "session"
  • "time"
  • "unknown"
bucket[].startTimeMillis long 汇总数据的开始时间（以毫秒为单位，从 Epoch 起算）。
bucket[].endTimeMillis long 汇总数据的结束时间（以毫秒为单位，从 Epoch 起算）。
bucket[].dataset[] list 请求中每个 AggregateBy 都有一个数据集。
bucket[].session nested object 适用于 Bucket.Type.SESSION
bucket[].session.id string 客户端生成的标识符，该标识符在该用户拥有的所有会话中是唯一的。
bucket[].session.name string 直观易懂的会话名称。
bucket[].session.description string 此会话的说明。
bucket[].session.startTimeMillis long 开始时间（以毫秒为单位，从 Epoch 起算）。
bucket[].session.endTimeMillis long 结束时间（以毫秒为单位，从 Epoch 起算）。
bucket[].session.modifiedTimeMillis long 指明会话上次修改时间的时间戳。
bucket[].session.application nested object 创建会话的应用。
bucket[].session.application.packageName string 此应用的软件包名称。该标识符在 Android 应用创建时用作唯一标识符，但 REST 客户端不能指定该标识符。REST 客户端会将其开发者项目编号（而非 packageName）反映到数据源数据流 ID 中。
bucket[].session.application.version string 应用的版本。当应用以影响数据计算的方式发生变化时，您都应更新此字段。
bucket[].session.application.detailsUrl string 可选 URI，可用于链接回应用。
bucket[].session.application.name string 此应用的名称。REST 客户端必须填写此字段，但我们不强制要求此名称的唯一性。我们提供它只是为了方便其他开发者确定是哪一个 REST 创建了应用程序或数据源。
bucket[].session.activityType integer 此会话所代表的活动类型。
bucket[].session.activeTimeMillis long 会话活跃时间。虽然 start_time_millis 和 end_time_millis 定义了完整的会话时间，但活跃时间可以更短，可以通过 active_time_millis 指定。如果会话期间的非活动时间已知，则还应通过具有 STILL activity 值

的 com.google.activity.segment 数据点插入
bucket[].activity integer 适用于 Bucket.Type.ACTIVITY_TYPE、Bucket.Type.ACTIVITY_SEGMENT

试试看！

请使用下面的 API Explorer 对实际数据调用此方法，并查看响应。