Class: Google::Apis::HealthV4::DataPoint

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/health_v4/classes.rb,
lib/google/apis/health_v4/representations.rb,
lib/google/apis/health_v4/representations.rb

Overview

A computed or recorded metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DataPoint

Returns a new instance of DataPoint.



1333
1334
1335
 
# File 'lib/google/apis/health_v4/classes.rb', line 1333

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active_minutes ⇒ Google::Apis::HealthV4::ActiveMinutes

Record of active minutes in a given time interval. Corresponds to the JSON property activeMinutes

Returns:



1146
1147
1148
 
# File 'lib/google/apis/health_v4/classes.rb', line 1146

def active_minutes
  @active_minutes
end

#active_zone_minutes ⇒ Google::Apis::HealthV4::ActiveZoneMinutes

Record of active zone minutes in a given time interval. Corresponds to the JSON property activeZoneMinutes

Returns:



1151
1152
1153
 
# File 'lib/google/apis/health_v4/classes.rb', line 1151

def active_zone_minutes
  @active_zone_minutes
end

#activity_level ⇒ Google::Apis::HealthV4::ActivityLevel

Internal type to capture activity level during a certain time interval. Corresponds to the JSON property activityLevel

Returns:



1156
1157
1158
 
# File 'lib/google/apis/health_v4/classes.rb', line 1156

def activity_level
  @activity_level
end

#altitude ⇒ Google::Apis::HealthV4::Altitude

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

Returns:



1162
1163
1164
 
# File 'lib/google/apis/health_v4/classes.rb', line 1162

def altitude
  @altitude
end

#basal_energy_burned ⇒ Google::Apis::HealthV4::BasalEnergyBurned

Number of calories burned due to basal metabolic rate (BMR) over a period of time. Corresponds to the JSON property basalEnergyBurned

Returns:



1168
1169
1170
 
# File 'lib/google/apis/health_v4/classes.rb', line 1168

def basal_energy_burned
  @basal_energy_burned
end

#body_fat ⇒ Google::Apis::HealthV4::BodyFat

Body fat measurement. Corresponds to the JSON property bodyFat

Returns:



1173
1174
1175
 
# File 'lib/google/apis/health_v4/classes.rb', line 1173

def body_fat
  @body_fat
end

#daily_heart_rate_variability ⇒ Google::Apis::HealthV4::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 Corresponds to the JSON property dailyHeartRateVariability

Returns:



1181
1182
1183
 
# File 'lib/google/apis/health_v4/classes.rb', line 1181

def daily_heart_rate_variability
  @daily_heart_rate_variability
end

#daily_heart_rate_zones ⇒ Google::Apis::HealthV4::DailyHeartRateZones

User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. Corresponds to the JSON property dailyHeartRateZones

Returns:



1187
1188
1189
 
# File 'lib/google/apis/health_v4/classes.rb', line 1187

def daily_heart_rate_zones
  @daily_heart_rate_zones
end

#daily_oxygen_saturation ⇒ Google::Apis::HealthV4::DailyOxygenSaturation

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

Returns:



1193
1194
1195
 
# File 'lib/google/apis/health_v4/classes.rb', line 1193

def daily_oxygen_saturation
  @daily_oxygen_saturation
end

#daily_respiratory_rate ⇒ Google::Apis::HealthV4::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. Corresponds to the JSON property dailyRespiratoryRate

Returns:



1199
1200
1201
 
# File 'lib/google/apis/health_v4/classes.rb', line 1199

def daily_respiratory_rate
  @daily_respiratory_rate
end

#daily_resting_heart_rate ⇒ Google::Apis::HealthV4::DailyRestingHeartRate

Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. Corresponds to the JSON property dailyRestingHeartRate

Returns:



1205
1206
1207
 
# File 'lib/google/apis/health_v4/classes.rb', line 1205

def daily_resting_heart_rate
  @daily_resting_heart_rate
end

#daily_sleep_temperature_derivations ⇒ Google::Apis::HealthV4::DailySleepTemperatureDerivations

Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. Corresponds to the JSON property dailySleepTemperatureDerivations

Returns:



1211
1212
1213
 
# File 'lib/google/apis/health_v4/classes.rb', line 1211

def daily_sleep_temperature_derivations
  @daily_sleep_temperature_derivations
end

#daily_vo2_max ⇒ Google::Apis::HealthV4::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. Corresponds to the JSON property dailyVo2Max

Returns:



