العمل على البيانات السابقة

تسمح واجهة برمجة التطبيقات History API بإجراء عمليات مجمّعة في متجر اللياقة البدنية: قراءة بيانات الصحة والعافية السابقة وإدراجها وتحديثها وحذفها. يمكنك استخدام History API لتنفيذ ما يلي:

  • قراءة بيانات الصحة والعافية التي تم إدراجها أو تسجيلها باستخدام تطبيقات أخرى.
  • استيراد البيانات المجمعة إلى Google Fit.
  • تعديل البيانات في Google Fit.
  • حذف البيانات السابقة التي خزَّنها تطبيقك في السابق

لإدراج البيانات التي تحتوي على البيانات الوصفية للجلسة، استخدِم Session API.

قراءة البيانات

تتناول الأقسام التالية كيفية قراءة أنواع مختلفة من البيانات المجمّعة.

قراءة بيانات تفصيلية ومجمّعة

لقراءة البيانات السابقة، أنشِئ DataReadRequest نسخة افتراضية.

Kotlin

// 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()

Java

// 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();

يستخدم المثال السابق نقاط البيانات المجمّعة، حيث يمثل كل DataPoint عدد الخطوات التي تم قطعها في اليوم. بالنسبة لحالة الاستخدام المحددة هذه، لنقاط البيانات المجمعة ميزتين:

  • يتبادل تطبيقك ومتجر اللياقة البدنية كميات أصغر من البيانات.
  • لا يحتاج تطبيقك إلى تجميع البيانات يدويًا.

تجميع البيانات لأنواع أنشطة متعددة

يمكن لتطبيقك استخدام طلبات البيانات لاسترداد العديد من أنواع البيانات المختلفة. يوضح المثال التالي كيفية إنشاء DataReadRequest لحرق السعرات الحرارية لكل نشاط يتم تنفيذه خلال النطاق الزمني المحدد. تتطابق البيانات الناتجة مع السعرات الحرارية لكل نشاط كما هو موضح في تطبيق Google Fit، حيث يحصل كل نشاط على مجموعته الخاصة من بيانات السعرات الحرارية.

Kotlin

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

Java

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

بعد إنشاء مثيل DataReadRequest، استخدِم طريقة HistoryClient.readData() لقراءة البيانات السابقة بشكل غير متزامن.

يوضّح المثال التالي كيفية الحصول على مثيلات DataPoint من DataSet:

Kotlin

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

Java

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

قراءة إجمالي البيانات اليومية

يتيح Google Fit أيضًا إمكانية الوصول بسهولة إلى الإجمالي اليومي لنوع معيّن من البيانات. استخدِم الطريقة HistoryClient.readDailyTotal() لاسترداد نوع البيانات الذي تحدّده اعتبارًا من منتصف الليل لليوم الحالي في المنطقة الزمنية الحالية للجهاز. على سبيل المثال، أدخِل نوع بيانات TYPE_STEP_COUNT_DELTA بهذه الطريقة لاسترداد الإجمالي اليومي للخطوات. يمكنك تمرير نوع بيانات لحظي يحتوي على إجمالي يومي مجمّع. لمزيد من المعلومات عن أنواع البيانات المتوافقة، يُرجى الاطّلاع على المقالة DataType.getAggregateType.

لا يتطلب Google Fit الحصول على إذن للاشتراك في تحديثات TYPE_STEP_COUNT_DELTA من طريقة HistoryClient.readDailyTotal() عند طلب هذه الطريقة باستخدام الحساب التلقائي وعدم تحديد نطاقات. يُعدّ ذلك مفيدًا إذا كنت تحتاج إلى استخدام بيانات الخطوات في الأماكن التي لا يمكنك فيها عرض لوحة الأذونات، على سبيل المثال خلفيات شاشة ساعة Wear OS.

يفضّل المستخدمون رؤية عدد خطوات متّسق في تطبيق Google Fit والتطبيقات الأخرى وخلفيات شاشة الساعة التي تعمل بنظام التشغيل Wear OS، لأنّ ذلك يوفّر لهم تجربة متّسقة وموثوقة. للحفاظ على اتساق عدد الخطوات، يمكنك الاشتراك في عدد الخطوات على منصة Google Fit من التطبيق أو خلفية شاشة الساعة، ثم تعديل عدد الخطوات في onExitAmbient(). للمزيد من المعلومات حول طريقة استخدام هذه البيانات في خلفية شاشة الساعة، يمكنك الاطّلاع على إضافات خلفية شاشة الساعة ونموذج تطبيق Android WatchFace.

