Записывайте данные о физической форме с помощью API записи

API для записи данных на мобильных устройствах позволяет вашему приложению записывать данные о физической активности с мобильного устройства экономичным с точки зрения энергопотребления способом. Например, используйте этот API для записи шагов, аналогично шагомеру, получающему данные о количестве шагов. Этот API не требует учетной записи Google для использования сервиса, а данные хранятся на самом устройстве.

If your app needs to read other health and fitness data from various sources in addition to on-device steps, integrating with Health Connect is a better option. Health Connect also provides access to on-device steps natively on Android 14 (API level 34) and higher.

В этом руководстве показано, как использовать API записи на мобильных устройствах в ваших приложениях для здоровья и фитнеса.

Пример работы с API записи на мобильных устройствах можно посмотреть на GitHub.

Важные детали

API записи на мобильных устройствах обладает рядом примечательных особенностей:

• После начала или продления подписки на запись становятся доступны данные, начиная с момента последней подписки, — за период до 10 дней.
• Данные доступны только при наличии активной подписки. Если подписка отменяется вызовом функции unsubscribe , собранные данные становятся недоступны.

Типы данных

API записи на мобильных устройствах может записывать следующие типы данных:

• TYPE_STEP_COUNT_DELTA
• TYPE_DISTANCE_DELTA
• TYPE_CALORIES_EXPENDED

Начать

Для начала добавьте следующую зависимость в файл build.gradle :

plugin {
  id("com.android.application")
}

...

dependencies {
  implementation("com.google.android.gms:play-services-fitness:21.2.0")
}

apply plugin: 'com.android.application'

...

dependencies {
  implementation 'com.google.android.gms:play-services-fitness:21.2.0'
}

Запросить разрешения

Для записи данных с помощью API записи на мобильных устройствах вашему приложению потребуется запросить следующее разрешение :

• android.permission.ACTIVITY_RECOGNITION

Выполните проверку версии Play Services.

Для использования API записи на мобильных устройствах пользователю необходимо обновить Google Play Services до LOCAL_RECORDING_CLIENT_MIN_VERSION_CODE . Проверить это можно с помощью метода isGooglePlayServicesAvailable :

val hasMinPlayServices = isGooglePlayServicesAvailable(context, LocalRecordingClient.LOCAL_RECORDING_CLIENT_MIN_VERSION_CODE)

if(hasMinPlayServices != ConnectionResult.SUCCESS) {
  // Prompt user to update their device's Google Play services app and return
}

// Continue with Recording API functions

В противном случае, если версия сервисов Google Play у пользователя слишком низкая, система выдаст исключение ConnectionResult.SERVICE_VERSION_UPDATE_REQUIRED .

Подпишитесь на Fitness Data

Для запроса фонового сбора данных о шагах используйте метод subscribe , как показано в следующем фрагменте кода:

val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Subscribe to steps data
localRecordingClient.subscribe(LocalDataType.TYPE_STEP_COUNT_DELTA)
  .addOnSuccessListener {
    Log.i(TAG, "Successfully subscribed!")
  }
  .addOnFailureListener { e ->
    Log.w(TAG, "There was a problem subscribing.", e)
  }

Чтение и обработка данных о физической подготовке

После подписки запросите данные, используя метод readData . Затем вы можете получить LocalDataPoints из полученного LocalDataSet , выполнив запрос LocalDataReadRequest , как показано в следующем фрагменте кода:

val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusWeeks(1)
val readRequest =
  LocalDataReadRequest.Builder()
    // The data request can specify multiple data types to return,
    // effectively combining multiple data queries into one call.
    // This example demonstrates aggregating only one data type.
    .aggregate(LocalDataType.TYPE_STEP_COUNT_DELTA)
    // Analogous to a "Group By" in SQL, defines how data should be
    // aggregated. bucketByTime allows bucketing by time span.
    .bucketByTime(1, TimeUnit.DAYS)
    .setTimeRange(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
    .build()

  localRecordingClient.readData(readRequest).addOnSuccessListener { response ->
    // The aggregate query puts datasets into buckets, so flatten into a
    // single list of datasets.
    for (dataSet in response.buckets.flatMap { it.dataSets }) {
      dumpDataSet(dataSet)
    }
  }
  .addOnFailureListener { e ->
    Log.w(TAG,"There was an error reading data", e)
  }

fun dumpDataSet(dataSet: LocalDataSet) {
  Log.i(TAG, "Data returned for Data type: ${dataSet.dataType.name}")
  for (dp in dataSet.dataPoints) {
    Log.i(TAG,"Data point:")
    Log.i(TAG,"\tType: ${dp.dataType.name}")
    Log.i(TAG,"\tStart: ${dp.getStartTime(TimeUnit.HOURS)}")
    Log.i(TAG,"\tEnd: ${dp.getEndTime(TimeUnit.HOURS)}")
    for (field in dp.dataType.fields) {
      Log.i(TAG,"\tLocalField: ${field.name.toString()} LocalValue: ${dp.getValue(field)}")
    }
  }
}

Компонент LocalRecordingClient постоянно обновляет свою коллекцию данных. Вы можете использовать readData для получения последних значений в любое время.

Обратите внимание, что LocalRecordingClient хранит данные за период до 10 дней. Чтобы снизить риск потери данных, вы можете использовать WorkManager для периодического сбора данных в фоновом режиме.

Отписаться от получения данных о фитнесе

Чтобы освободить ресурсы, необходимо отписаться от сбора данных с датчиков, когда ваше приложение больше в них не нуждается. Для отписки используйте метод unsubscribe :

val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Unsubscribe from steps data
localRecordingClient.unsubscribe(LocalDataType.TYPE_STEP_COUNT_DELTA)
  .addOnSuccessListener {
    Log.i(TAG, "Successfully unsubscribed!")
  }
  .addOnFailureListener { e ->
    Log.w(TAG, "There was a problem unsubscribing.", e)
  }