Praca z danymi historycznymi

History API umożliwia Twojej aplikacji wykonywanie operacji zbiorczych na koncie w usłudze śledzenia kondycji: odczytywanie, wstawianie, aktualizowanie i usuwanie historycznych danych o zdrowiu i samopoczuciu. Za pomocą interfejsu History API możesz:

• Odczytywanie danych o zdrowiu i samopoczuciu wstawionych lub zapisanych za pomocą innych metod aplikacji.
• Importowanie danych zbiorczych do Google Fit.
• Aktualizowanie danych w Google Fit.
• Usuwanie danych historycznych zapisanych wcześniej przez aplikację.

Aby wstawić dane zawierające metadane sesji, użyj interfejsu Sessions API.

Odczytywanie danych

W sekcjach poniżej dowiesz się, jak odczytywać różne rodzaje danych zbiorczych.

Odczytywanie danych szczegółowych i zbiorczych

Aby odczytywać dane historyczne, utwórz instancję DataReadRequest.

// Read the data that's been collected throughout the past week.
val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusWeeks(1)
Log.i(TAG, "Range Start: $startTime")
Log.i(TAG, "Range End: $endTime")

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 for a time span, whereas bucketBySession allows
        // bucketing by <a href="/fit/android/using-sessions">sessions</a>.
        .bucketByTime(1, TimeUnit.DAYS)
        .setTimeRange(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .build()

// Read the data that's been collected throughout the past week.
ZonedDateTime endTime = LocalDateTime.now().atZone(ZoneId.systemDefault());
ZonedDateTime startTime = endTime.minusWeeks(1);
Log.i(TAG, "Range Start: $startTime");
Log.i(TAG, "Range End: $endTime");

DataReadRequest readRequest = new 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 for a time span, while bucketBySession allows
        // bucketing by sessions.
        .bucketByTime(1, TimeUnit.DAYS)
        .setTimeRange(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .build();

W poprzednim przykładzie wykorzystywano zagregowane punkty danych, w których każdy element DataPoint reprezentuje liczbę kroków przebytych w ciągu dnia. W tym konkretnym przypadku użycia punkty danych zbiorczych mają 2 zalety:

• Aplikacja i sklep fitness wymieniają mniejsze ilości danych.
• Aplikacja nie musi ręcznie agregować danych.

Dane zbiorcze dotyczące wielu typów aktywności

Aplikacja może używać żądań danych do pobierania różnych typów danych. Ten przykład pokazuje, jak utworzyć DataReadRequest, aby uzyskać spalone kalorie podczas każdej aktywności w określonym przedziale czasu. Otrzymane dane odpowiadają kaloriom na aktywność, w raportach w aplikacji Google Fit, gdzie każda aktywność jest przypisywana do osobnego segmentu. danych dotyczących kalorii.

val readRequest = DataReadRequest.Builder()
    .aggregate(DataType.AGGREGATE_CALORIES_EXPENDED)
    .bucketByActivityType(1, TimeUnit.SECONDS)
    .setTimeRange(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
    .build()

DataReadRequest readRequest = new DataReadRequest.Builder()
        .aggregate(DataType.AGGREGATE_CALORIES_EXPENDED)
        .bucketByActivityType(1, TimeUnit.SECONDS)
        .setTimeRange(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .build();

Po utworzeniu instancji DataReadRequest użyj metody HistoryClient.readData() do asynchronicznego odczytu danych historycznych.

Ten przykład pokazuje, jak uzyskać instancje DataPoint z DataSet:

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
    .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 from Google Fit", 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)}")
        }
    }
}

fun DataPoint.getStartTimeString() = Instant.ofEpochSecond(this.getStartTime(TimeUnit.SECONDS))
    .atZone(ZoneId.systemDefault())
    .toLocalDateTime().toString()

fun DataPoint.getEndTimeString() = Instant.ofEpochSecond(this.getEndTime(TimeUnit.SECONDS))
    .atZone(ZoneId.systemDefault())
    .toLocalDateTime().toString()

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
        .readData(readRequest)
        .addOnSuccessListener (response -> {
            // The aggregate query puts datasets into buckets, so convert to a
            // single list of datasets
            for (Bucket bucket : response.getBuckets()) {
                for (DataSet dataSet : bucket.getDataSets()) {
                    dumpDataSet(dataSet);
                }
            }
        })
        .addOnFailureListener(e ->
            Log.w(TAG, "There was an error reading data from Google Fit", e));

}