إدخال البيانات

لإدراج البيانات السابقة، عليك أولاً إنشاء DataSetمثيل:

Kotlin

// 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()

Java

// 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();

بعد إنشاء مثيل DataSet، استخدِم طريقة HistoryClient.insertData لإضافة هذه البيانات السابقة بشكل غير متزامن.

Kotlin

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

Java

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

إدارة نقاط البيانات المتعارضة

يجب أن يحتوي كل DataPoint في DataSet لتطبيقك على startTime وendTime يحدّد فاصلاً فريدًا خلال DataSet، بدون تداخل بين مثيلات DataPoint.

إذا حاول تطبيقك إدراج DataPoint جديد تتعارض مع مثيل DataPoint الحالي، سيتم تجاهل DataPoint الجديد. لإدراج سمة DataPoint جديدة قد تتداخل مع نقاط البيانات الحالية، استخدِم طريقة HistoryClient.updateData الموضّحة في مقالة تعديل البيانات.

لا يمكن إدراج نقطة بيانات إذا تداخلت مدتها مع أي نقاط بيانات حالية

الشكل 1. كيفية تعامل الطريقة insertData() مع نقاط البيانات الجديدة التي تتعارض مع DataPoint الحالية

تعديل البيانات

يتيح Google Fit لتطبيقك تعديل بيانات الصحة والعافية السابقة التي كان يدرجها في السابق. لإضافة بيانات سابقة في DataSet جديد، أو لإضافة مثيلات DataPoint جديدة لا تتعارض مع نقاط البيانات الحالية، استخدِم طريقة HistoryApi.insertData.

لتعديل البيانات السابقة، استخدِم طريقة HistoryClient.updateData. تحذف هذه الطريقة أي مثيلات DataPoint حالية تتداخل مع مثيلات DataPoint التي تمّت إضافتها باستخدام هذه الطريقة.

لتعديل بيانات الصحة والعافية السابقة، عليك أولاً إنشاء مثيل "DataSet":

Kotlin

// 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()

Java

// 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();

بعد ذلك، استخدِم DataUpdateRequest.Builder() لإنشاء طلب جديد لتعديل البيانات، واستخدِم طريقة HistoryClient.updateData لتقديم الطلب:

Kotlin

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

Java

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

حذف البيانات

يتيح Google Fit لتطبيقك حذف بيانات الصحة والعافية السابقة التي كان يدرجها في السابق.

لحذف البيانات السابقة، استخدِم طريقة HistoryClient.deleteData:

Kotlin

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

Java

// 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));

يمكن للتطبيقات حذف البيانات من جلسات معيّنة أو حذف جميع البيانات. للمزيد من المعلومات، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات الخاص بـ DataDeleteRequest.

التسجيل للحصول على تحديثات البيانات

يمكن لتطبيقك قراءة بيانات أجهزة الاستشعار الأولية في الوقت الفعلي من خلال التسجيل باستخدام SensorsClient.

وبالنسبة إلى أنواع البيانات الأخرى الأقل تكرارًا والتي يتم احتسابها يدويًا، يمكن للتطبيق التسجيل لتلقّي التحديثات عند إدراج هذه القياسات في قاعدة بيانات Google Fit. تتضمن أمثلة أنواع البيانات هذه الطول والوزن والتمارين مثل رفع الأثقال. لمزيد من التفاصيل، اطّلع على القائمة الكاملة لأنواع البيانات المتوافقة. للتسجيل في التحديثات، استخدِم HistoryClient.registerDataUpdateListener.

يتيح مقتطف الرمز التالي إعلام التطبيق عندما يُدخِل المستخدم قيمة جديدة لوزنه:

Kotlin

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

Java

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" لتلقّي إشعارات بالتحديثات:

Kotlin

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

Java

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

يجب الإشارة إلى IntentService في ملف AndroidManifest.xml.