Logging API na urządzeniach mobilnych

Interfejs Notification API na urządzeniach mobilnych umożliwia aplikacji rejestrowanie kroków z urządzenia mobilnego, bez wykorzystania baterii. Ten interfejs API jest nierozliczany, co oznacza, że do korzystania z usługi nie jest wymagane konto Google, a dane są przechowywane na urządzeniu.

Z tego przewodnika dowiesz się, jak korzystać z interfejsu Record API na urządzeniach mobilnych, aby zadbać o zdrowie i dobrą formę.

Ważne informacje

Jest kilka ważnych funkcji, które są dostępne tylko w Recording API na urządzeniach mobilnych:

  • Po rozpoczęciu lub odnowieniu subskrypcji nagrania dostępne są dane od ostatniego czasu subskrypcji (do 10 dni).
  • Dane są dostępne tylko wtedy, gdy istnieje aktywna subskrypcja. Jeśli subskrypcja zostanie usunięta przez wywołanie metody 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 w pliku build.gradle tę zależność:

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 rejestrować dane za pomocą interfejsu Record API na urządzeniu mobilnym, aplikacja musi poprosić o to uprawnienie:

  • android.permission.ACTIVITY_RECOGNITION

Sprawdzanie wersji Usług Google Play

Aby można było korzystać z interfejsu Record API na urządzeniach mobilnych, użytkownik musi zaktualizować Usługi Google Play do wersji LOCAL_RECORDING_CLIENT_MIN_VERSION_CODE. Możesz to sprawdzić, korzystając z metody 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

W przeciwnym razie, jeśli wersja Usług Google Play użytkownika jest za stara, system zgłasza wyjątek ConnectionResult.SERVICE_VERSION_UPDATE_REQUIRED.

Subskrybuj dane z aplikacji Fitness

Aby w tle zbierać dane 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(LocalDataType.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 zasubskrybowaniu poproś o dane za pomocą metody readData. Następnie możesz uzyskać punkty LocalDataPoint z wynikowego LocalDataSet, tworząc LocalDataReadRequest, jak w tym fragmencie kodu:

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 stale aktualizuje swoje zbieranie danych. Najnowsze dane możesz w każdej chwili pobrać za pomocą funkcji readData.

Pamiętaj, że LocalRecordingClient przechowuje dane z maksymalnie 10 dni. Aby zmniejszyć ryzyko utraty danych, możesz używać WorkManagera do okresowego zbierania ich w tle.

Anuluj subskrypcję danych o aktywności fizycznej

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