この API リファレンスは、リソースタイプ別にまとめられています。各リソースタイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。
リソースタイプ
- Users.dataSources
- Users.dataSources.dataPointChanges
- Users.dataSources.datasets
- Users.dataset
- Users.sessions
Users.dataSources
Users.dataSources リソースの詳細については、リソースの表記ページをご覧ください。
メソッド | HTTP リクエスト | 説明 |
---|---|---|
特に明記されていない限り、URI は https://www.googleapis.com/fitness/v1/users を基準とします。 | ||
create |
POST /userId/dataSources
|
このユーザーに属するすべてのデータソース全体で一意の新しいデータソースを作成します。
データソースは、センサーデータの一意のソースです。データソースは、ローカル デバイスやコンパニオン デバイスのハードウェア センサーから取得した元データを公開できます。また、他のデータソースを変換または結合して作成された派生データを公開することもできます。同じデータ型に対して複数のデータソースが存在する場合があります。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
|
指定されたデータソースを更新します。dataStreamId 、dataType 、type 、dataStreamName 、device プロパティ(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
|
指定したセッションを更新または挿入します。 |