API Reference

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

资源类型

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

Users.dataSources

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

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

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

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

数据源是根据所创建数据源的内容使用服务器生成的字符串来标识的。调用此方法时，不应设置 dataStreamId 字段。服务器将使用正确的格式自动生成该文件。如果设置了 dataStreamId，则它必须与服务器将生成的格式匹配。此格式是数据源中的一些字段的组合，并具有特定顺序。如果不匹配，请求将失败并显示错误。

如果指定未知类型的 DataType（以“com.google.”开头），则会创建具有自定义数据类型的 DataSource。自定义数据类型只能由创建它们的应用读取。自定义数据类型已弃用，请改用标准数据类型。

除了数据源 ID 中包含的数据源字段外，该数据还包含在创建数据源时进行身份验证的开发者项目编号。读取公开数据类型的任何其他开发者读取此开发者项目编号时，系统会对其进行混淆处理。
delete DELETE  /userId/dataSources/dataSourceId 删除指定的数据源。如果数据源包含任何数据点，请求将失败。
get GET  /userId/dataSources/dataSourceId 返回指定的数据源。
list GET  /userId/dataSources 使用提供的 OAuth 范围列出对开发者可见的所有数据源。该列表并非详尽无遗；用户可能拥有仅对其他开发者可见的私有数据源，或者可能使用其他范围的调用。
update PUT  /userId/dataSources/dataSourceId 更新指定的数据源。除 version 外，dataStreamId、dataType、type、dataStreamName 和 device 属性均不能修改。

数据源由其 dataStreamId 标识。

Users.dataSources.dataPointChanges

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

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

Users.dataSources.datasets

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

方法 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 更新或插入给定会话。