睡眠データの読み取り

睡眠は、sleep タイプのセッションで表されます。セッションには、睡眠データに関するより詳細な詳細情報を提供する睡眠ステージを含めることもできます。たとえば、浅い睡眠、深い睡眠、またはレム睡眠だった場合は、次のようになります。

睡眠ステージの値
睡眠ステージの種類 値
目覚めている状態（睡眠サイクル中） 1
睡眠 2
ベッドから出 3
浅い睡眠 4
深い睡眠 5
REM 睡眠 6

睡眠データの書き込みガイドでは、Fit で詳細な睡眠データと詳細な睡眠データの両方がどのように表現されるかを紹介しています。

Android

次のサンプルでは、どちらの場合も SessionClient を使用して Fit からデータを取得します。

val SLEEP_STAGE_NAMES = arrayOf(
    "Unused",
    "Awake (during sleep)",
    "Sleep",
    "Out-of-bed",
    "Light sleep",
    "Deep sleep",
    "REM sleep"
)

val request = SessionReadRequest.Builder()
    .readSessionsFromAllApps()
    // By default, only activity sessions are included, so it is necessary to explicitly
    // request sleep sessions. This will cause activity sessions to be *excluded*.
    .includeSleepSessions()
    // Sleep segment data is required for details of the fine-granularity sleep, if it is present.
    .read(DataType.TYPE_SLEEP_SEGMENT)
    .setTimeInterval(startTime, endTime, TimeUnit.MILLISECONDS)
    .build()

sessionsClient.readSession(request)
    .addOnSuccessListener { response ->
        for (session in response.sessions) {
            val sessionStart = session.getStartTime(TimeUnit.MILLISECONDS)
            val sessionEnd = session.getEndTime(TimeUnit.MILLISECONDS)
            Log.i(TAG, "Sleep between $sessionStart and $sessionEnd")

            // If the sleep session has finer granularity sub-components, extract them:
            val dataSets = response.getDataSet(session)
            for (dataSet in dataSets) {
                for (point in dataSet.dataPoints) {
                    val sleepStageVal = point.getValue(Field.FIELD_SLEEP_SEGMENT_TYPE).asInt()
                    val sleepStage = SLEEP_STAGE_NAMES[sleepStageVal]
                    val segmentStart = point.getStartTime(TimeUnit.MILLISECONDS)
                    val segmentEnd = point.getEndTime(TimeUnit.MILLISECONDS)
                    Log.i(TAG, "\t* Type $sleepStage between $segmentStart and $segmentEnd")
                }
            }
        }
    }

REST

REST API を使用した睡眠セッションの取得は、次の 2 段階のプロセスです。

  1. activityType パラメータを 72（SLEEP）に設定してセッションのリストを取得します。注: startTime と endTime を使用するか、pageToken を使用して、前回のリクエスト以降の新しいセッションを取得できます。

    HTTP メソッド

    GET

    リクエスト URL

    https://www.googleapis.com/fitness/v1/users/me/sessions?startTime=2019-12-05T00:00.000Z&endTime=2019-12-17T23:59:59.999Z&activityType=72

    レスポンス

    Session レスポンスの例を次に示します。

    {
 "session": [
    {
     "id": "Sleep1575505620000",
     "name": "Sleep",
     "description": "",
     "startTimeMillis": "1575505620000",
     "endTimeMillis": "1575526800000",
     "modifiedTimeMillis": "1575590432413",
     "application": {
      "packageName": "com.example.sleep_tracker"
     },
     "activityType": 72  // Sleep
    },
    {
     "id": "Run2939075083",
     "name": "Mud",
     "description": "",
     "startTimeMillis": "1576594403000",
     "endTimeMillis": "1576598754000",
     "modifiedTimeMillis": "1576616010143",
     "application": {
      "packageName": "com.example.run_tracker"
     },
     "activityType": 8  // Running
    }
  ],
 "deletedSession": [],
 "nextPageToken": "1576598754001"
}

  2. 各セッションの睡眠段階の詳細（存在する場合）を取得するには、フィルタされたリストの各セッションに対して次のリクエストを使用します。

    HTTP メソッド

    POST

    リクエスト URL

    https://www.googleapis.com/fitness/v1/users/userId/dataset:aggregate

    リクエストの本文

    {
  "aggregateBy": [
    {
      "dataTypeName": "com.google.sleep.segment"
    }
  ],
  "endTimeMillis": 1575609060000,
  "startTimeMillis": 1575591360000
}

    レスポンス

    リクエストが成功すると、200 OK HTTP レスポンス ステータス コードが返されます。レスポンスの本文には、睡眠セッションを構成するアクティビティ セグメントの JSON 表現が含まれます。各 intVal は、睡眠のアクティビティ タイプを表します。

    {
 "bucket": [
  {
   "startTimeMillis": "1575591360000",
   "endTimeMillis": "1575609060000",
   "dataset": [
    {
     "point": [
      {
       "startTimeNanos": "1575591360000000000",
       "endTimeNanos": "1575595020000000000",
       "dataTypeName": "com.google.sleep.segment",
       "originDataSourceId": "...",
       "value": [
        {
         "intVal": 4, // Light sleep
         "mapVal": []
        }
       ]
      },
      {
       "startTimeNanos": "1575595020000000000",
       "endTimeNanos": "1575596220000000000",
       "dataTypeName": "com.google.sleep.segment",
       "originDataSourceId": "...",
       "value": [
        {
         "intVal": 1, // Sleep
         "mapVal": []
        }
       ]
      },

      // .... more datapoints

      {
       "startTimeNanos": "1575605940000000000",
       "endTimeNanos": "1575609060000000000",
       "dataTypeName": "com.google.sleep.segment",
       "originDataSourceId": "...",
       "value": [
        {
         "intVal": 4, // Light sleep
         "mapVal": []
        }
       ]
      }
     ]
    }
   ]
  }
 ]
}