private void dumpDataSet(DataSet dataSet) {
    Log.i(TAG, "Data returned for Data type: ${dataSet.dataType.name}");
    for (DataPoint dp : dataSet.getDataPoints()) {
        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 field : dp.getDataType().getFields()) {
            Log.i(TAG,"\tField: ${field.name.toString()} Value: ${dp.getValue(field)}");
        }
    }
}


private String getStartTimeString() {
    return Instant.ofEpochSecond(this.getStartTime(TimeUnit.SECONDS))
        .atZone(ZoneId.systemDefault())
        .toLocalDateTime().toString();
}

private String getEndTimeString() {
    return Instant.ofEpochSecond(this.getEndTime(TimeUnit.SECONDS))
            .atZone(ZoneId.systemDefault())
            .toLocalDateTime().toString();
}

Odczytywanie danych dziennych

Google Fit zapewnia też prosty dostęp do dziennej łącznej określonego typu danych. Użyj metody HistoryClient.readDailyTotal(), aby pobrać określony typ danych o godzinie północy bieżącego dnia w bieżącej strefie czasowej urządzenia. Aby pobrać dzienną łączną liczbę kroków, prześlij do tej metody typ danych TYPE_STEP_COUNT_DELTA. Możesz przekazywać natychmiastowy typ danych, który zawiera zbiorcze dzienne dane Łącznie. Więcej informacji na temat obsługiwanych typów danych znajdziesz w artykule DataType.getAggregateType

Subskrybowanie Google Fit nie wymaga autoryzacji Aktualizacje aplikacji HistoryClient.readDailyTotal() (TYPE_STEP_COUNT_DELTA) w przypadku, gdy ta metoda jest wywoływana z użyciem konta domyślnego, a nie i zakresy. Może to być przydatne, jeśli potrzebujesz danych o krokach do użytku na obszarach, na których nie możesz aby wyświetlić panel uprawnień, na przykład na tarczach zegarka z Wear OS.

Użytkownicy wolą, aby liczba kroków była taka sama w aplikacji Google Fit, innych aplikacjach i tarczkach zegarka na Wear OS, ponieważ zapewnia to spójne i niezawodne działanie. Aby liczba kroków była spójna, zasubskrybuj: kroki na platformie Google Fit w aplikacji lub na tarczy zegarka, Zaktualizuj licznik w onExitAmbient() Więcej informacji o używaniu tych danych na tarczy zegarka znajdziesz w artykule Widżety na tarczy zegarka i w próbnej aplikacji Android WatchFace.

Wstaw dane

Aby wstawić dane historyczne, najpierw utwórz DataSetinstancję:

// Declare that the data being inserted was collected during the past hour.
val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusHours(1)

// Create a data source
val dataSource = DataSource.Builder()
    .setAppPackageName(this)
    .setDataType(DataType.TYPE_STEP_COUNT_DELTA)
    .setStreamName("$TAG - step count")
    .setType(DataSource.TYPE_RAW)
    .build()

// For each data point, specify a start time, end time, and the
// data value -- in this case, 950 new steps.
val stepCountDelta = 950
val dataPoint =
    DataPoint.builder(dataSource)
        .setField(Field.FIELD_STEPS, stepCountDelta)
        .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .build()

val dataSet = DataSet.builder(dataSource)
    .add(dataPoint)
    .build()

// Declare that the data being inserted was collected during the past hour.
ZonedDateTime endTime = LocalDateTime.now().atZone(ZoneId.systemDefault());
ZonedDateTime startTime = endTime.minusHours(1);

// Create a data source
DataSource dataSource = new DataSource.Builder()
        .setAppPackageName(this)
        .setDataType(DataType.TYPE_STEP_COUNT_DELTA)
        .setStreamName("$TAG - step count")
        .setType(DataSource.TYPE_RAW)
        .build();

// For each data point, specify a start time, end time, and the
// data value -- in this case, 950 new steps.
int stepCountDelta = 950;
DataPoint dataPoint = DataPoint.builder(dataSource)
        .setField(Field.FIELD_STEPS, stepCountDelta)
        .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .build();

DataSet dataSet = DataSet.builder(dataSource)
        .add(dataPoint)
        .build();

Po utworzeniu instancji DataSet skorzystaj z metody HistoryClient.insertData , aby asynchronicznie dodawać te dane historyczne.

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
    .insertData(dataSet)
    .addOnSuccessListener {
        Log.i(TAG, "DataSet added successfully!")
    }
    .addOnFailureListener { e ->
        Log.w(TAG, "There was an error adding the DataSet", e)
    }

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
        .insertData(dataSet)
        .addOnSuccessListener (unused ->
                Log.i(TAG, "DataSet added successfully!"))
        .addOnFailureListener(e ->
                Log.w(TAG, "There was an error adding the DataSet", e));
}

