API Reference

この API リファレンスは、リソースタイプ別にまとめられています。各リソースタイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。

リソースタイプ

  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 を基準とします。
create POST  /userId/dataSources このユーザーに属するすべてのデータソース間で一意の新しいデータソースを作成します。

データソースは、センサーデータの一意のソースです。データソースによって、ローカル デバイスまたはコンパニオン デバイスのハードウェア センサーから得られる元データが公開される可能性があります。また、他のデータソースを変換または結合して作成された派生データを公開することもできます。同じデータ型に対して複数のデータソースが存在する可能性があります。Fitness API に挿入または読み取られるすべてのデータセット内のデータポイントには、それぞれデータソースが関連付けられています。

各データソースは、データセットの更新に固有のストリームと、固有のデータソース識別子を生成します。データソースに対するすべての変更がデータ ストリーム ID に影響するわけではないため、同じアプリケーションまたはデバイスの更新されたバージョンによって収集されたデータは、同じデータソースに属しているとみなすことができます。

データソースは、作成されるソースのコンテンツに基づいて、サーバーによって生成された文字列を使用して識別されます。このメソッドを呼び出すときは、dataStreamId フィールドを設定しないでください。これは、正しい形式でサーバーによって自動的に生成されます。dataStreamId が設定されている場合は、サーバーが生成する形式と一致する必要があります。この形式は、データソースのいくつかのフィールドを組み合わせたもので、特定の順序があります。一致しない場合、リクエストはエラーで失敗します。

既知の型("com.google." で始まる)ではない DataType を指定すると、カスタムデータ型の DataSource が作成されます。カスタムデータ型は、そのデータ型を作成したアプリケーションのみが読み取ることができます。カスタムデータ型は非推奨です。代わりに標準のデータ型を使用してください。

データソース ID に含まれるデータソース フィールドに加えて、データソースの作成時に認証されるデベロッパー プロジェクト番号が含まれます。このデベロッパー プロジェクト番号は、他のデベロッパーが一般公開のデータタイプを読み取るときに難読化されます。
delete DELETE  /userId/dataSources/dataSourceId 指定したデータソースを削除します。データソースにデータポイントが含まれている場合、リクエストは失敗します。
get GET  /userId/dataSources/dataSourceId 指定されたデータソースを返します。
list GET  /userId/dataSources 指定された OAuth スコープを使用して、デベロッパーに表示されるすべてのデータソースを一覧表示します。このリストはすべてを網羅しているわけではありません。ユーザーは、他のデベロッパーにしか表示されない非公開のデータソースや、他のスコープを使用する呼び出しを使用している可能性があります。
update PUT  /userId/dataSources/dataSourceId 指定したデータソースを更新します。dataStreamIddataTypetypedataStreamNamedevice のプロパティ(version を除く)は変更できません。

データソースは 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 PATCH  /userId/dataSources/dataSourceId/datasets/datasetId データポイントをデータセットに追加します。事前にデータセットを作成しておく必要はありません。指定したデータセット内のすべてのポイントが返され、その後は、このデータセットを取得するための呼び出しが行われます。データポイントは複数のデータセットに属することができます。

この方法では、パッチのセマンティクスは使用されません。提供されたデータポイントは挿入のみで、既存のデータは置き換えられません。

Users.dataset

Users.dataset リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/fitness/v1/users を基準とします。
aggregate POST  /userId/dataset:aggregate 特定のタイプまたはストリームのデータを、特定のタイプの境界で割ったバケットに集約します。複数のタイプと複数のソースから得られた複数のデータセットは、リクエストごとに 1 つのバケットタイプに集約できます。

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 特定のセッションを更新または挿入します。