以前に作成されたセッションを一覧表示します。 実習をご覧ください。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/fitness/v1/users/userId/sessions
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
userId |
string |
識別されたユーザーのセッションを一覧表示します。me を使用して、認証済みユーザーを示します。現時点では me のみがサポートされています。
|
省略可能なクエリ パラメータ | ||
activityType |
integer |
空でない場合は、これらのアクティビティ タイプのセッションのみが返されます。 |
endTime |
string |
RFC3339 タイムスタンプ。開始時間から終了時間の間に終了するセッションのみがレスポンスに含まれます。この時間を省略して startTime を指定すると、startTime から終了時間までのすべてのセッションが返されます。 |
includeDeleted |
boolean |
true で、startTime と endTime の両方を省略すると、セッションの削除が返されます。 |
pageToken |
string |
継続トークン。増分同期に使用されます。次の変更バッチを取得するには、このパラメータを前のレスポンスの nextPageToken の値に設定します。開始時間または終了時間が指定されている場合、ページトークンは無視されます。開始時間、終了時間、ページトークンのいずれも指定されていない場合は、過去 30 日以内に変更されたセッションが返されます。 |
startTime |
string |
RFC3339 タイムスタンプ。開始時間から終了時間の間に終了するセッションのみがレスポンスに含まれます。この時間を省略して endTime を指定すると、開始時間から endTime までのすべてのセッションが返されます。 |
認可
このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。
範囲 |
---|
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 |
詳細については、認証と認可のページをご覧ください。
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{ "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 } ], "deletedSession": [ { "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 } ], "nextPageToken": string, "hasMoreData": boolean }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
session[] |
list |
終了時間がリクエストの startTime~endTime のセッション。 |
|
session[].id |
string |
クライアントが生成し、この特定のユーザーが所有するすべてのセッションで一意の識別子。 | |
session[].name |
string |
人が読める形式のセッション名。 | |
session[].description |
string |
このセッションの説明。 | |
session[].startTimeMillis |
long |
エポックからのミリ秒単位の開始時間(ミリ秒を含む)。 | |
session[].endTimeMillis |
long |
エポックからのミリ秒単位で示した終了時間。 | |
session[].modifiedTimeMillis |
long |
セッションが最後に変更された時刻を示すタイムスタンプ。 | |
session[].application |
nested object |
セッションを作成したアプリケーション。 | |
session[].application.packageName |
string |
このアプリケーションのパッケージ名。Android アプリの作成時に一意の識別子として使用されます。REST クライアントでは指定できません。REST クライアントのデベロッパー プロジェクト番号は、packageName ではなく、データソース データ ストリーム ID に反映されます。 | |
session[].application.version |
string |
アプリケーションのバージョン。データの計算に影響するような方法でアプリケーションが変更されるたびに、このフィールドを更新する必要があります。 | |
session[].application.detailsUrl |
string |
アプリケーションに戻るために使用できる URI(省略可)。 | |
session[].application.name |
string |
このアプリケーションの名前。これは REST クライアントでは必須ですが、この名前の一意性は強制されません。アプリケーションやデータソースを作成した REST を知りたい他のデベロッパーのために用意されており、便宜上提供されています。 | |
session[].activityType |
integer |
このセッションが表すアクティビティのタイプ。 | |
deletedSession[] |
list |
リクエストで includeDeleted が true に設定され、startTime と endTime が省略されている場合は、前回の同期以降に削除されたセッションも含まれます。 |
|
deletedSession[].id |
string |
クライアントが生成し、この特定のユーザーが所有するすべてのセッションで一意の識別子。 | |
deletedSession[].name |
string |
人が読める形式のセッション名。 | |
deletedSession[].description |
string |
このセッションの説明。 | |
deletedSession[].startTimeMillis |
long |
エポックからのミリ秒単位の開始時間(ミリ秒を含む)。 | |
deletedSession[].endTimeMillis |
long |
エポックからのミリ秒単位で示した終了時間。 | |
deletedSession[].modifiedTimeMillis |
long |
セッションが最後に変更された時刻を示すタイムスタンプ。 | |
deletedSession[].application |
nested object |
セッションを作成したアプリケーション。 | |
deletedSession[].application.packageName |
string |
このアプリケーションのパッケージ名。Android アプリの作成時に一意の識別子として使用されます。REST クライアントでは指定できません。REST クライアントのデベロッパー プロジェクト番号は、packageName ではなく、データソース データ ストリーム ID に反映されます。 | |
deletedSession[].application.version |
string |
アプリケーションのバージョン。データの計算に影響するような方法でアプリケーションが変更されるたびに、このフィールドを更新する必要があります。 | |
deletedSession[].application.detailsUrl |
string |
アプリケーションに戻るために使用できる URI(省略可)。 | |
deletedSession[].application.name |
string |
このアプリケーションの名前。これは REST クライアントでは必須ですが、この名前の一意性は強制されません。アプリケーションやデータソースを作成した REST を知りたい他のデベロッパーのために用意されており、便宜上提供されています。 | |
deletedSession[].activityType |
integer |
このセッションが表すアクティビティのタイプ。 | |
nextPageToken |
string |
以降の変更の同期に使用される同期トークン。これは、リクエストで startTime と endTime の両方が省略されている場合にのみ提供されます。 | |
session[].activeTimeMillis |
long |
セッションのアクティブ時間。start_time_millis と end_time_millis は完全なセッション時間を定義しますが、アクティブ時間はこれより短く、active_time_millis で指定できます。セッション中の非アクティブ時間がわかっている場合は、STILL アクティビティ値を持つ com.google.activity.segment データポイントを介して挿入する必要もあります。 |
|
deletedSession[].activeTimeMillis |
long |
セッションのアクティブ時間。start_time_millis と end_time_millis は完全なセッション時間を定義しますが、アクティブ時間はこれより短く、active_time_millis で指定できます。セッション中の非アクティブ時間がわかっている場合は、STILL アクティビティ値を持つ com.google.activity.segment データポイントを介して挿入する必要もあります。 |
|
hasMoreData |
boolean |
転送するデータがさらにあることを示すフラグ。この項目は使用しないでください。サーバーからのレスポンスに値が入力されることはありません。 |
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。