1217
1218
1219
 
# File 'lib/google/apis/health_v4/classes.rb', line 1217

def daily_vo2_max
  @daily_vo2_max
end

#data_source ⇒ Google::Apis::HealthV4::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). Corresponds to the JSON property dataSource

Returns:



1225
1226
1227
 
# File 'lib/google/apis/health_v4/classes.rb', line 1225

def data_source
  @data_source
end

#distance ⇒ Google::Apis::HealthV4::Distance

Distance traveled over an interval of time. Corresponds to the JSON property distance

Returns:



1230
1231
1232
 
# File 'lib/google/apis/health_v4/classes.rb', line 1230

def distance
  @distance
end

#exercise ⇒ Google::Apis::HealthV4::Exercise

An exercise that stores information about a physical activity. Corresponds to the JSON property exercise

Returns:



1235
1236
1237
 
# File 'lib/google/apis/health_v4/classes.rb', line 1235

def exercise
  @exercise
end

#floors ⇒ Google::Apis::HealthV4::Floors

Gained elevation measured in floors over the time interval Corresponds to the JSON property floors

Returns:



1240
1241
1242
 
# File 'lib/google/apis/health_v4/classes.rb', line 1240

def floors
  @floors
end

#heart_rate ⇒ Google::Apis::HealthV4::HeartRate

A heart rate measurement. Corresponds to the JSON property heartRate

Returns:



1245
1246
1247
 
# File 'lib/google/apis/health_v4/classes.rb', line 1245

def heart_rate
  @heart_rate
end

#heart_rate_variability ⇒ Google::Apis::HealthV4::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). Corresponds to the JSON property heartRateVariability

Returns:



1252
1253
1254
 
# File 'lib/google/apis/health_v4/classes.rb', line 1252

def heart_rate_variability
  @heart_rate_variability
end

#height ⇒ Google::Apis::HealthV4::Height

Body height measurement. Corresponds to the JSON property height

Returns:



1257
1258
1259
 
# File 'lib/google/apis/health_v4/classes.rb', line 1257

def height
  @height
end

#hydration_log ⇒ Google::Apis::HealthV4::HydrationLog

Holds information about a user logged hydration. Corresponds to the JSON property hydrationLog

Returns:



1262
1263
1264
 
# File 'lib/google/apis/health_v4/classes.rb', line 1262

def hydration_log
  @hydration_log
end

