Namespace Google.Apis.GoogleHealthAPI.v4.Data

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

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.

Application

Optional metadata for the application that provided this data.

BasalEnergyBurned

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

BatchDeleteDataPointsRequest

Request to delete a batch of identifiable data points.

BloodGlucose

Represents a blood glucose level measurement. LINT: LEGACY_NAMES

BloodGlucoseRollupValue

Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES

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.

CaloriesInHeartRateZoneValue

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

CivilDateTime

Civil time representation similar to 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, but using CivilDateTime.

CoreBodyTemperature

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

CoreBodyTemperatureRollupValue

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

CreateSubscriberPayload

Payload for creating a subscriber.

CreateSubscriptionPayload

Payload for creating a subscription.

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.

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.

DailyRestingHeartRateMetadata

Metadata for the daily resting heart rate.

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.

DataPoint

A computed or recorded metric.

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

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

DateTime

Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

Device

Captures metadata about the device that recorded the measurement.

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.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

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.

EnergyQuantityRollup

Rollup for the energy quantity.

Exercise

An exercise that stores information about a physical activity.

ExerciseEvent

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

ExerciseMetadata

Additional exercise metadata.

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.

FoodMeasurementUnit

Represents a food measurement unit.

FoodServing

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

GoogleDevicesandservicesHealthV4DataType

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.

GoogleDevicesandservicesHealthV4User

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.

GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog

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.

HeartBeat

A single heart beat measurement.

HeartRate

A heart rate measurement.

HeartRateMetadata

Heart rate metadata.

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.

HeartRateZone

The heart rate zone.

Height

Body height measurement.

HttpHeader

Represents an HTTP header.

HttpResponse

Represents an HTTP response.

HydrationLog

Holds information about a user logged hydration.

HydrationLogRollupValue

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

Identity

Represents details about the Google user's identity.

Interval

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

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.

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.

ListDataPointsResponse

Response containing raw data points matching the query

ListPairedDevicesResponse

Response message for ListPairedDevices.

ListSubscribersResponse

Response message for ListSubscribers.

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.

MobilityMetrics

Mobility workouts specific metrics

NutrientQuantity

Represents the quantity of a nutrient.

NutrientQuantityRollup

Nutrient quantity rollup.

NutritionLog

Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. 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. 2. 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.

NutritionLogRollupValue

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

ObservationSampleTime

Represents a sample time of an observed data point.

ObservationTimeInterval

Represents a time interval of an observed data point.

Operation

This resource represents a long-running operation that is the result of a network API call.

OutOfBedSegment

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

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.

Profile

Profile details.

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.

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

Serving

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

SessionTimeInterval

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

Settings

Settings details.

Sleep

A sleep session possibly including stages.

SleepMetadata

Additional information about how the sleep was processed.

SleepStage

Sleep stage segment.

SleepSummary

Sleep summary: metrics and stages summary.

SplitSummary

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

StageSummary

Total duration and segment count for a stage.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.