モバイルでの Recording API

モバイルの Recording API を使用すると、アプリは、歩数計が歩数データを取得するのと同様に、モバイル デバイスからバッテリーを効率的に消費しながら歩数を記録できます。この API はアカウントレスです。つまり、サービスを使用するために Google アカウントは必要ありません。データはデバイスに保存されます。

このガイドでは、健康とフィットネスのアプリでモバイルで Recording API を使用する方法について説明します。

例については、GitHub の モバイル向け 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")
}

Groovy 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 例外をスローします。

フィットネス データの定期購入

歩数データのバックグラウンド収集をリクエストするには、次のコード スニペットに示すように、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)
  }

Read and Process Fitness Data

サブスクライブしたら、readData メソッドを使用してデータをリクエストします。次に、次のコード スニペットに示すように、LocalDataReadRequest を作成して、結果の LocalDataSet から 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)
  }