Namespace Google.DevicesAndServices.Health.V4

Civil time representation similar to [google.type.DateTime][google.type.DateTime], but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries.

CivilTimeInterval

Counterpart of [google.type.Interval][google.type.Interval], but using [CivilDateTime][google.devicesandservices.health.v4.CivilDateTime].

CoreBodyTemperature

Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs.

CoreBodyTemperature.Types

Container for nested types declared in the CoreBodyTemperature message type.

CoreBodyTemperatureRollupValue

Represents the result of the rollup of the core body temperature data type.

CreateDataPointOperationMetadata

Metadata for a create data point operation.

CreateDataPointRequest

Request to create an identifiable data point.

CreateSubscriberMetadata

Represents metadata for creating a subscriber.

CreateSubscriberPayload

Payload for creating a subscriber.

CreateSubscriberRequest

-- Messages -- Request message for CreateSubscriber.

CreateSubscriptionPayload

Payload for creating a subscription.

CreateSubscriptionRequest

Request message for CreateSubscription.

DailyHeartRateVariability

Represents the daily heart rate variability data type.

At least one of the following fields must be set:

average_heart_rate_variability_milliseconds
non_rem_heart_rate_beats_per_minute
entropy
deep_sleep_root_mean_square_of_successive_differences_milliseconds

DailyHeartRateZones

User's heart rate zone thresholds based on the Karvonen algorithm for a specific day.

DailyHeartRateZones.Types

Container for nested types declared in the DailyHeartRateZones message type.

DailyHeartRateZones.Types.HeartRateZone

The heart rate zone.

DailyOxygenSaturation

A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep.

DailyRespiratoryRate

A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep.

DailyRestingHeartRate

Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements.

DailyRestingHeartRate.Types

Container for nested types declared in the DailyRestingHeartRate message type.

DailyRestingHeartRate.Types.DailyRestingHeartRateMetadata

Metadata for the daily resting heart rate.

DailyRestingHeartRate.Types.DailyRestingHeartRateMetadata.Types

Container for nested types declared in the DailyRestingHeartRateMetadata message type.

DailyRollUpDataPointsRequest

Request to roll up data points by civil time intervals.

DailyRollUpDataPointsResponse

Response containing the list of rolled up data points.

DailyRollupDataPoint

Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.

DailySleepTemperatureDerivations

Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep.

DailyVO2Max

Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise.

DailyVO2Max.Types

Container for nested types declared in the DailyVO2Max message type.

DataPoint

A computed or recorded metric.

DataPointName

Resource name for the DataPoint resource.

DataPointsService

Data Points Service exposing the user's health and fitness measured and derived data.

DataPointsService.DataPointsServiceBase

Base class for server-side implementations of DataPointsService

DataPointsService.DataPointsServiceClient

Client for DataPointsService

DataPointsServiceClient

DataPointsService client wrapper, for convenient use.

DataPointsServiceClientBuilder

Builder class for DataPointsServiceClient to provide simple configuration of credentials, endpoint etc.

DataPointsServiceClientImpl

DataPointsService client wrapper implementation, for convenient use.

DataPointsServiceSettings

Settings for DataPointsServiceClient instances.

DataSource

Data Source definition to track the origin of data.

Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it).

DataSource.Types

Container for nested types declared in the DataSource message type.

DataSource.Types.Application

Optional metadata for the application that provided this data.

DataSource.Types.Device

Captures metadata about the device that recorded the measurement.

DataSource.Types.Device.Types

Container for nested types declared in the Device message type.

DataSubscriptionService

Data Subscription Service that allows clients (e.g., Fitbit 3P applications, internal Fitbit Services) to manage their subscriber endpoints. This service provides CRUD APIs for subscribers, and also offers functionalities for subscriber verification and statistics.

DataSubscriptionService.DataSubscriptionServiceBase

Base class for server-side implementations of DataSubscriptionService

DataSubscriptionService.DataSubscriptionServiceClient

Client for DataSubscriptionService