Zarządzanie punktami danych o sprzecznych wartościach

Każdy element DataSet w Twojej aplikacji musi mieć element startTime i element endTime, który definiuje unikalny przedział w tym DataSet, bez nakładania się wystąpień DataPoint.

Jeśli aplikacja próbuje wstawić nowy DataPoint, który koliduje z dotychczasowym DataPoint, nowa instancja DataPoint została odrzucona. Aby wstawić nowy DataPoint, które mogą pokrywać się z istniejącymi punktami danych, użyj HistoryClient.updateData opisana w artykule Aktualizowanie danych.

Rysunek 1. Jak metoda insertData() obsługuje nowe punkty danych, które koliduje z istniejącym elementem DataPoint.

Zaktualizuj dane

Dzięki Google Fit aplikacja może aktualizować historyczne dane o zdrowiu i samopoczuciu, wcześniej wstawione. Aby dodać dane historyczne dla nowego DataSet lub dodać nowe wystąpienia DataPoint, które nie konfliktują z dotychczasowymi punktami danych, użyj metody HistoryApi.insertData.

Aby zaktualizować dane historyczne, użyj metody HistoryClient.updateData. Ta metoda usuwa wszystkie istniejące instancje DataPoint, które pokrywają się z instancjami DataPoint dodanymi za pomocą tej metody.

Aby zaktualizować historyczne dane o zdrowiu i samopoczuciu, najpierw utwórz DataSet instancja:

// Declare that the historical data was collected during the past 50 minutes.
val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusMinutes(50)

// Create a data source
val dataSource  = DataSource.Builder()
    .setAppPackageName(this)
    .setDataType(DataType.TYPE_STEP_COUNT_DELTA)
    .setStreamName("$TAG - step count")
    .setType(DataSource.TYPE_RAW)
    .build()

// Create a data set
// For each data point, specify a start time, end time, and the
// data value -- in this case, 1000 new steps.
val stepCountDelta = 1000

val dataPoint = DataPoint.builder(dataSource)
    .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
    .setField(Field.FIELD_STEPS, stepCountDelta)
    .build()

val dataSet = DataSet.builder(dataSource)
    .add(dataPoint)
    .build()

// Declare that the historical data was collected during the past 50 minutes.
ZonedDateTime endTime = LocalDateTime.now().atZone(ZoneId.systemDefault());
ZonedDateTime startTime = endTime.minusMinutes(50);

// Create a data source
DataSource dataSource = new DataSource.Builder()
        .setAppPackageName(this)
        .setDataType(DataType.TYPE_STEP_COUNT_DELTA)
        .setStreamName("$TAG - step count")
        .setType(DataSource.TYPE_RAW)
        .build();

// Create a data set
// For each data point, specify a start time, end time, and the
// data value -- in this case, 1000 new steps.
int stepCountDelta = 1000;

DataPoint dataPoint = DataPoint.builder(dataSource)
        .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .setField(Field.FIELD_STEPS, stepCountDelta)
        .build();

DataSet dataSet = DataSet.builder(dataSource)
        .add(dataPoint)
        .build();

Następnie użyj elementu DataUpdateRequest.Builder(), aby utworzyć nową prośbę o aktualizację danych, i użyj metody HistoryClient.updateData, aby wysłać prośbę:

val request = DataUpdateRequest.Builder()
    .setDataSet(dataSet)
    .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
    .build()

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
    .updateData(request)
    .addOnSuccessListener {
        Log.i(TAG, "DataSet updated successfully!")
    }
    .addOnFailureListener { e ->
        Log.w(TAG, "There was an error updating the DataSet", e)
    }

DataUpdateRequest request = new DataUpdateRequest.Builder()
        .setDataSet(dataSet)
        .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .build();

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
        .updateData(request)
        .addOnSuccessListener(unused ->
                Log.i(TAG, "DataSet updated successfully!"))
        .addOnFailureListener(e ->
                Log.w(TAG, "There was an error updating the DataSet", e));

Usuń dane

Google Fit umożliwia aplikacji usuwanie historycznych danych o zdrowiu i samopoczuciu, wcześniej wstawione.

Aby usunąć dane historyczne, użyj metody HistoryClient.deleteData:

// Declare that this code deletes step count information that was collected
// throughout the past day.
val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusDays(1)

// Create a delete request object, providing a data type and a time interval
val request = DataDeleteRequest.Builder()
    .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
    .addDataType(DataType.TYPE_STEP_COUNT_DELTA)
    .build()

