モバイルで 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
Play 開発者サービスのバージョン チェックを行う
モバイルで Recording 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
例外がスローされます。
Fitness データをサブスクライブ
歩数、距離、カロリーデータのバックグラウンド コレクションをリクエストするには、次のコード スニペットに示すように、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
メソッドを使用してデータをリクエストします。次のコード スニペットに示すように、結果の LocalDataSet
から LocalDataReadRequest
を作成することで LocalDataPoints を取得できます。
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)
}