應用程式可透過行動裝置上的 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
方法要求資料。接著
藉由產生的 LocalDataSet
,取得 LocalDataPoints,
建立 LocalDataReadRequest
,如以下程式碼所示
snippet:
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)
}