モバイルで Recording API を使用すると、アプリはバッテリー効率の高い方法でモバイル デバイスから歩数を記録できます。この API はアカウントレスです。つまり、サービスを使用するのに Google アカウントを必要とせず、データはデバイスに保存されます。
このガイドでは、モバイル デバイスで健康とフィットネスのために Recording API を使用する方法について説明します。
重要な詳細
モバイル版の Recording API に固有の注目すべき機能がいくつかあります。
- 録音の定期購入が開始されると、最大 10 日分のデータがデバイスに保存されます。
- データを利用できるのは、有効なサブスクリプションがある場合のみです。
unsubscribe
を呼び出してサブスクリプションを削除すると、収集された歩数データにはアクセスできなくなります。
データ型
モバイルの Recording API では、次のデータ型を録音できます。
スタートガイド
まず、build.gradle
ファイルに次の依存関係を追加します。
Kotlin 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'
}
権限をリクエストする
モバイルで Recording API を使用してデータを記録するには、アプリで次の権限をリクエストする必要があります。
android.permission.ACTIVITY_RECOGNITION
フィットネス データに登録
歩数、距離、カロリーのバックグラウンドでの収集をリクエストするには、次のコード スニペットに示すように subscribe
メソッドを使用します。
val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Subscribe to steps data
localRecordingClient.subscribe(DataType.TYPE_STEP_COUNT_DELTA)
.addOnSuccessListener {
Log.i(TAG, "Successfully subscribed!")
}
.addOnFailureListener { e ->
Log.w(TAG, "There was a problem subscribing.", e)
}
フィットネス データの読み取りと処理
サブスクライブしたら、readData
メソッドを使用してデータをリクエストします。その後、次のコード スニペットに示すように、DataReadRequest を実行することで、結果の DataSet から DataPoint を取得できます。
val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusWeeks(1)
val readRequest =
DataReadRequest.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(DataType.AGGREGATE_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: DataSet) {
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.getStartTimeString()}")
Log.i(TAG,"\tEnd: ${dp.getEndTimeString()}")
for (field in dp.dataType.fields) {
Log.i(TAG,"\tField: ${field.name.toString()} Value: ${dp.getValue(field)}")
}
}
}
LocalRecordingClient
は、データの収集を継続的に更新します。readData を使用すると、いつでも最新の数値を pull できます。
LocalRecordingClient
には最大 10 日分のデータが保存されます。データ損失のリスクを軽減するには、WorkManager を使用して、バックグラウンドで定期的にデータを収集します。
フィットネス データの登録を解除
リソースを解放するため、アプリでセンサーデータが不要になったときは、センサーデータの収集から登録を解除する必要があります。登録を解除するには、unsubscribe
メソッドを使用します。
val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Unsubscribe from steps data
localRecordingClient.unsubscribe(DataType.TYPE_STEP_COUNT_DELTA)
.addOnSuccessListener {
Log.i(TAG, "Successfully unsubscribed!")
}
.addOnFailureListener { e ->
Log.w(TAG, "There was a problem unsubscribing.", e)
}