DataSubscriptionServiceClient

DataSubscriptionService client wrapper, for convenient use.

DataSubscriptionServiceClientBuilder

Builder class for DataSubscriptionServiceClient to provide simple configuration of credentials, endpoint etc.

DataSubscriptionServiceClientImpl

DataSubscriptionService client wrapper implementation, for convenient use.

DataSubscriptionServiceSettings

Settings for DataSubscriptionServiceClient instances.

DataType

Represents a type of health data a user can have data points recorded for. It matches the parent resource of collection containing data points of the given type.

Clients currently do not need to interact with this resource directly.

DataTypeName

Resource name for the DataType resource.

DeleteSubscriberMetadata

Represents metadata for deleting a subscriber.

DeleteSubscriberRequest

Request message for DeleteSubscriber.

DeleteSubscriptionRequest

Request message for DeleteSubscription.

Distance

Distance traveled over an interval of time.

DistanceRollupValue

Result of the rollup of the user's distance.

Electrocardiogram

Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review.

Electrocardiogram.Types

Container for nested types declared in the Electrocardiogram message type.

EndpointAuthorization

Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the X-HEALTHAPI-SIGNATURE HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API.

EnergyQuantity

Represents the energy quantity.

Exercise

An exercise that stores information about a physical activity.

Exercise.Types

Container for nested types declared in the Exercise message type.

Exercise.Types.ExerciseEvent

Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.

Exercise.Types.ExerciseEvent.Types

Container for nested types declared in the ExerciseEvent message type.

Exercise.Types.ExerciseMetadata

Additional exercise metadata.

Exercise.Types.SplitSummary

Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.

Exercise.Types.SplitSummary.Types

Container for nested types declared in the SplitSummary message type.

ExportExerciseTcxRequest

Represents a request to export exercise data in TCX format.

ExportExerciseTcxResponse

Represents a Response for exporting exercise data in TCX format.

Floors

Gained elevation measured in floors over the time interval

FloorsRollupValue

Represents the result of the rollup of the user's floors.

Food

Represents a food item.

Food.Types

Container for nested types declared in the Food message type.

Food.Types.FoodServing

Represents different properties and information about the serving of a specific food.

FoodMeasurementUnit

Represents a food measurement unit.

GetDataPointRequest

Request for getting a single data point

GetIdentityRequest

Request message for getting Identity details.

GetIrnProfileRequest

Request message for getting IRN Profile details.

GetPairedDeviceRequest

Request message for getting a Device.

GetProfileRequest

Request message for getting Profile details.

GetSettingsRequest

Request message for getting Settings details.

HealthProfileService

Health Profile Service

HealthProfileService.HealthProfileServiceBase

Base class for server-side implementations of HealthProfileService

HealthProfileService.HealthProfileServiceClient

Client for HealthProfileService

HealthProfileServiceClient

HealthProfileService client wrapper, for convenient use.

HealthProfileServiceClientBuilder

Builder class for HealthProfileServiceClient to provide simple configuration of credentials, endpoint etc.

HealthProfileServiceClientImpl

HealthProfileService client wrapper implementation, for convenient use.

HealthProfileServiceSettings

Settings for HealthProfileServiceClient instances.

HeartRate

A heart rate measurement.

HeartRate.Types

Container for nested types declared in the HeartRate message type.

HeartRate.Types.HeartRateMetadata

Heart rate metadata.

HeartRate.Types.HeartRateMetadata.Types

Container for nested types declared in the HeartRateMetadata message type.

HeartRateRollupValue

Represents the result of the rollup of the heart rate data type.

HeartRateVariability

Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN).

HeartRateVariabilityPersonalRangeRollupValue

Represents the result of the rollup of the user's daily heart rate variability personal range.

Height

Body height measurement.

HydrationLog

Holds information about a user logged hydration.

HydrationLogRollupValue

Represents the result of the rollup of the hydration log data type.

HydrationLogRollupValue.Types

Container for nested types declared in the HydrationLogRollupValue message type.

