Health Platform API

Health Platform API 是一個 Android API,可讓開發人員 讀取、寫入及分享使用者的歷來健康、保健資料 與健身資料使用者可以透過 Health Platform 控管自己的資料,位使用者 控管各應用程式對於不同類型資料的讀取或寫入權限。醫療保健 平台 API 資料類型包括身高、心率等。

Health Platform API 為使用者提供儲存與共用機制, 他們會選擇可以存取及顯示個人健康、健身、 和保健資料如此一來,應用程式開發人員就能更完整地向使用者顯示 使用者清單健康狀態,並讓使用者更有效地監控資料。

Health Platform API 軟體開發人員套件為 Android 應用程式開發人員提供 提供存取使用者的健康與保健資料所需的一切 且可在 Samsung 裝置上執行大量操作 例如插入、刪除及讀取資料

開始使用

使用 Health Platform 時,請留意下列事項:

  • 用戶端應用程式必須向使用者取得適當的讀取或寫入權限。
  • 使用者隨時可以拒絕授予權限或撤銷權限。
  • Health Platform API 僅支援特定 Samsung 裝置。
  • HealthDataClient 是 Health Platform 的用戶端,也是 Health Platform 的進入點。

下圖顯示開發人員必須採取的整合步驟:

整合步驟

版本檔案

Health Platform 第 1 版包含下列內容:

  • 用戶端 SDK: 只要在應用程式中加入這個 SDK,即可使用 Health Platform API。SDK 是一個 Maven 存放區,您可以直接納入 應用程式 Gradle 建構檔案。

安裝 Health Platform

如要安裝 Health Platform,請按照下列步驟進行:

在應用程式的根層級 build.gradle 檔案中新增存放區,如下所示 範例:

allprojects {
    ...
    repositories {
        ...
        google()
    }
}

在模組的 build.gradle 中,新增 Health Platform SDK 的依附元件 檔案,如以下範例所示:

dependencies {
   …
  implementation 'com.google.android.libraries.healthdata:health-data-api:1.0.0-alpha01'
}

資料

Health Platform 會儲存及建構健康與健身的相關資料。該模式也會考量 不同類型資料測量方式之間的核心差異。舉例來說 心率測量會立即發生,但步數會在 範圍。

以下將介紹 Health Platform 的中央物件及其差異:

  • RawData測量資料和資料記錄。
  • DataType常見健康與健身資料類型的說明器, 例如心率、體脂肪或體溫,以及其格式,例如 欄位、唯讀或選用欄位
  • SampleData為即時測量的 RawData 物件,例如 例如心率、血壓或跑步速度
  • IntervalDataRawData 物件,為累計測量值 一段時間內,例如行走的步數、移動的距離或 卡路里燃燒量。
  • SeriesDataRawData 物件,用於封裝一系列 以及長期的測量指標SeriesData特別適合用於 高頻率感測器資料,例如運動期間的連續心率樣本 活動時段

三個 RawData 類別都會分別對應 DataTypeSampleDataIntervalDataSeriesData 會對應 SampleDataTypeIntervalDataTypeSeriesDataType

每個 RawData 物件都會由 Health 指派一個專屬 ID (UID) 插入的平台。您可以使用這個 UID 參照特定的 RawData 讀取、更新或刪除要求的物件

資料類型

Health Platform 包含多種常見的資料類型 健康與健身 App。以可用資料類型儲存的資料能讓使用者 全面掌握各自的健康、健身和保健記錄 深入分析他們自己的日常活動。

每個資料類型都是以資料格式定義,其中包含下列內容:

  • 欄位:與資料類型相關的特定或一般欄位。適用對象 例如,血氧飽和度 (SpO2) 資料類型具有「標題」等欄位, 附註和百分比。
  • 類型:Long (長整數)、Double (雙倍精度浮點數)、String (字串) 或 Enum (列舉)。
  • 屬性:唯讀、必要、選用或驗證範圍。

資料類型清單

