API записи на мобильных устройствах позволяет вашему приложению записывать шаги с мобильного устройства, экономя заряд батареи. Этот API не имеет учетной записи, то есть для использования службы не требуется учетная запись Google, а данные хранятся на устройстве.
В этом руководстве показано, как использовать API записи на мобильных устройствах для занятий спортом и фитнесом.
Примечательные детали
Есть несколько примечательных функций, уникальных для API записи на мобильных устройствах:
- После запуска или продления подписки на запись данные с момента последней подписки (до 10 дней) становятся доступными.
- Данные доступны только при наличии активной подписки. Если подписка удаляется путем вызова
unsubscribe
, собранные данные о шагах не будут доступны.
Типы данных
API записи на мобильных устройствах может записывать следующие типы данных:
Начать
Для начала добавьте следующую зависимость в файл build.gradle
:
Котлин DSL
plugin {
id("com.android.application")
}
...
dependencies {
implementation("com.google.android.gms:play-services-fitness:21.2.0")
}
Отличный DSL
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 до 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
.
Подписаться на фитнес-данные
Чтобы запросить фоновый сбор данных о шагах, используйте метод 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)
}