API Reference

此 API 参考文档按资源类型组织整理。每种资源类型都有一种或多种数据表示形式以及一个或多个方法。

资源类型

  1. Users.dataSources
  2. Users.dataSources.dataPointChanges
  3. Users.dataSources.dataset
  4. Users.dataset
  5. Users.sessions

Users.dataSources

如需详细了解 Users.dataSources 资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/fitness/v1/users 的相对地址
创建 POST  /userId/dataSources 创建在属于该用户的所有数据源中唯一的新数据源。

数据源是传感器数据的唯一来源。数据源可以公开来自本地设备或配套设备上的硬件传感器的原始数据。它们还可以公开通过转换或合并其他数据源创建的派生数据。同一数据类型可以有多个数据源。Fitness API 中插入或读取的每个数据集中的每个数据点都有关联的数据源。

每个数据源都会生成唯一的数据集更新流,并带有唯一的数据源标识符。并非所有对数据源的更改都会影响数据流 ID,因此,同一应用/设备的更新后的版本收集的数据可能仍会被视为属于同一数据源。

使用服务器根据生成的来源的内容生成的字符串来标识数据源。不应调用此方法时设置 dataStreamId 字段。它将由服务器以正确的格式自动生成。如果设置了 dataStreamId,它必须与服务器生成的格式相匹配。这种格式组合了数据源中的某些字段,并具有特定顺序。如果不匹配,请求将失败并显示错误。

如果指定的数据类型不是已知类型(以“com.google.&quot”开头),则会创建采用自定义数据类型的 DataSource。自定义数据类型只能由创建它们的应用读取。 自定义数据类型已弃用;请改用标准数据类型。

除了数据源 ID 中包含的数据源字段之外,还会包含创建数据源时经过身份验证的开发者项目编号。任何其他开发者在读取公共数据类型时会对此开发者项目编号进行混淆处理。
delete DELETE  /userId/dataSources/dataSourceId 删除指定的数据源。如果数据源包含任何数据点,则请求将失败。
get GET  /userId/dataSources/dataSourceId 返回指定的数据源。
list GET  /userId/dataSources 使用提供的 OAuth 范围列出开发者可以看到的所有数据源。该列表并不详尽;用户可能有只有其他开发者才能看到的不公开数据源,或者使用其他范围的调用。
update PUT  /userId/dataSources/dataSourceId 更新指定的数据源。除 version 外,dataStreamIddataTypetypedataStreamNamedevice 属性无法修改。

数据源通过其 dataStreamId 进行标识。

Users.dataSources.dataPointChanges

如需详细了解 Users.dataSources.dataPointChanges 资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/fitness/v1/users 的相对地址
list GET  /userId/dataSources/dataSourceId/dataPointChanges 查询特定数据源的用户数据点的变化。

Users.dataSources.dataset

有关 Users.dataSources.dataset 资源的详细信息,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/fitness/v1/users 的相对地址
delete DELETE  /userId/dataSources/dataSourceId/datasets/datasetId 针对开始时间和结束时间与数据集 ID 指定的时间范围重叠的所有数据点执行包含式删除操作。对于大多数数据类型,系统会删除整个数据点。对于时间跨度表示一致的值的数据类型(例如 com.google.activity.segment),并且数据点跨越数据集的任意端点,则只有数据点的重叠部分会被删除。
get GET  /userId/dataSources/dataSourceId/datasets/datasetId 返回一个数据集,其中包含所有起始点和结束点与指定的数据集最短开始时间和最长结束时间重叠的数据点。具体而言,开始时间短于或等于数据集结束时间且结束时间大于或等于数据集开始时间的任何数据点。
补丁程序 PATCH  /userId/dataSources/dataSourceId/datasets/datasetId 将数据点添加到数据集。之前不需要创建数据集。给定数据集内的所有点都将返回,并调用此数据集进行后续调用。数据点可以属于多个数据集。

此方法不使用补丁语义:提供的数据点仅仅是插入的,没有替换现有数据。

Users.dataset

如需详细了解 Users.dataset 资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/fitness/v1/users 的相对地址
聚合 POST  /userId/dataset:aggregate 将特定类型的数据或数据流汇总到桶中,除以指定类型的边界。对于每项请求,可以将来自多个来源的多个类型的数据集汇总为一个存储分区类型。

Users.sessions

如需详细了解 Users.sessions 资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/fitness/v1/users 的相对地址
delete DELETE  /userId/sessions/sessionId 删除指定会话 ID 指定的会话。
list GET  /userId/sessions 列出之前创建的会话。
update PUT  /userId/sessions/sessionId 更新或插入给定会话。