HydrationLogRollupValue.Types.VolumeQuantityRollup

Rollup for volume quantity.

Identity

Represents details about the Google user's identity.

IdentityName

Resource name for the Identity resource.

IrnProfile

Irregular Rhythm Notifications (IRN) Profile details.

The Irregular Rhythm Notifications (IRN) feature checks for signs of atrial fibrillation (AFib). The IrnProfile details include information about the user's onboarding status, enrollment status, and the last update time of analyzable data for this feature.

IrnProfileName

Resource name for the IrnProfile resource.

IrregularRhythmNotification

Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review.

IrregularRhythmNotification.Types

Container for nested types declared in the IrregularRhythmNotification message type.

IrregularRhythmNotification.Types.AlertWindow

An analysis window evaluated for AFib.

Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm).

IrregularRhythmNotification.Types.HeartBeat

A single heart beat measurement.

ListDataPointsRequest

Request for listing raw data points

ListDataPointsResponse

Response containing raw data points matching the query

ListPairedDevicesRequest

Request message for listing Devices.

ListPairedDevicesResponse

Response message for ListPairedDevices.

ListSubscribersRequest

Request message for ListSubscribers.

ListSubscribersResponse

Response message for ListSubscribers.

ListSubscriptionsRequest

Request message for ListSubscriptions.

ListSubscriptionsResponse

Response message for ListSubscriptions.

MedicalDeviceInfo

Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI).

MetricsSummary

Summary metrics for an exercise.

MetricsSummary.Types

Container for nested types declared in the MetricsSummary message type.

MetricsSummary.Types.MobilityMetrics

Mobility workouts specific metrics

MetricsSummary.Types.TimeInHeartRateZones

Time spent in each heart rate zone.

NutrientQuantity

Represents the quantity of a nutrient.

NutritionLog

Holds information about a user logged food.

There are two ways of creating a nutrition log based on the food type:

Identified food: Using the food field, which is a reference to a Food resource. In this case fields nutrients, energy, energy_from_fat, total_carbohydrate, total_fat, food_display_name will be populated based on the referenced food.
Anonymous food: Using the food_display_name field and setting the nutrients, energy, energy_from_fat, total_carbohydrate, total_fat fields manually.

The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable.

NutritionLog.Types

Container for nested types declared in the NutritionLog message type.

NutritionLog.Types.Serving

Represents different properties and information about the serving of a specific food.

NutritionLogRollupValue

Represents the result of the rollup of the nutrition log data type.

NutritionLogRollupValue.Types

Container for nested types declared in the NutritionLogRollupValue message type.

NutritionLogRollupValue.Types.EnergyQuantityRollup

Rollup for the energy quantity.

NutritionLogRollupValue.Types.NutrientQuantityRollup

Nutrient quantity rollup.

NutritionLogRollupValue.Types.WeightQuantityRollup

Rollup for the weight.

ObservationSampleTime

Represents a sample time of an observed data point.

ObservationTimeInterval

Represents a time interval of an observed data point.

OxygenSaturation

Captures the user's instantaneous oxygen saturation percentage (SpO2).

PairedDevice

User's Paired 1P Device

The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.

PairedDevice.Types

Container for nested types declared in the PairedDevice message type.

PairedDeviceName

Resource name for the PairedDevice resource.

Profile

Profile details.

ProfileName

Resource name for the Profile resource.

ReconcileDataPointsRequest

Request to reconcile data points from multiple data sources.

ReconcileDataPointsResponse

Response containing the list of reconciled DataPoints.

ReconciledDataPoint

A reconciled computed or recorded metric.

RespiratoryRateSleepSummary

Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times.

RespiratoryRateSleepSummary.Types

Container for nested types declared in the RespiratoryRateSleepSummary message type.

RespiratoryRateSleepSummary.Types.RespiratoryRateSleepSummaryStatistics

Respiratory rate statistics for a given sleep stage.

RestingHeartRatePersonalRangeRollupValue

