API การบันทึกบนอุปกรณ์เคลื่อนที่ช่วยให้แอปของคุณบันทึกจำนวนก้าวจากอุปกรณ์เคลื่อนที่ได้ ในแบบที่ประหยัดแบตเตอรี่ API นี้ไม่ต้องมีบัญชี ซึ่งหมายความว่าคุณไม่ต้อง บัญชี Google ที่จะใช้บริการและข้อมูลจะจัดเก็บอยู่ในอุปกรณ์
คู่มือนี้แสดงวิธีใช้ API การบันทึกบนอุปกรณ์เคลื่อนที่ในด้านสุขภาพของคุณและ การออกกำลังกาย
รายละเอียดสำคัญ
Recording API บนอุปกรณ์เคลื่อนที่มีคุณลักษณะเด่นหลายอย่าง:
- เมื่อการสมัครใช้บริการการบันทึกเสียงเริ่มต้นหรือต่ออายุ ข้อมูลนับตั้งแต่ล่าสุด สามารถเข้าถึงได้สูงสุด 10 วัน
- ข้อมูลจะใช้ได้เมื่อมีการสมัครใช้บริการที่ใช้งานอยู่เท่านั้น หากเป็นการสมัครใช้บริการ
ถูกนำออกโดยการเรียกใช้
unsubscribe
ดังนั้นข้อมูลขั้นตอนที่รวบรวมไว้จะเข้าถึงไม่ได้
ประเภทข้อมูล
API การบันทึกบนอุปกรณ์เคลื่อนที่สามารถบันทึกประเภทข้อมูลต่อไปนี้
เริ่มต้นใช้งาน
ในการเริ่มต้นใช้งาน ให้เพิ่มทรัพยากร Dependency ต่อไปนี้ในไฟล์ 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
ตรวจสอบเวอร์ชันของบริการ Google 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
จากนั้น คุณสามารถ
รับ LocalDataPoints จาก LocalDataSet
ผลลัพธ์โดย
สร้าง LocalDataReadRequest
ดังที่แสดงในโค้ดต่อไปนี้
ตัวอย่าง:
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)
}