このページは Cloud Translation API によって翻訳されました。

睡眠データを書き込む

アプリは、詳細な睡眠データの読み取りと書き込みを行うことができます。これには、SleepStages 列挙型からの浅い睡眠、深い睡眠、レム睡眠、覚醒段階が含まれます。睡眠データを書き込むには、FitnessActivities.SLEEP タイプのセッションを作成する必要があります。睡眠データが Google Fit アプリのユーザーの日誌に表示される場合は、セッションにカプセル化する必要があります。

必要に応じて、セッション内に SleepStages タイプのセグメントを挿入します。

粒度を使用しない例

ステージの粒度なしで睡眠の夜を書き込むには、次の例を使用します。開始時間と終了時間、activity SLEEP を含むセッションを作成します。

Android

val fitnessOptions = FitnessOptions.builder()
    .accessSleepSessions(FitnessOptions.ACCESS_WRITE)
    .build()

// Create the sleep session
val session= Session.Builder()
    .setName(sessionName)
    .setIdentifier(identifier)
    .setDescription(description)
    .setStartTime(startTime, TimeUnit.MILLISECONDS)
    .setEndTime(endTime, TimeUnit.MILLISECONDS)
    .setActivity(FitnessActivities.SLEEP)
    .build()

// Build the request to insert the session.
val request = SessionInsertRequest.Builder()
    .setSession(session)
    .build()

// Insert the session into Fit platform
Log.i(TAG, "Inserting the session with the SessionsClient")
Fitness.getSessionsClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
    .insertSession(request)
    .addOnSuccessListener {
        Log.i(TAG,"Session insert was successful!")
    }
    .addOnFailureListener { e ->
        Log.w(TAG, "There was a problem inserting the session", e)
    }

Android のセッションの詳細を確認する。

REST

HTTP メソッド

PUT

リクエスト URL

https://www.googleapis.com/fitness/v1/users/me/sessions/identifier

リクエストの本文

{
    "id": identifier,
    "name": sessionName,
    "description": description,
    "startTimeMillis": startTime,
    "endTimeMillis": endTime,
    "version": 1,
    "lastModifiedToken": "exampleToken",
    "application": {
        "detailsUrl": "http://example.com",
        "name": "Foo Example App",
        "version": "1.0"
    },
    "activityType": 72 // Sleep
}

睡眠ステージの粒度の例

各ステージの粒度で睡眠を書き込むには、最上位の異なる睡眠セッションと、さまざまな睡眠ステージのセグメントの両方を書き込みます。

睡眠のセグメントの書き込み

この例では、1 晩の睡眠における複数の睡眠ステージを表す複数のセグメントを記述します。

Android

val dataSource = DataSource.Builder()
    .setType(DataSource.TYPE_RAW)
    .setDataType(DataType.TYPE_SLEEP_SEGMENT)
    .setAppPackageName(context)
    // Optional but recommended for identifying the stream if you have multiple streams with the same dataType.
    .setStreamName(streamName)
    .build()

val dataPoints = listOf(
    DataPoint.builder(dataSource)
        .setTimeInterval(startTime1, endTime1, TimeUnit.MILLISECONDS)
        .setField(Field.FIELD_SLEEP_SEGMENT_TYPE, SleepStages.SLEEP_LIGHT)
        .build(),
    DataPoint.builder(dataSource)
        .setTimeInterval(startTime2, endTime2, TimeUnit.MILLISECONDS)
        .setField(Field.FIELD_SLEEP_SEGMENT_TYPE, SleepStages.SLEEP_DEEP)
        .build(),
    DataPoint.builder(dataSource)
        .setTimeInterval(startTime3, endTime3, TimeUnit.MILLISECONDS)
        .setField(Field.FIELD_SLEEP_SEGMENT_TYPE, SleepStages.SLEEP_LIGHT)
        .build(),
    DataPoint.builder(dataSource)
        .setTimeInterval(startTime4, endTime4, TimeUnit.MILLISECONDS)
        .setField(Field.FIELD_SLEEP_SEGMENT_TYPE, SleepStages.SLEEP_REM)
        .build(),
    DataPoint.builder(dataSource)
        .setTimeInterval(startTime5, endTime5, TimeUnit.MILLISECONDS)
        .setField(Field.FIELD_SLEEP_SEGMENT_TYPE, SleepStages.AWAKE)
        .build(),
    DataPoint.builder(dataSource)
        .setTimeInterval(startTime6, endTime6, TimeUnit.MILLISECONDS)
        .setField(Field.FIELD_SLEEP_SEGMENT_TYPE, SleepStages.SLEEP_LIGHT)
        .build()
)