Represents the rollup value for the daily resting heart rate data type.

RollUpDataPointsRequest

Request to roll up data points by physical time intervals.

RollUpDataPointsResponse

Response containing the list of rolled up data points.

RollupDataPoint

Value of a rollup for a single physical time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.

RunVO2Max

VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min.

RunVO2MaxRollupValue

Represents the result of the rollup of the user's daily heart rate variability personal range.

SedentaryPeriod

SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device).

SedentaryPeriodRollupValue

Represents the result of the rollup of the user's sedentary periods.

SessionTimeInterval

Represents a time interval of session data point, which bundles multiple observed metrics together.

Settings

Settings details.

Settings.Types

Container for nested types declared in the Settings message type.

SettingsName

Resource name for the Settings resource.

Sleep

A sleep session possibly including stages.

Sleep.Types

Container for nested types declared in the Sleep message type.

Sleep.Types.OutOfBedSegment

A time interval to represent an out-of-bed segment.

Sleep.Types.SleepMetadata

Additional information about how the sleep was processed.

Sleep.Types.SleepMetadata.Types

Container for nested types declared in the SleepMetadata message type.

Sleep.Types.SleepStage

Sleep stage segment.

Sleep.Types.SleepSummary

Sleep summary: metrics and stages summary.

Sleep.Types.SleepSummary.Types

Container for nested types declared in the SleepSummary message type.

Sleep.Types.SleepSummary.Types.StageSummary

Total duration and segment count for a stage.

Steps

Step count over the time interval.

StepsRollupValue

Represents the result of the rollup of the steps data type.

Subscriber

-- Resource Messages -- A subscriber receives notifications from Google Health API.

Subscriber.Types

Container for nested types declared in the Subscriber message type.

SubscriberConfig

Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type.

SubscriberConfig.Types

Container for nested types declared in the SubscriberConfig message type.

SubscriberName

Resource name for the Subscriber resource.

Subscription

A subscription to a data collection for a specific user, to be delivered to a subscriber.

SubscriptionName

Resource name for the Subscription resource.

SwimLengthsData

Swim lengths data over the time interval.

SwimLengthsData.Types

Container for nested types declared in the SwimLengthsData message type.

SwimLengthsDataRollupValue

Represents the result of the rollup of the swim lengths data type.

TimeInHeartRateZone

Time in heart rate zone record. It's an interval spent in specific heart rate zone.

TimeInHeartRateZoneRollupValue

Represents the result of the rollup of the time in heart rate zone data type.

TimeInHeartRateZoneRollupValue.Types

Container for nested types declared in the TimeInHeartRateZoneRollupValue message type.

TimeInHeartRateZoneRollupValue.Types.TimeInHeartRateZoneValue

Represents the total time spent in a specific heart rate zone.

TotalCaloriesRollupValue

Represents the result of the rollup of the user's total calories.

UpdateDataPointOperationMetadata

Metadata for an update data point operation.

UpdateDataPointRequest

Request to update an identifiable data point.

UpdateProfileRequest

Request message for updating Profile details.

UpdateSettingsRequest

Request message for updating Settings details.

UpdateSubscriberMetadata

Represents metadata for updating a subscriber.

UpdateSubscriberRequest

Request message for UpdateSubscriber.

UpdateSubscriptionRequest

Request message for UpdateSubscription.

User

Represents a user in the Google Health API. It matches the parent resource of collections owned by the user.

Clients currently do not need to interact with this resource directly.

UserName

Resource name for the User resource.

VO2Max

VO2 max measurement.

VO2Max.Types

Container for nested types declared in the VO2Max message type.

VolumeQuantity

Represents the volume quantity.

WebhookNotificationCloudLog

Log message for a webhook notification sent by the Google Health API to a subscriber's endpoint. Includes the HTTP response received from the endpoint.

Weight

Body weight measurement.

WeightQuantity

Represents the weight quantity.

WeightRollupValue

Represents the result of the rollup of the weight data type.