行動應用程式的 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
例外狀況。
訂閱健身資料
如要要求收集步數、距離或卡路里資料的背景收集,請使用 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
方法要求資料。接著,您可以建立 LocalDataReadRequest
,從產生的 LocalDataSet
取得 LocalDataPoint,如以下程式碼片段所示:
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)
}