Settings

Settings details.

JSON representation
{
  "name": string,
  "timeZone": string,
  "autoStrideEnabled": boolean,
  "distanceUnit": enum (Settings.DistanceUnit),
  "glucoseUnit": enum (Settings.GlucoseUnit),
  "heightUnit": enum (Settings.HeightUnit),
  "languageLocale": string,
  "utcOffset": string,
  "strideLengthWalkingType": enum (Settings.StrideLengthType),
  "strideLengthRunningType": enum (Settings.StrideLengthType),
  "swimUnit": enum (Settings.SwimUnit),
  "temperatureUnit": enum (Settings.TemperatureUnit),
  "weightUnit": enum (Settings.WeightUnit),
  "waterUnit": enum (Settings.WaterUnit)
}
Fields
name

string

Identifier. The resource name of this Settings resource.

Format: users/{user}/settings Example: users/1234567890/settings or users/me/settings The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal me can also be used to refer to the authenticated user.

timeZone

string

Optional. The timezone defined in the user's account settings. This follows the IANA Time Zone Database.

Updates to this field are currently not supported.

autoStrideEnabled

boolean

Optional. True if the user's stride length is determined automatically.

Updates to this field are currently not supported.

distanceUnit

enum (Settings.DistanceUnit)

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

Updates to this field are currently not supported.

glucoseUnit

enum (Settings.GlucoseUnit)

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

heightUnit

enum (Settings.HeightUnit)

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

languageLocale

string

Optional. The locale defined in the user's account settings.

Updates to this field are currently not supported.

utcOffset

string (Duration format)

Optional. The duration of the offset from UTC in milliseconds. This offset is the difference between the user's current local time and UTC.

Updates to this field are currently not supported.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

strideLengthWalkingType

enum (Settings.StrideLengthType)

Optional. The stride length type defined in the user's account settings for walking.

Updates to this field are currently not supported.

strideLengthRunningType

enum (Settings.StrideLengthType)

Optional. The stride length type defined in the user's account settings for running.

Updates to this field are currently not supported.

swimUnit

enum (Settings.SwimUnit)

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

temperatureUnit

enum (Settings.TemperatureUnit)

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

weightUnit

enum (Settings.WeightUnit)

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

waterUnit

enum (Settings.WaterUnit)

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

Settings.DistanceUnit

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

Enums
DISTANCE_UNIT_UNSPECIFIED Distance unit is not specified.
DISTANCE_UNIT_MILES Distance unit is miles.
DISTANCE_UNIT_KILOMETERS Distance unit is kilometers.

Settings.GlucoseUnit

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

Enums
GLUCOSE_UNIT_UNSPECIFIED Glucose unit is not specified.
GLUCOSE_UNIT_MG_DL Glucose unit is mg/dL.
GLUCOSE_UNIT_MMOL_L Glucose unit is mmol/l.

Settings.HeightUnit

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

Enums
HEIGHT_UNIT_UNSPECIFIED Height unit is not specified.
HEIGHT_UNIT_INCHES Height unit is inches.
HEIGHT_UNIT_CENTIMETERS Height unit is cm.

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

Enums
STRIDE_LENGTH_TYPE_UNSPECIFIED Stride length type is not specified.
STRIDE_LENGTH_TYPE_DEFAULT Stride length type is computed based on the user's gender and height.
STRIDE_LENGTH_TYPE_MANUAL Stride length type is manually set by the user.
STRIDE_LENGTH_TYPE_AUTO Stride length type is determined automatically.

Settings.SwimUnit

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

Enums
SWIM_UNIT_UNSPECIFIED Swim unit is not specified.
SWIM_UNIT_METERS Swim unit is meters.
SWIM_UNIT_YARDS Swim unit is yards.

Settings.TemperatureUnit

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

Enums
TEMPERATURE_UNIT_UNSPECIFIED Temperature unit is not specified.
TEMPERATURE_UNIT_CELSIUS Temperature unit is Celsius.
TEMPERATURE_UNIT_FAHRENHEIT Temperature unit is Fahrenheit.

Settings.WeightUnit

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

Enums
WEIGHT_UNIT_UNSPECIFIED Weight unit is not specified.
WEIGHT_UNIT_POUNDS Weight unit is pounds.
WEIGHT_UNIT_STONE Weight unit is stones.
WEIGHT_UNIT_KILOGRAMS Weight unit is kilograms.

Settings.WaterUnit

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

Enums
WATER_UNIT_UNSPECIFIED Water unit is not specified.
WATER_UNIT_ML Water unit is milliliters.
WATER_UNIT_FL_OZ Water unit is fluid ounces.
WATER_UNIT_CUP Water unit is cups.