Logging API na urządzeniach mobilnych

Logging API na urządzeniach mobilnych umożliwia aplikacji rejestrowanie kroków z urządzenia mobilnego w sposób oszczędzający baterię. Ten interfejs API nie wymaga konta, co oznacza, że do korzystania z niej nie jest wymagane konto Google, a dane są przechowywane na urządzeniu.

Z tego przewodnika dowiesz się, jak korzystać z interfejsu Logging API na urządzeniach mobilnych, aby monitorować swój stan zdrowia i aktywność fizyczną.

Ważne informacje

Jest kilka ważnych funkcji, które są dostępne wyłącznie w interfejsie Logging API na urządzeniach mobilnych:

  • Po rozpoczęciu subskrypcji na urządzeniu są przechowywane dane z maksymalnie 10 dni.
  • Dane są dostępne tylko wtedy, gdy masz aktywną subskrypcję. Jeśli subskrypcja zostanie usunięta przez wywołanie funkcji unsubscribe, zebrane dane o krokach nie będą dostępne.

Typy danych

Interfejs Logging API na urządzeniach mobilnych może rejestrować te typy danych:

Rozpocznij

Aby rozpocząć, dodaj tę zależność do pliku build.gradle:

Kotlin DSL

plugin {
  id("com.android.application")
}

...

dependencies {
  implementation("com.google.android.gms:play-services-fitness:21.2.0")
}

Świetny DSL

apply plugin: 'com.android.application'

...

dependencies {
  implementation 'com.google.android.gms:play-services-fitness:21.2.0'
}

Poproś o uprawnienia

Aby nagrywać dane za pomocą interfejsu Logging API na urządzeniu mobilnym, Twoja aplikacja będzie musiała poprosić o te uprawnienia:

  • android.permission.ACTIVITY_RECOGNITION

Subskrybuj dane z aplikacji Fitness

Aby poprosić o gromadzenie w tle danych o krokach, dystansie lub kaloriach, użyj metody subscribe, jak pokazano w tym fragmencie kodu:

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)
  }

Odczytywanie i przetwarzanie danych z aplikacji Fitness

Po dokonaniu subskrypcji poproś o dane za pomocą metody readData. Następnie możesz uzyskać punkty DataPoints z wynikowego zbioru DataSet, tworząc żądanie DataReadRequest jak w tym fragmencie kodu:

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 stale aktualizuje zbiór danych. W każdej chwili możesz użyć metody readData, aby pobrać najnowsze dane.

Pamiętaj, że LocalRecordingClient przechowuje dane do 10 dni. Aby zmniejszyć ryzyko utraty danych, możesz za pomocą WorkManagera okresowo gromadzić dane w tle.

Anulowanie subskrypcji danych o aktywności fizycznej

Aby zwolnić zasoby, anuluj subskrypcję zbierania danych z czujników, gdy aplikacja nie będzie już ich potrzebować. Aby anulować subskrypcję, użyj metody 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)
  }