GOgoogle
users

GET /v4/users/{usersId}/settings

Returns user settings details.

Request

  • Base URL
    https://health.googleapis.com
  • URL
    https://health.googleapis.com/v4/users/{usersId}/settings
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/googlehealth.settings.readonly
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/googlehealth.settings.readonly

Path parameters

usersIdstring required

Response

Successful response

autoStrideEnabledboolean

Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.

distanceUnit'DISTANCE_UNIT_UNSPECIFIED' | 'DISTANCE_UNIT_MILES' | 'DISTANCE_UNIT_KILOMETERS'

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

foodLanguageCodestring

Output only. The food language code derived from the user's food database. Possible values: 'en-US', 'en-GB', 'de-DE', 'es-ES', 'fr-FR', 'zh-CN', 'zh-TW', 'ja-JP', 'en-AU', 'en-CA', 'it-IT', 'ko-KR', 'es-MX', 'en-IN', 'en-SG', 'en-PH', 'en-IE', 'fr-CA'. Updates to this field are currently not supported.

glucoseUnit'GLUCOSE_UNIT_UNSPECIFIED' | 'GLUCOSE_UNIT_MG_DL' | 'GLUCOSE_UNIT_MMOL_L'

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

heightUnit'HEIGHT_UNIT_UNSPECIFIED' | 'HEIGHT_UNIT_INCHES' | 'HEIGHT_UNIT_CENTIMETERS'

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

languageLocalestring

Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.

namestring

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. This field is read-only.

strideLengthRunningType'STRIDE_LENGTH_TYPE_UNSPECIFIED' | 'STRIDE_LENGTH_TYPE_DEFAULT' | 'STRIDE_LENGTH_TYPE_MANUAL' | 'STRIDE_LENGTH_TYPE_AUTO'

Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.

strideLengthWalkingType'STRIDE_LENGTH_TYPE_UNSPECIFIED' | 'STRIDE_LENGTH_TYPE_DEFAULT' | 'STRIDE_LENGTH_TYPE_MANUAL' | 'STRIDE_LENGTH_TYPE_AUTO'

Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.

swimUnit'SWIM_UNIT_UNSPECIFIED' | 'SWIM_UNIT_METERS' | 'SWIM_UNIT_YARDS'

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

temperatureUnit'TEMPERATURE_UNIT_UNSPECIFIED' | 'TEMPERATURE_UNIT_CELSIUS' | 'TEMPERATURE_UNIT_FAHRENHEIT'

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

timeZonestring

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.

utcOffsetstring google-duration

Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.

waterUnit'WATER_UNIT_UNSPECIFIED' | 'WATER_UNIT_ML' | 'WATER_UNIT_FL_OZ' | 'WATER_UNIT_CUP'

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

weightUnit'WEIGHT_UNIT_UNSPECIFIED' | 'WEIGHT_UNIT_POUNDS' | 'WEIGHT_UNIT_STONE' | 'WEIGHT_UNIT_KILOGRAMS'

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

Changes

No recorded changes to this operation across all 6 revisions of this API.