Écrire des données de sommeil

Votre application peut lire et écrire des données précises sur le sommeil. Cela inclut les phases de sommeil léger, de sommeil profond, paradoxal et éveillé du type énuméré SleepStages. Pour écrire des données sur le sommeil, vous devez créer une session de type FitnessActivities.SLEEP. Les données sur le sommeil doivent être encapsulées dans une session pour pouvoir figurer dans le journal de l'utilisateur de l'application Google Fit.

Vous pouvez également insérer des segments de type SleepStages dans la session:

• SleepStages.SLEEP_LIGHT
• SleepStages.SLEEP_DEEP
• SleepStages.SLEEP_REM
• SleepStages.AWAKE
• SleepStages.OUT_OF_BED

Exemple sans précision

Pour écrire une nuit de sommeil sans précision par phase, suivez l'exemple ci-dessous. Créez une session avec des heures de début et de fin, ainsi que le activity de SOMMEIL.

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)
    }

En savoir plus sur les sessions dans Android

REST

Méthode HTTP

PUT

URL de la requête

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

Corps de la requête

{
    "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
}

Exemple de précision des phases de sommeil

Pour écrire un sommeil avec précision par phase, écrivez à la fois la session de sommeil de niveau supérieur et les segments correspondant aux différentes phases de sommeil.

Modifier les segments de sommeil

Dans cet exemple, nous allons écrire plusieurs segments pour représenter les différentes phases de sommeil au cours d'une nuit.

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

1. Commencez par créer le dataSource:

   Méthode HTTP

   POST
   

   URL de la requête

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

   Corps de la requête

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

2. Ensuite, renseignez dataSet:

   Méthode HTTP

   PATCH
   

   URL de la requête

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

   Corps de la requête

   {
       "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
                   }
               ]
           }
        ]
    }
   

Modifier les données de session de sommeil

Enfin, regroupez les segments ci-dessus en insérant une session de sommeil. Définissez l'heure de début de cette session sur l'heure de début du premier segment et l'heure de fin sur l'heure de fin du dernier segment.

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

Méthode HTTP

PUT

URL de la requête

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

Corps de la requête

{
    "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
}