// Invoke the History API with the HistoryClient object and delete request, and
// then specify a callback that will check the result.
Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
    .deleteData(request)
    .addOnSuccessListener {
        Log.i(TAG, "Data deleted successfully!")
    }
    .addOnFailureListener { e ->
        Log.w(TAG, "There was an error with the deletion request", e)
    }

// Declare that this code deletes step count information that was collected
// throughout the past day.
ZonedDateTime endTime = LocalDateTime.now().atZone(ZoneId.systemDefault());
ZonedDateTime startTime = endTime.minusDays(1);

// Create a delete request object, providing a data type and a time interval
DataDeleteRequest request = new DataDeleteRequest.Builder()
        .setTimeInterval(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
        .addDataType(DataType.TYPE_STEP_COUNT_DELTA)
        .build();

// Invoke the History API with the HistoryClient object and delete request, and
// then specify a callback that will check the result.
Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
        .deleteData(request)
        .addOnSuccessListener (unused ->
                Log.i(TAG, "Data deleted successfully!"))
        .addOnFailureListener(e ->
        Log.w(TAG, "There was an error with the deletion request", e));

Aplikacje mogą usuwać dane z określonych sesji lub Usuń wszystkie dane. Więcej informacji znajdziesz w dokumentacji interfejsu API w sekcji DataDeleteRequest

Rejestracja w celu otrzymywania aktualizacji danych

Aplikacja może odczytywać nieprzetworzone dane z czujnika w czasie rzeczywistym, rejestrując się w SensorsClient.

W przypadku innych rodzajów danych, które są rzadziej liczone i są liczone ręcznie, aplikacja może się zarejestrować, aby otrzymywać aktualizacje po wstawieniu tych pomiarów w bazie danych Google Fit. Mogą to być na przykład wysokość, treningi takie jak podnoszenie ciężarów, więcej szczegółów znajdziesz na pełnej liście obsługiwanych typach danych. Aby zarejestrować się, aby otrzymywać aktualizacje, użyj HistoryClient.registerDataUpdateListener.

Ten fragment kodu pozwala aplikacji otrzymywać powiadomienia, gdy użytkownik wprowadzi nową wartość swojej wagi:

val intent = Intent(this, MyDataUpdateService::class.java)
val pendingIntent = PendingIntent.getService(this, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT)

val request = DataUpdateListenerRegistrationRequest.Builder()
    .setDataType(DataType.TYPE_WEIGHT)
    .setPendingIntent(pendingIntent)
    .build()

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
    .registerDataUpdateListener(request)
    .addOnSuccessListener {
        Log.i(TAG, "DataUpdateListener registered")
    }

Intent intent = new Intent(this, MyDataUpdateService.class);
PendingIntent pendingIntent = PendingIntent.getService(this, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT)

DataUpdateListenerRegistrationRequest request = new DataUpdateListenerRegistrationRequest.Builder()
        .setDataType(DataType.TYPE_WEIGHT)
        .setPendingIntent(pendingIntent)
        .build();

Fitness.getHistoryClient(this, GoogleSignIn.getAccountForExtension(this, fitnessOptions))
        .registerDataUpdateListener(request)
        .addOnSuccessListener(unused ->
                Log.i(TAG, "DataUpdateListener registered"));

IntentService może służyć do otrzymywania powiadomień o aktualizacjach:

class MyDataUpdateService : IntentService("MyDataUpdateService") {
    override fun onHandleIntent(intent: Intent?) {
        val update = DataUpdateNotification.getDataUpdateNotification(intent)
        // Show the time interval over which the data points were collected.
        // To extract specific data values, in this case the user's weight,
        // use DataReadRequest.
        update?.apply {
            val start = getUpdateStartTime(TimeUnit.MILLISECONDS)
            val end = getUpdateEndTime(TimeUnit.MILLISECONDS)

            Log.i(TAG, "Data Update start: $start end: $end DataType: ${dataType.name}")
        }
    }
}

public class MyDataUpdateService extends IntentService {

    public MyDataUpdateService(String name) {
        super("MyDataUpdateService");
    }

    @Override
    protected void onHandleIntent(@Nullable Intent intent) {
        if (intent != null) {
            DataUpdateNotification update = DataUpdateNotification.getDataUpdateNotification(intent);

            // Show the time interval over which the data points
            // were collected.
            // To extract specific data values, in this case the user's weight,
            // use DataReadRequest.
            if (update != null) {
                long start = update.getUpdateStartTime(TimeUnit.MILLISECONDS);
                long end = update.getUpdateEndTime(TimeUnit.MILLISECONDS);
            }

            Log.i(TAG, "Data Update start: $start end: $end DataType: ${dataType.name}");
        }
    }
}

W pliku AndroidManifest.xml musi być zadeklarowana właściwość IntentService.