#name ⇒ String

Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: users/user/ dataTypes/data_type/dataPoints/data_pointExample: `users/abcd1234/ dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` Theuser ID is a system-generated identifier, as described in Identity.health_user_id. Thedata_typeID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the ` total_calories` field. Thedata_point`ID can be client-provided or system- generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1277
1278
1279
 
# File 'lib/google/apis/health_v4/classes.rb', line 1277

def name
  @name
end

#oxygen_saturation ⇒ Google::Apis::HealthV4::OxygenSaturation

Captures the user's instantaneous oxygen saturation percentage (SpO2). Corresponds to the JSON property oxygenSaturation

Returns:



1282
1283
1284
 
# File 'lib/google/apis/health_v4/classes.rb', line 1282

def oxygen_saturation
  @oxygen_saturation
end

#respiratory_rate_sleep_summary ⇒ Google::Apis::HealthV4::RespiratoryRateSleepSummary

Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. Corresponds to the JSON property respiratoryRateSleepSummary

Returns:



1288
1289
1290
 
# File 'lib/google/apis/health_v4/classes.rb', line 1288

def respiratory_rate_sleep_summary
  @respiratory_rate_sleep_summary
end

#run_vo2_max ⇒ Google::Apis::HealthV4::RunVo2Max

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

Returns:



1294
1295
1296
 
# File 'lib/google/apis/health_v4/classes.rb', line 1294

def run_vo2_max
  @run_vo2_max
end

#sedentary_period ⇒ Google::Apis::HealthV4::SedentaryPeriod

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

Returns:



1300
1301
1302
 
# File 'lib/google/apis/health_v4/classes.rb', line 1300

def sedentary_period
  @sedentary_period
end

#sleep ⇒ Google::Apis::HealthV4::Sleep

A sleep session possibly including stages. Corresponds to the JSON property sleep

Returns:



1305
1306
1307
 
# File 'lib/google/apis/health_v4/classes.rb', line 1305

def sleep
  @sleep
end

#steps ⇒ Google::Apis::HealthV4::Steps

Step count over the time interval. Corresponds to the JSON property steps

Returns:



1310
1311
1312
 
# File 'lib/google/apis/health_v4/classes.rb', line 1310

def steps
  @steps
end

#swim_lengths_data ⇒ Google::Apis::HealthV4::SwimLengthsData

Swim lengths data over the time interval. Corresponds to the JSON property swimLengthsData

Returns:



1315
1316
1317
 
# File 'lib/google/apis/health_v4/classes.rb', line 1315

def swim_lengths_data
  @swim_lengths_data
end

#time_in_heart_rate_zone ⇒ Google::Apis::HealthV4::TimeInHeartRateZone

Time in heart rate zone record. It's an interval spent in specific heart rate zone. Corresponds to the JSON property timeInHeartRateZone

Returns:



1321
1322
1323
 
# File 'lib/google/apis/health_v4/classes.rb', line 1321

def time_in_heart_rate_zone
  @time_in_heart_rate_zone
end

#vo2_max ⇒ Google::Apis::HealthV4::Vo2Max

VO2 max measurement. Corresponds to the JSON property vo2Max

Returns:



1326
1327
1328
 
# File 'lib/google/apis/health_v4/classes.rb', line 1326

def vo2_max
  @vo2_max
end

#weight ⇒ Google::Apis::HealthV4::Weight

Body weight measurement. Corresponds to the JSON property weight

Returns:



1331
1332
1333
 
# File 'lib/google/apis/health_v4/classes.rb', line 1331

def weight
  @weight
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/google/apis/health_v4/classes.rb', line 1338

def update!(**args)
  @active_minutes = args[:active_minutes] if args.key?(:active_minutes)
  @active_zone_minutes = args[:active_zone_minutes] if args.key?(:active_zone_minutes)
  @activity_level = args[:activity_level] if args.key?(:activity_level)
  @altitude = args[:altitude] if args.key?(:altitude)
  @basal_energy_burned = args[:basal_energy_burned] if args.key?(:basal_energy_burned)
  @body_fat = args[:body_fat] if args.key?(:body_fat)
  @daily_heart_rate_variability = args[:daily_heart_rate_variability] if args.key?(:daily_heart_rate_variability)
  @daily_heart_rate_zones = args[:daily_heart_rate_zones] if args.key?(:daily_heart_rate_zones)
  @daily_oxygen_saturation = args[:daily_oxygen_saturation] if args.key?(:daily_oxygen_saturation)
  @daily_respiratory_rate = args[:daily_respiratory_rate] if args.key?(:daily_respiratory_rate)
  @daily_resting_heart_rate = args[:daily_resting_heart_rate] if args.key?(:daily_resting_heart_rate)
  @daily_sleep_temperature_derivations = args[:daily_sleep_temperature_derivations] if args.key?(:daily_sleep_temperature_derivations)
  @daily_vo2_max = args[:daily_vo2_max] if args.key?(:daily_vo2_max)
  @data_source = args[:data_source] if args.key?(:data_source)
  @distance = args[:distance] if args.key?(:distance)
  @exercise = args[:exercise] if args.key?(:exercise)
  @floors = args[:floors] if args.key?(:floors)
  @heart_rate = args[:heart_rate] if args.key?(:heart_rate)
  @heart_rate_variability = args[:heart_rate_variability] if args.key?(:heart_rate_variability)
  @height = args[:height] if args.key?(:height)
  @hydration_log = args[:hydration_log] if args.key?(:hydration_log)
  @name = args[:name] if args.key?(:name)
  @oxygen_saturation = args[:oxygen_saturation] if args.key?(:oxygen_saturation)
  @respiratory_rate_sleep_summary = args[:respiratory_rate_sleep_summary] if args.key?(:respiratory_rate_sleep_summary)
  @run_vo2_max = args[:run_vo2_max] if args.key?(:run_vo2_max)
  @sedentary_period = args[:sedentary_period] if args.key?(:sedentary_period)
  @sleep = args[:sleep] if args.key?(:sleep)
  @steps = args[:steps] if args.key?(:steps)
  @swim_lengths_data = args[:swim_lengths_data] if args.key?(:swim_lengths_data)
  @time_in_heart_rate_zone = args[:time_in_heart_rate_zone] if args.key?(:time_in_heart_rate_zone)
  @vo2_max = args[:vo2_max] if args.key?(:vo2_max)
  @weight = args[:weight] if args.key?(:weight)
end