Debian Codegraph @

docs/dyn/health_v4.users.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="health_v4.html">Google Health API</a> . <a href="health_v4.users.html">users</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="health_v4.users.dataTypes.html">dataTypes()</a></code>
79 </p>
80 <p class="firstline">Returns the dataTypes Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="health_v4.users.pairedDevices.html">pairedDevices()</a></code>
84 </p>
85 <p class="firstline">Returns the pairedDevices Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#getIdentity">getIdentity(name, x__xgafv=None)</a></code></p>
92 <p class="firstline">Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.</p>
93 <p class="toc_element">
94 <code><a href="#getIrnProfile">getIrnProfile(name, x__xgafv=None)</a></code></p>
95 <p class="firstline">Returns user's IRN Profile details.</p>
96 <p class="toc_element">
97 <code><a href="#getProfile">getProfile(name, x__xgafv=None)</a></code></p>
98 <p class="firstline">Returns user Profile details.</p>
99 <p class="toc_element">
100 <code><a href="#getSettings">getSettings(name, x__xgafv=None)</a></code></p>
101 <p class="firstline">Returns user settings details.</p>
102 <p class="toc_element">
103 <code><a href="#updateProfile">updateProfile(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
104 <p class="firstline">Updates the user's profile details.</p>
105 <p class="toc_element">
106 <code><a href="#updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
107 <p class="firstline">Updates the user's settings details.</p>
108 <h3>Method Details</h3>
109 <div class="method">
110 <code class="details" id="close">close()</code>
111 <pre>Close httplib2 connections.</pre>
112 </div>
113
114 <div class="method">
115 <code class="details" id="getIdentity">getIdentity(name, x__xgafv=None)</code>
116 <pre>Gets the user&#x27;s identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.
117
118 Args:
119 name: string, Required. The resource name of the Identity. Format: `users/me/identity` (required)
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125 Returns:
126 An object of the form:
127
128 { # Represents details about the Google user&#x27;s identity.
129 &quot;healthUserId&quot;: &quot;A String&quot;, # Output only. The Google User Identifier in the Google Health APIs. It matches the `{user}` resource ID segment in the resource name paths, e.g. `users/{user}/dataTypes/steps`. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.
130 &quot;legacyUserId&quot;: &quot;A String&quot;, # Output only. The legacy Fitbit User identifier. This is the Fitbit ID used in the legacy Fitbit APIs (v1-v3). It can be referenced by clients migrating from the legacy Fitbit APIs to map their existing identifiers to the new Google user ID. It **must not** be used for any other purpose. It is not of any use for new clients using only the Google Health APIs. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.
131 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of this Identity resource. Format: `users/me/identity`
132 }</pre>
133 </div>
134
135 <div class="method">
136 <code class="details" id="getIrnProfile">getIrnProfile(name, x__xgafv=None)</code>
137 <pre>Returns user&#x27;s IRN Profile details.
138
139 Args:
140 name: string, Required. The resource name of the IRN Profile. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` 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. (required)
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146 Returns:
147 An object of the form:
148
149 { # 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&#x27;s onboarding status, enrollment status, and the last update time of analyzable data for this feature.
150 &quot;enrollmentStatus&quot;: True or False, # Required. Whether or not the user is currently enrolled in having their data processed for IRN alerts.
151 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of this IrnProfile resource. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` 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.
152 &quot;onboardingStatus&quot;: True or False, # Required. Whether or not the user has onboarded onto the IRN feature.
153 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of the last piece of analyzable data synced by the user.
154 }</pre>
155 </div>
156
157 <div class="method">
158 <code class="details" id="getProfile">getProfile(name, x__xgafv=None)</code>
159 <pre>Returns user Profile details.
160
161 Args:
162 name: string, Required. The name of the Profile. Format: `users/me/profile`. (required)
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # Profile details.
172 &quot;age&quot;: 42, # Optional. The age in years based on the user&#x27;s birth date. Updates to this field are currently not supported.
173 &quot;autoRunningStrideLengthMm&quot;: 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
174 &quot;autoWalkingStrideLengthMm&quot;: 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
175 &quot;membershipStartDate&quot;: { # 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 # Output only. The date the user created their account. Updates to this field are currently not supported.
176 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
177 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
178 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
179 },
180 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` 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.
181 &quot;userConfiguredRunningStrideLengthMm&quot;: 42, # Optional. The user&#x27;s user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
182 &quot;userConfiguredWalkingStrideLengthMm&quot;: 42, # Optional. The user&#x27;s user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
183 }</pre>
184 </div>
185
186 <div class="method">
187 <code class="details" id="getSettings">getSettings(name, x__xgafv=None)</code>
188 <pre>Returns user settings details.
189
190 Args:
191 name: string, Required. The name of the Settings. Format: `users/me/settings`. (required)
192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
196
197 Returns:
198 An object of the form:
199
200 { # Settings details.
201 &quot;autoStrideEnabled&quot;: True or False, # Optional. True if the user&#x27;s stride length is determined automatically. Updates to this field are currently not supported.
202 &quot;distanceUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings. Updates to this field are currently not supported.
203 &quot;foodLanguageCode&quot;: &quot;A String&quot;, # Output only. The food language code derived from the user&#x27;s food database. Possible values: `&#x27;en-US&#x27;`, `&#x27;en-GB&#x27;`, `&#x27;de-DE&#x27;`, `&#x27;es-ES&#x27;`, `&#x27;fr-FR&#x27;`, `&#x27;zh-CN&#x27;`, `&#x27;zh-TW&#x27;`, `&#x27;ja-JP&#x27;`, `&#x27;en-AU&#x27;`, `&#x27;en-CA&#x27;`, `&#x27;it-IT&#x27;`, `&#x27;ko-KR&#x27;`, `&#x27;es-MX&#x27;`, `&#x27;en-IN&#x27;`, `&#x27;en-SG&#x27;`, `&#x27;en-PH&#x27;`, `&#x27;en-IE&#x27;`, `&#x27;fr-CA&#x27;`. Updates to this field are currently not supported.
204 &quot;glucoseUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
205 &quot;heightUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
206 &quot;languageLocale&quot;: &quot;A String&quot;, # Optional. The locale defined in the user&#x27;s account settings. Updates to this field are currently not supported.
207 &quot;name&quot;: &quot;A String&quot;, # 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.
208 &quot;strideLengthRunningType&quot;: &quot;A String&quot;, # Optional. The stride length type defined in the user&#x27;s account settings for running. Updates to this field are currently not supported.
209 &quot;strideLengthWalkingType&quot;: &quot;A String&quot;, # Optional. The stride length type defined in the user&#x27;s account settings for walking. Updates to this field are currently not supported.
210 &quot;swimUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
211 &quot;temperatureUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
212 &quot;timeZone&quot;: &quot;A String&quot;, # Optional. The timezone defined in the user&#x27;s account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
213 &quot;utcOffset&quot;: &quot;A String&quot;, # Optional. The user&#x27;s timezone offset relative to UTC. Updates to this field are currently not supported.
214 &quot;waterUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
215 &quot;weightUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
216 }</pre>
217 </div>
218
219 <div class="method">
220 <code class="details" id="updateProfile">updateProfile(name, body=None, updateMask=None, x__xgafv=None)</code>
221 <pre>Updates the user&#x27;s profile details.
222
223 Args:
224 name: string, Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` 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. (required)
225 body: object, The request body.
226 The object takes the form of:
227
228 { # Profile details.
229 &quot;age&quot;: 42, # Optional. The age in years based on the user&#x27;s birth date. Updates to this field are currently not supported.
230 &quot;autoRunningStrideLengthMm&quot;: 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
231 &quot;autoWalkingStrideLengthMm&quot;: 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
232 &quot;membershipStartDate&quot;: { # 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 # Output only. The date the user created their account. Updates to this field are currently not supported.
233 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
234 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
235 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
236 },
237 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` 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.
238 &quot;userConfiguredRunningStrideLengthMm&quot;: 42, # Optional. The user&#x27;s user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
239 &quot;userConfiguredWalkingStrideLengthMm&quot;: 42, # Optional. The user&#x27;s user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
240 }
241
242 updateMask: string, Optional. The list of fields to be updated.
243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248 Returns:
249 An object of the form:
250
251 { # Profile details.
252 &quot;age&quot;: 42, # Optional. The age in years based on the user&#x27;s birth date. Updates to this field are currently not supported.
253 &quot;autoRunningStrideLengthMm&quot;: 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
254 &quot;autoWalkingStrideLengthMm&quot;: 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
255 &quot;membershipStartDate&quot;: { # 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 # Output only. The date the user created their account. Updates to this field are currently not supported.
256 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
257 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
258 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
259 },
260 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` 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.
261 &quot;userConfiguredRunningStrideLengthMm&quot;: 42, # Optional. The user&#x27;s user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
262 &quot;userConfiguredWalkingStrideLengthMm&quot;: 42, # Optional. The user&#x27;s user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`
263 }</pre>
264 </div>
265
266 <div class="method">
267 <code class="details" id="updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
268 <pre>Updates the user&#x27;s settings details.
269
270 Args:
271 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. (required)
272 body: object, The request body.
273 The object takes the form of:
274
275 { # Settings details.
276 &quot;autoStrideEnabled&quot;: True or False, # Optional. True if the user&#x27;s stride length is determined automatically. Updates to this field are currently not supported.
277 &quot;distanceUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings. Updates to this field are currently not supported.
278 &quot;foodLanguageCode&quot;: &quot;A String&quot;, # Output only. The food language code derived from the user&#x27;s food database. Possible values: `&#x27;en-US&#x27;`, `&#x27;en-GB&#x27;`, `&#x27;de-DE&#x27;`, `&#x27;es-ES&#x27;`, `&#x27;fr-FR&#x27;`, `&#x27;zh-CN&#x27;`, `&#x27;zh-TW&#x27;`, `&#x27;ja-JP&#x27;`, `&#x27;en-AU&#x27;`, `&#x27;en-CA&#x27;`, `&#x27;it-IT&#x27;`, `&#x27;ko-KR&#x27;`, `&#x27;es-MX&#x27;`, `&#x27;en-IN&#x27;`, `&#x27;en-SG&#x27;`, `&#x27;en-PH&#x27;`, `&#x27;en-IE&#x27;`, `&#x27;fr-CA&#x27;`. Updates to this field are currently not supported.
279 &quot;glucoseUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
280 &quot;heightUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
281 &quot;languageLocale&quot;: &quot;A String&quot;, # Optional. The locale defined in the user&#x27;s account settings. Updates to this field are currently not supported.
282 &quot;name&quot;: &quot;A String&quot;, # 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.
283 &quot;strideLengthRunningType&quot;: &quot;A String&quot;, # Optional. The stride length type defined in the user&#x27;s account settings for running. Updates to this field are currently not supported.
284 &quot;strideLengthWalkingType&quot;: &quot;A String&quot;, # Optional. The stride length type defined in the user&#x27;s account settings for walking. Updates to this field are currently not supported.
285 &quot;swimUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
286 &quot;temperatureUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
287 &quot;timeZone&quot;: &quot;A String&quot;, # Optional. The timezone defined in the user&#x27;s account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
288 &quot;utcOffset&quot;: &quot;A String&quot;, # Optional. The user&#x27;s timezone offset relative to UTC. Updates to this field are currently not supported.
289 &quot;waterUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
290 &quot;weightUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
291 }
292
293 updateMask: string, Optional. The list of fields to be updated.
294 x__xgafv: string, V1 error format.
295 Allowed values
296 1 - v1 error format
297 2 - v2 error format
298
299 Returns:
300 An object of the form:
301
302 { # Settings details.
303 &quot;autoStrideEnabled&quot;: True or False, # Optional. True if the user&#x27;s stride length is determined automatically. Updates to this field are currently not supported.
304 &quot;distanceUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings. Updates to this field are currently not supported.
305 &quot;foodLanguageCode&quot;: &quot;A String&quot;, # Output only. The food language code derived from the user&#x27;s food database. Possible values: `&#x27;en-US&#x27;`, `&#x27;en-GB&#x27;`, `&#x27;de-DE&#x27;`, `&#x27;es-ES&#x27;`, `&#x27;fr-FR&#x27;`, `&#x27;zh-CN&#x27;`, `&#x27;zh-TW&#x27;`, `&#x27;ja-JP&#x27;`, `&#x27;en-AU&#x27;`, `&#x27;en-CA&#x27;`, `&#x27;it-IT&#x27;`, `&#x27;ko-KR&#x27;`, `&#x27;es-MX&#x27;`, `&#x27;en-IN&#x27;`, `&#x27;en-SG&#x27;`, `&#x27;en-PH&#x27;`, `&#x27;en-IE&#x27;`, `&#x27;fr-CA&#x27;`. Updates to this field are currently not supported.
306 &quot;glucoseUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
307 &quot;heightUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
308 &quot;languageLocale&quot;: &quot;A String&quot;, # Optional. The locale defined in the user&#x27;s account settings. Updates to this field are currently not supported.
309 &quot;name&quot;: &quot;A String&quot;, # 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.
310 &quot;strideLengthRunningType&quot;: &quot;A String&quot;, # Optional. The stride length type defined in the user&#x27;s account settings for running. Updates to this field are currently not supported.
311 &quot;strideLengthWalkingType&quot;: &quot;A String&quot;, # Optional. The stride length type defined in the user&#x27;s account settings for walking. Updates to this field are currently not supported.
312 &quot;swimUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
313 &quot;temperatureUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
314 &quot;timeZone&quot;: &quot;A String&quot;, # Optional. The timezone defined in the user&#x27;s account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
315 &quot;utcOffset&quot;: &quot;A String&quot;, # Optional. The user&#x27;s timezone offset relative to UTC. Updates to this field are currently not supported.
316 &quot;waterUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
317 &quot;weightUnit&quot;: &quot;A String&quot;, # Optional. The measurement unit defined in the user&#x27;s account settings.
318 }</pre>
319 </div>
320
321 </body></html>