行動裝置上的錄製 API

行動裝置上的錄製 API 可讓應用程式以省電的方式記錄行動裝置的步數。此 API 無帳戶介面，意味著無需 Google 帳戶也能使用這項服務，且資料會儲存在裝置中。

本指南說明如何在行動裝置上使用 Recording API，提升健康與健身體驗。

重要細節

使用行動裝置的錄製 API 有幾項專屬功能：

• 記錄訂閱開始後，裝置中最多只會儲存 10 天的資料。
• 只有在訂閱有效時，系統才會提供資料。如果透過呼叫 unsubscribe 移除訂閱項目，您將無法存取收集到的步數資料。

資料類型

行動裝置上的錄製 API 可以記錄下列資料類型：

• TYPE_STEP_COUNT_DELTA

立即開始

如要開始使用，請在 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'
}

要求權限

如要在行動裝置上使用 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 方法要求資料。接著，您可以從產生的 DataSet 中取得 DataPoints，方法是建立 DataReadRequest，如下列程式碼片段所示：

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 來提取最新的數字。

請注意，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)
  }