val dataSet = DataSet.builder(dataSource)
    .addAll(dataPoints)
    .build()

REST

まず、dataSource を作成します。

HTTP メソッド

POST

リクエスト URL

https://www.googleapis.com/fitness/v1/users/me/dataSources

リクエストの本文

{
  "dataStreamName": streamName,
  "type": "raw",
  "application": {
    "detailsUrl": "http://example.com",
    "name": "Foo Example App",
    "version": "1"
  },
  "dataType": {
    "name": "com.google.sleep.segment"
  }
}

次に、dataSet を入力します。

HTTP メソッド

PATCH

リクエスト URL

https://www.googleapis.com/fitness/v1/users/userId/dataSources/dataSourceId/datasets/datasetId

リクエストの本文

{
    "dataSourceId": dataSourceId,
    "point": [
        {
            "dataTypeName": "com.google.sleep.segment",
            "startTimeNanos": startTime1,
            "endTimeNanos": endTime1,
            "value": [
                {
                    intVal: 4 // Light sleep
                }
            ]
        },
        {
            "dataTypeName": "com.google.sleep.segment",
            "startTimeNanos": startTime2,
            "endTimeNanos": endTime2,
            "value": [
                {
                    intVal: 5 // Deep sleep
                }
            ]
        },
        {
            "dataTypeName": "com.google.sleep.segment",
            "startTimeNanos": startTime3,
            "endTimeNanos": endTime3,
            "value": [
                {
                    intVal: 4 // Light sleep
                }
            ]
        },
        {
            "dataTypeName": "com.google.sleep.segment",
            "startTimeNanos": startTime4,
            "endTimeNanos": endTime4,
            "value": [
                {
                    intVal: 6 // REM sleep
                }
            ]
        },
        {
            "dataTypeName": "com.google.sleep.segment",
            "startTimeNanos": startTime5,
            "endTimeNanos": endTime5,
            "value": [
                {
                    intVal: 1 // Awake
                }
            ]
        },
        {
            "dataTypeName": "com.google.sleep.segment",
            "startTimeNanos": startTime6,
            "endTimeNanos": endTime6,
            "value": [
                {
                    intVal: 4 // Light sleep
                }
            ]
        }
     ]
 }

睡眠セッションの書き込み

最後に、睡眠セッションを挿入して上記のセグメントをグループ化します。このセッションの開始時間を、最初のセグメントの開始時間と、終了時間を最後のセグメントの終了時間に設定します。

Android

val fitnessOptions = FitnessOptions.builder()
    .accessSleepSessions(FitnessOptions.ACCESS_WRITE)
    .addDataType(DataType.TYPE_SLEEP_SEGMENT, FitnessOptions.ACCESS_WRITE)
    .build()

val session = Session.Builder()
    .setName(sessionName)
    .setIdentifier(identifier)
    .setDescription(description)
    .setStartTime(startTime1, TimeUnit.MILLISECONDS) // From first segment
    .setEndTime(endTime6, TimeUnit.MILLISECONDS) // From last segment
    .setActivity(FitnessActivities.SLEEP)
    .build()

// Build the request to insert the session.
val request = SessionInsertRequest.Builder()
    .setSession(session)
    .addDataSet(dataset)
    .build()

// Insert the session into Fit platform
Log.i(TAG, "Inserting the session in the Sessions API")
Fitness.getSessionsClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
    .insertSession(request)
    .addOnSuccessListener {
        Log.i(TAG,"Session insert was successful!")
    }
    .addOnFailureListener { e ->
        Log.i(TAG, "There was a problem inserting the session", e)
    }

REST

HTTP メソッド

PUT

リクエスト URL

https://www.googleapis.com/fitness/v1/users/me/sessions/identifier

リクエストの本文

{
    "id": identifier,
    "name": sessionName,
    "description": description,
    "startTimeMillis": startTime1,
    "endTimeMillis": endTime6,
    "version": 1,
    "lastModifiedToken": "exampleToken",
    "application": {
        "detailsUrl": "http://example.com",
        "name": "Foo Example App",
        "version": "1.0"
    },
    "activityType": 72 // Sleep
}