Users.sessions: list

以前に作成したセッションを一覧表示します。実習をご覧ください。

リクエスト

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 で指定できます。セッション中の非アクティブな時間がわかっている場合は、com.google.activity.Segment データポイントを介して、さらに STILL アクティビティ値とともに挿入されます。
deletedSession[].activeTimeMillis long セッションのアクティブ時間。start_time_millis と end_time_millis は完全なセッション時間を定義しますが、アクティブ時間は短く設定し、active_time_millis で指定できます。セッション中の非アクティブな時間がわかっている場合は、com.google.activity.Segment データポイントを介して、さらに STILL アクティビティ値とともに挿入されます。
hasMoreData boolean 転送するデータがサーバーにあることを示すフラグ。この項目は使用しないでください。サーバーからのレスポンスに値が入力されることはありません。

お試しください。

以下の API Explorer を使ってライブデータ上でこのメソッドを呼び出し、レスポンスを確認します。