瞭解可用資料類型,充分運用 Health Platform。 Health Platform 支援下表顯示的資料類型。 資料類型會按照格式 (樣本、間隔或 這是 Gemini 版 Google Workspace 系列課程之一

SampleData 類型:

DataType.BasalMetabolicRateDataType BASAL_METABOLIC_RATE 必填
DataType.BloodGlucoseDataType BLOOD_GLUCOSE 必要和選用
DataType.BloodPressureDataType BLOOD_PRESSURE 必要和選用
DataType.BodyFatDataType BODY_FAT 必填
DataType.BodyTemperatureDataType BODY_TEMPERATURE 必要和選用
DataType.BoneMassDataType BONE_MASS 必填
DataType.CervicalMucusDataType CERVICAL_MUCUS 選擇性
DataType.CervicalPositionDataType CERVICAL_POSITION 選用
DataType.CyclingPedalingCadenceDataType CYCLING_PEDALING_CADENCE 必填
DataType.DateOfBirthDataType DATE_OF_BIRTH 唯讀
DataType.GenderDataType GENDER 唯讀
DataType.HeartRateDataType HEART_RATE 必填
DataType.HeightDataType HEIGHT 必填
DataType.HipCircumferenceDataType HIP_CIRCUMFERENCE 必填
DataType.HrvDifferentialIndexDataType HRV_DIFFERENTIAL_INDEX 必填
DataType.HrvRmssdDataType HRV_RMSSD 必填
DataType.HrvSDataType HRV_S 必填
DataType.HrvSd2DataType HRV_SD2 必填
DataType.HrvSdannDataType HRV_SDANN 必填
DataType.HrvSdnnDataType HRV_SDNN 必填
DataType.HrvSdnnIndexDataType HRV_SDNN_INDEX 必填
DataType.HrvSdnnIndexDataType HRV_SDNN_INDEX 必填
DataType.HrvSdsdDataType HRV_SDSD 必填
DataType.HrvTinnDataType HRV_TINN 必填
DataType.LeanBodyMassDataType LEAN_BODY_MASS 必填
DataType.LocationDataType LOCATION 必填
DataType.MenstruationDataType MENSTRUATION 選用
DataType.OvulationTestDataType OVULATION_TEST 必填
DataType.OxygenSaturationDataType OXYGEN_SATURATION 必填
DataType.PaceDataType PACE 必填
DataType.PowerDataType POWER 必填
DataType.RespiratoryRateDataType RESPIRATORY_RATE 必填
DataType.RestingHeartRateDataType RESTING_HEART_RATE 必填
DataType.SexualActivityDataType SEXUAL_ACTIVITY 必填
DataType.SpeedDataType SPEED 必填
DataType.StepsCadenceDataType STEPS_CADENCE 必填
DataType.Vo2MaxDataType VO2_MAX 必要和選用
DataType.WaistCircumferenceDataType WAIST_CIRCUMFERENCE 必填
DataType.WeightDataType WEIGHT 必填

IntervalData 類型:

DataType.ActiveEnergyDataType ACTIVE_ENERGY_BURNED 必填
DataType.ActiveTimeDataType ACTIVE_TIME 唯讀
DataType.ActivityEventDataType ACTIVITY_EVENT 必填
DataType.ActivityLapDataType ACTIVITY_LAP 選用
DataType.ActivitySessionDataType ACTIVITY_SESSION 必填
DataType.BasalEnergyDataType BASAL_ENERGY_BURNED 唯讀
DataType.DistanceDataType DISTANCE 必填
DataType.ElevationGainedDataType ELEVATION_GAINED 必填
DataType.FloorsClimbedDataType FLOORS_CLIMBED 必填
DataType.HydrationDataType HYDRATION 必填
DataType.NutritionDataType NUTRITION 選用
DataType.RepetitionsDataType REPETITIONS 必填
DataType.SleepSessionDataType SLEEP_SESSION 選用
DataType.SleepStageDataType SLEEP_STAGE 必填
DataType.StepsDataType STEPS 必填
DataType.SwimmingStrokesDataType SWIMMING_STROKES 必要和選用
DataType.TotalEnergyDataType TOTAL_ENERGY_BURNED 唯讀

SeriesData 類型:

DataType.CyclingPedalingCadenceSeriesDataType CYCLING_PEDALING_CADENCE 必填
DataType.HeartRateSeriesDataType HEART_RATE 必填
DataType.LocationSeriesDataType LOCATION 必填
DataType.PaceSeriesDataType PACE 必填
DataType.PowerSeriesDataType POWER 必填
DataType.SpeedSeriesDataType SPEED 必填
DataType.StepsCadenceSeriesDataType STEPS_CADENCE 必填

開發人員函式

以下說明標準資料函式集 Health Platform。這個平台提供標準插入、更新和刪除功能 原始資料函式

讀取 AggregatedData

平台可讓用戶端針對下列類型的 AggregatedData:

  • StatisticalData平均值、最小值或最大值 設定 SampleDataSeriesData,例如最小和最大愛心 每次活動時段的比率
  • CumulativeDataIntervalData 值的加總,例如 每日間隔的總步數。
  • CountData提供基礎 RawData 數量的簡單計數 ,例如某一週的活動時段數。計算資料 可針對樣本、間隔和系列資料類型進行計算。

連線至 Health Platform API

HealthDataClient 是 Health Platform API 的進入點。

下列步驟說明如何連線至 Health Platform:

  1. 使用 HealthDataService.getClient 建立新的 HealthDataClient 執行個體。
  2. 接著,用戶端應用程式必須使用 requestPermissions (Set) 方法。
,瞭解如何調查及移除這項存取權。

HealthDataClient 會自動管理自身與基礎之間的連線 儲存空間層,並處理傳出要求的所有處理序間通訊 (IPC) 和序列化作業 。