Show / Hide Table of Contents

Namespace Google.DevicesAndServices.Health.V4

Classes

ActiveMinutes

Record of active minutes in a given time interval.

ActiveMinutes.Types

Container for nested types declared in the ActiveMinutes message type.

ActiveMinutes.Types.ActiveMinutesByActivityLevel

Active minutes at a given activity level.

ActiveMinutesRollupValue

Represents the result of the rollup of the active minutes data type.

ActiveMinutesRollupValue.Types

Container for nested types declared in the ActiveMinutesRollupValue message type.

ActiveMinutesRollupValue.Types.ActiveMinutesRollupByActivityLevel

Active minutes by activity level.

ActiveZoneMinutes

Record of active zone minutes in a given time interval.

ActiveZoneMinutes.Types

Container for nested types declared in the ActiveZoneMinutes message type.

ActiveZoneMinutesRollupValue

Represents the result of the rollup of the active zone minutes data type.

ActivityLevel

Internal type to capture activity level during a certain time interval.

ActivityLevel.Types

Container for nested types declared in the ActivityLevel message type.

ActivityLevelRollupValue

Represents the result of the rollup of the activity level data type.

ActivityLevelRollupValue.Types

Container for nested types declared in the ActivityLevelRollupValue message type.

ActivityLevelRollupValue.Types.ActivityLevelRollupByActivityLevelType

Represents the total duration in a specific activity level type.

Altitude

Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters.

AltitudeRollupValue

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

BasalEnergyBurned

Number of calories burned due to basal metabolic rate (BMR) over a period of time.

BatchDeleteDataPointsOperationMetadata

Metadata for a batch delete data points operation.

BatchDeleteDataPointsRequest

Request to delete a batch of identifiable data points.

BatchDeleteDataPointsResponse

Response containing the list of possibly soft-deleted DataPoints.

BodyFat

Body fat measurement.

BodyFatRollupValue

Represents the result of the rollup of the body fat data type.

CaloriesInHeartRateZoneRollupValue

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

CaloriesInHeartRateZoneRollupValue.Types

Container for nested types declared in the CaloriesInHeartRateZoneRollupValue message type.

CaloriesInHeartRateZoneRollupValue.Types.CaloriesInHeartRateZoneValue

Represents the amount of kilocalories burned in a specific heart rate zone.

CivilDateTime

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].

CreateDataPointOperationMetadata

Metadata for a create data point operation.

CreateDataPointRequest

Request to create an identifiable data point.

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)

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.

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.

Distance

Distance traveled over an interval of time.

DistanceRollupValue

Result of the rollup of the user's distance.

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.

GetDataPointRequest

Request for getting a single data point

GetIdentityRequest

Request message for getting Identity details.

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.

ListDataPointsRequest

Request for listing raw data points

ListDataPointsResponse

Response containing raw data points matching the query

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.

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

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)

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

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.

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.

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.

WeightRollupValue

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

Enums

ActiveMinutes.Types.ActivityLevel

Activity level.

ActiveZoneMinutes.Types.HeartRateZone

Represents different heart rate zones.

ActivityLevel.Types.ActivityLevelType

Represents different activity level types.

DailyRestingHeartRate.Types.DailyRestingHeartRateMetadata.Types.CalculationMethod

The method used to calculate the resting heart rate.

DailyRollupDataPoint.ValueOneofCase

Enum of possible cases for the "value" oneof.

DailyVO2Max.Types.CardioFitnessLevel

The cardio fitness level categories.

DataPoint.DataOneofCase

Enum of possible cases for the "data" oneof.

DataPointName.ResourceNameType

The possible contents of DataPointName.

DataSource.Types.Device.Types.FormFactor

Form factor of the device, e.g. phone, watch, band, etc.

DataSource.Types.Platform

The platform that uploaded the data. Additional values may be added in the future. Clients should be prepared to handle unknown values gracefully.

DataSource.Types.RecordingMethod

The method by which the data was recorded.

DataTypeName.ResourceNameType

The possible contents of DataTypeName.

Exercise.Types.ExerciseEvent.Types.ExerciseEventType

The type of the event, such as start, stop, pause, resume.

Exercise.Types.ExerciseType

The type of activity performed during an exercise.

Exercise.Types.SplitSummary.Types.SplitType

The type of the split, such as manual, duration, distance, calories.

HeartRate.Types.HeartRateMetadata.Types.MotionContext

The user’s level of activity when the heart rate sample was measured.

HeartRate.Types.HeartRateMetadata.Types.SensorLocation

The location of the sensor that measured the heart rate.

HeartRateZoneType

The heart rate zone type.

IdentityName.ResourceNameType

The possible contents of IdentityName.

ProfileName.ResourceNameType

The possible contents of ProfileName.

ReconciledDataPoint.DataOneofCase

Enum of possible cases for the "data" oneof.

RollupDataPoint.ValueOneofCase

Enum of possible cases for the "value" oneof.

Settings.Types.DistanceUnit

The measurement unit defined in the user's account settings.

Settings.Types.GlucoseUnit

The measurement unit defined in the user's account settings.

Settings.Types.HeightUnit

The measurement unit defined in the user's account settings.

Settings.Types.StrideLengthType

The stride length type defined in the user's account settings. Specifies if the user's stride length is determined automatically (default) or manually as defined in the user's account settings.

Settings.Types.SwimUnit

The swim unit defined in the user's account settings.

Settings.Types.TemperatureUnit

The measurement unit defined in the user's account settings.

Settings.Types.WaterUnit

The water measurement unit defined in the user's account settings.

Settings.Types.WeightUnit

The measurement unit defined in the user's account settings.

SettingsName.ResourceNameType

The possible contents of SettingsName.

Sleep.Types.SleepMetadata.Types.StagesState

Sleep stages algorithm processing status.

Sleep.Types.SleepStageType

Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.

Sleep.Types.SleepType

Sleep type: classic or stages.

SwimLengthsData.Types.SwimStrokeType

Swim stroke type.

VO2Max.Types.MeasurementMethod

Measurement method used to measure the VO2 max value.

VolumeUnit

Enum representing the unit of volume.

In this article
Back to top Generated by DocFX