{ "version_module": true, "ownerDomain": "google.com", "parameters": { "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "location": "query", "type": "string", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "version": "v4", "basePath": "", "rootUrl": "https://health.googleapis.com/", "discoveryVersion": "v1", "canonicalName": "Google Health API", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/googlehealth.sleep.writeonly": { "description": "Add sleep data to Google Health, and edit or delete the data it adds." }, "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly": { "description": "Add activity and fitness data to Google Health, and edit or delete the data it adds." }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly": { "description": "See your Google Health activity and fitness data" }, "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly": { "description": "Add nutrition data to Google Health, and edit or delete the data it adds." }, "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly": { "description": "Add health metric and measurements data to Google Health, and edit or delete the data it adds." }, "https://www.googleapis.com/auth/googlehealth.irn.readonly": { "description": "See your Google Health Irregular Rhythm Notifications data" }, "https://www.googleapis.com/auth/googlehealth.ecg.readonly": { "description": "See your Google Health ECG data" }, "https://www.googleapis.com/auth/googlehealth.settings.readonly": { "description": "See your Google Health settings" }, "https://www.googleapis.com/auth/googlehealth.settings.writeonly": { "description": "Add settings data to Google Health, and edit or delete the data it adds." }, "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly": { "description": "See your Google Health health metrics and measurement data" }, "https://www.googleapis.com/auth/googlehealth.location.writeonly": { "description": "Add exercise GPS location data to Google Health, and edit or delete the data it adds." }, "https://www.googleapis.com/auth/googlehealth.profile.writeonly": { "description": "Add profile data to Google Health, and edit or delete the data it adds." }, "https://www.googleapis.com/auth/googlehealth.sleep.readonly": { "description": "See your Google Health sleep data" }, "https://www.googleapis.com/auth/googlehealth.location.readonly": { "description": "See exercise GPS location data in Google Health" }, "https://www.googleapis.com/auth/googlehealth.profile.readonly": { "description": "See your Google Health profile data" } } } }, "baseUrl": "https://health.googleapis.com/", "protocol": "rest", "resources": { "projects": { "resources": { "subscribers": { "methods": { "delete": { "flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.", "path": "v4/{+name}", "response": { "$ref": "Operation" }, "id": "health.projects.subscribers.delete", "parameters": { "name": { "description": "Required. The name of the subscriber to delete. Format: projects/{project}/subscribers/{subscriber} Example: projects/my-project/subscribers/my-subscriber-123 The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation.", "type": "string", "pattern": "^projects/[^/]+/subscribers/[^/]+$", "location": "path", "required": true }, "force": { "description": "Optional. If set to true, any child resources (e.g., subscriptions) will also be deleted. If false (default) and child resources exist, the request will fail.", "location": "query", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v4/projects/{projectsId}/subscribers", "httpMethod": "GET", "path": "v4/{+parent}/subscribers", "response": { "$ref": "ListSubscribersResponse" }, "parameterOrder": [ "parent" ], "description": "Lists all subscribers registered within the owned Google Cloud Project.", "id": "health.projects.subscribers.list", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of subscribers. Format: projects/{project}", "type": "string", "pattern": "^projects/[^/]+$", "location": "path", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The maximum number of subscribers to return. The service may return fewer than this value. If unspecified, at most 50 subscribers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "flatPath": "v4/projects/{projectsId}/subscribers", "httpMethod": "POST", "id": "health.projects.subscribers.create", "parameters": { "parent": { "description": "Required. The parent resource where this subscriber will be created. Format: projects/{project} Example: projects/my-project-123", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "subscriberId": { "description": "Optional. The ID to use for the subscriber, which will become the final component of the subscriber's resource name. This value should be 4-36 characters, and valid characters are /[a-z]([a-z0-9-]{2,34}[a-z0-9])/.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. **Endpoint Verification:** For a subscriber to be successfully created, the provided `endpoint_uri` must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the `endpoint_uri`: 1. **Verification with Authorization:** * **Headers:** Includes `Content-Type: application/json` and `Authorization` (with the exact value from `CreateSubscriberPayload.endpoint_authorization.secret`). * **Body:** `{\"type\": \"verification\"}` * **Expected Response:** HTTP `201 Created`. 2. **Verification without Authorization:** * **Headers:** Includes `Content-Type: application/json`. The `Authorization` header is OMITTED. * **Body:** `{\"type\": \"verification\"}` * **Expected Response:** HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the `Authorization` header.", "path": "v4/{+parent}/subscribers", "response": { "$ref": "Operation" }, "request": { "$ref": "CreateSubscriberPayload" } }, "patch": { "flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}", "httpMethod": "PATCH", "id": "health.projects.subscribers.patch", "parameters": { "name": { "description": "Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef", "pattern": "^projects/[^/]+/subscribers/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. A field mask that specifies which fields of the Subscriber message are to be updated. This allows for partial updates. Supported fields: - endpoint_uri - subscriber_configs - endpoint_authorization", "location": "query", "format": "google-fieldmask", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Subscriber" }, "path": "v4/{+name}", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "description": "Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. **Endpoint Verification:** If the `endpoint_uri` or `endpoint_authorization` field is included in the `update_mask`, the backend will re-verify the endpoint. The verification process is the same as described in `CreateSubscriber`: 1. **Verification with Authorization:** POST to the new or existing `endpoint_uri` with the new or existing `Authorization` secret. Expects HTTP `201 Created`. 2. **Verification without Authorization:** POST to the `endpoint_uri` without the `Authorization` header. Expects HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned." } }, "resources": { "subscriptions": { "methods": { "delete": { "flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a specific user subscription, stopping notifications for this user to this subscriber.", "path": "v4/{+name}", "response": { "$ref": "Empty" }, "id": "health.projects.subscribers.subscriptions.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The resource name of the subscription to delete. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "id": "health.projects.subscribers.subscriptions.create", "parameters": { "parent": { "description": "Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise.", "type": "string", "pattern": "^projects/[^/]+/subscribers/[^/]+$", "location": "path", "required": true }, "subscriptionId": { "description": "Optional. The {subscription_id} is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. If provided, the ID must be unique within the parent subscriber.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.", "path": "v4/{+parent}/subscriptions", "response": { "$ref": "Subscription" }, "request": { "$ref": "CreateSubscriptionPayload" }, "flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions", "httpMethod": "POST" }, "patch": { "flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}", "httpMethod": "PATCH", "path": "v4/{+name}", "response": { "$ref": "Subscription" }, "parameterOrder": [ "name" ], "description": "Updates the data types for an existing user subscription.", "request": { "$ref": "Subscription" }, "id": "health.projects.subscribers.subscriptions.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise." }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to update." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "health.projects.subscribers.subscriptions.list", "parameters": { "parent": { "description": "Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise.", "type": "string", "pattern": "^projects/[^/]+/subscribers/[^/]+$", "location": "path", "required": true }, "filter": { "description": "Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields: - `user` - `data_type` The `user` identifier (e.g., `user1` in `users/user1`) refers to the public `health_user_id` Example: user = \"users/user1\" Example: user = \"users/user1\" OR user = \"users/user2\" Example: user = \"users/user1\" AND (data_type = \"sleep\" OR data_type = \"weight\")", "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token." }, "pageSize": { "description": "Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.", "path": "v4/{+parent}/subscriptions", "response": { "$ref": "ListSubscriptionsResponse" }, "flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions", "httpMethod": "GET" } } } } } } }, "users": { "methods": { "updateProfile": { "flatPath": "v4/users/{usersId}/profile", "httpMethod": "PATCH", "request": { "$ref": "Profile" }, "path": "v4/{+name}", "response": { "$ref": "Profile" }, "parameterOrder": [ "name" ], "description": "Updates the user's profile details.", "id": "health.users.updateProfile", "parameters": { "name": { "pattern": "^users/[^/]+/profile$", "location": "path", "required": true, "type": "string", "description": "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." }, "updateMask": { "description": "Optional. The list of fields to be updated.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.profile.writeonly" ] }, "getProfile": { "path": "v4/{+name}", "response": { "$ref": "Profile" }, "parameterOrder": [ "name" ], "description": "Returns user Profile details.", "id": "health.users.getProfile", "parameters": { "name": { "type": "string", "pattern": "^users/[^/]+/profile$", "location": "path", "required": true, "description": "Required. The name of the Profile. Format: `users/me/profile`." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.profile.readonly" ], "flatPath": "v4/users/{usersId}/profile", "httpMethod": "GET" }, "getSettings": { "flatPath": "v4/users/{usersId}/settings", "httpMethod": "GET", "id": "health.users.getSettings", "parameters": { "name": { "description": "Required. The name of the Settings. Format: `users/me/settings`.", "pattern": "^users/[^/]+/settings$", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.settings.readonly" ], "path": "v4/{+name}", "response": { "$ref": "Settings" }, "parameterOrder": [ "name" ], "description": "Returns user settings details." }, "getIrnProfile": { "flatPath": "v4/users/{usersId}/irnProfile", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Returns user's IRN Profile details.", "path": "v4/{+name}", "response": { "$ref": "IrnProfile" }, "id": "health.users.getIrnProfile", "parameters": { "name": { "description": "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.", "type": "string", "pattern": "^users/[^/]+/irnProfile$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.irn.readonly" ] }, "updateSettings": { "flatPath": "v4/users/{usersId}/settings", "httpMethod": "PATCH", "path": "v4/{+name}", "response": { "$ref": "Settings" }, "parameterOrder": [ "name" ], "description": "Updates the user's settings details.", "request": { "$ref": "Settings" }, "id": "health.users.updateSettings", "parameters": { "name": { "pattern": "^users/[^/]+/settings$", "location": "path", "required": true, "type": "string", "description": "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." }, "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Optional. The list of fields to be updated." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.settings.writeonly" ] }, "getIdentity": { "id": "health.users.getIdentity", "parameters": { "name": { "description": "Required. The resource name of the Identity. Format: `users/me/identity`", "type": "string", "pattern": "^users/[^/]+/identity$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.profile.readonly", "https://www.googleapis.com/auth/googlehealth.settings.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ], "parameterOrder": [ "name" ], "description": "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.", "path": "v4/{+name}", "response": { "$ref": "Identity" }, "flatPath": "v4/users/{usersId}/identity", "httpMethod": "GET" } }, "resources": { "pairedDevices": { "methods": { "get": { "flatPath": "v4/users/{usersId}/pairedDevices/{pairedDevicesId}", "httpMethod": "GET", "path": "v4/{+name}", "response": { "$ref": "PairedDevice" }, "parameterOrder": [ "name" ], "description": "Returns user's Device.", "id": "health.users.pairedDevices.get", "parameters": { "name": { "description": "Required. The name of the device to retrieve. Format: users/{user}/devices/{device}", "pattern": "^users/[^/]+/pairedDevices/[^/]+$", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.settings.readonly" ] }, "list": { "flatPath": "v4/users/{usersId}/pairedDevices", "httpMethod": "GET", "id": "health.users.pairedDevices.list", "parameters": { "pageSize": { "description": "Optional. The maximum number of devices to return. The service may return fewer than this value. If unspecified, at most 5 devices will be returned. The maximum value is 100. values above 100 will be coerced to 100.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "description": "Required. The parent, which owns this collection of devices. Format: users/{user}", "pattern": "^users/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListPairedDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPairedDevices` must match the call that provided the page token." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.settings.readonly" ], "path": "v4/{+parent}/pairedDevices", "response": { "$ref": "ListPairedDevicesResponse" }, "parameterOrder": [ "parent" ], "description": "Returns the user's list of paired 1P trackers and smartwatches." } } }, "dataTypes": { "resources": { "dataPoints": { "methods": { "list": { "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints", "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Query user health and fitness data points.", "path": "v4/{+parent}/dataPoints", "response": { "$ref": "ListDataPointsResponse" }, "id": "health.users.dataTypes.dataPoints.list", "parameters": { "parent": { "type": "string", "pattern": "^users/[^/]+/dataTypes/[^/]+$", "location": "path", "required": true, "description": "Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field." }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The `next_page_token` from a previous request, if any." }, "filter": { "description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `\u003e=`, `\u003c` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time \u003e= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time \u003c \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time \u003e= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `\u003e=`, `\u003c` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time \u003e= \"2023-11-24\" AND steps.interval.civil_start_time \u003c \"2023-11-25\"` - `distance.interval.civil_start_time \u003e= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `\u003e=`, `\u003c` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time \u003e= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time \u003c \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time \u003e= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `\u003e=`, `\u003c` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time \u003e= \"2023-11-24\" AND weight.sample_time.civil_time \u003c \"2023-11-25\"` - `weight.sample_time.civil_time \u003e= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `\u003e=`, `\u003c` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date \u003c \"2024-08-15\"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `\u003e=`, `\u003c` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time \u003e= \"2023-11-24\" AND exercise.interval.civil_start_time \u003c \"2023-11-25\"` - `exercise.interval.civil_start_time \u003e= \"2024-08-14T12:34:56\"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `\u003e=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time \u003e= \"2024-08-14T12:34:56Z\"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `\u003e=`, `\u003c` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time \u003e= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time \u003c \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `\u003e=`, `\u003c` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time \u003e= \"2023-11-24\" AND sleep.interval.civil_end_time \u003c \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.", "type": "integer", "location": "query", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ] }, "dailyRollUp": { "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:dailyRollUp", "httpMethod": "POST", "path": "v4/{+parent}/dataPoints:dailyRollUp", "response": { "$ref": "DailyRollUpDataPointsResponse" }, "parameterOrder": [ "parent" ], "description": "Roll up data points over civil time intervals for supported data types.", "request": { "$ref": "DailyRollUpDataPointsRequest" }, "id": "health.users.dataTypes.dataPoints.dailyRollUp", "parameters": { "parent": { "type": "string", "pattern": "^users/[^/]+/dataTypes/[^/]+$", "location": "path", "required": true, "description": "Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the DailyRollupDataPoint value union field." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ] }, "patch": { "path": "v4/{+name}", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "description": "Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.", "request": { "$ref": "DataPoint" }, "id": "health.users.dataTypes.dataPoints.patch", "parameters": { "name": { "type": "string", "pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", "location": "path", "required": true, "description": "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_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_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." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ], "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}", "httpMethod": "PATCH" }, "rollUp": { "path": "v4/{+parent}/dataPoints:rollUp", "response": { "$ref": "RollUpDataPointsResponse" }, "parameterOrder": [ "parent" ], "description": "Roll up data points over physical time intervals for supported data types.", "request": { "$ref": "RollUpDataPointsRequest" }, "id": "health.users.dataTypes.dataPoints.rollUp", "parameters": { "parent": { "description": "Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the RollupDataPoint value union field.", "pattern": "^users/[^/]+/dataTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ], "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:rollUp", "httpMethod": "POST" }, "batchDelete": { "parameterOrder": [ "parent" ], "description": "Delete a batch of identifyable data points.", "path": "v4/{+parent}/dataPoints:batchDelete", "response": { "$ref": "Operation" }, "request": { "$ref": "BatchDeleteDataPointsRequest" }, "id": "health.users.dataTypes.dataPoints.batchDelete", "parameters": { "parent": { "type": "string", "pattern": "^users/[^/]+/dataTypes/[^/]+$", "location": "path", "required": true, "description": "Optional. Parent (data type) for the Data Point collection Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/-` For a list of the supported data types see the DataPoint data union field. Deleting data points across multiple data type collections is supported following https://aip.dev/159. If this is set, the parent of all of the data points specified in `names` must match this field." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ], "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:batchDelete", "httpMethod": "POST" }, "get": { "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Get a single identifyable data point.", "path": "v4/{+name}", "response": { "$ref": "DataPoint" }, "id": "health.users.dataTypes.dataPoints.get", "parameters": { "name": { "pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the data point to retrieve. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` See DataPoint.name for examples and possible values." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ] }, "create": { "parameterOrder": [ "parent" ], "description": "Creates a single identifiable data point.", "path": "v4/{+parent}/dataPoints", "response": { "$ref": "Operation" }, "request": { "$ref": "DataPoint" }, "id": "health.users.dataTypes.dataPoints.create", "parameters": { "parent": { "type": "string", "pattern": "^users/[^/]+/dataTypes/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource name where the data point will be created. Format: `users/{user}/dataTypes/{data_type}`" } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ], "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints", "httpMethod": "POST" }, "reconcile": { "id": "health.users.dataTypes.dataPoints.reconcile", "parameters": { "dataSourceFamily": { "location": "query", "type": "string", "description": "Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources" }, "parent": { "pattern": "^users/[^/]+/dataTypes/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/heart-rate` For a list of the supported data types see the DataPoint data union field." }, "filter": { "description": "Optional. Filter expression based on https://aip.dev/160. A time range, either physical or civil, can be specified. See the ListDataPointsRequest.filter for the supported fields and syntax.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The `next_page_token` from a previous request, if any." } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ], "path": "v4/{+parent}/dataPoints:reconcile", "response": { "$ref": "ReconcileDataPointsResponse" }, "parameterOrder": [ "parent" ], "description": "Reconcile data points from multiple data sources into a single data stream.", "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:reconcile", "httpMethod": "GET" }, "exportExerciseTcx": { "id": "health.users.dataTypes.dataPoints.exportExerciseTcx", "parameters": { "partialData": { "description": "Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.", "type": "boolean", "location": "query" }, "name": { "description": "Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `\"me\"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer.", "type": "string", "pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly" ], "parameterOrder": [ "name" ], "description": "Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.", "path": "v4/{+name}:exportExerciseTcx", "useMediaDownloadService": true, "response": { "$ref": "ExportExerciseTcxResponse" }, "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}:exportExerciseTcx", "httpMethod": "GET", "supportsMediaDownload": true } } } } } } } }, "fullyEncodeReservedExpansion": true, "revision": "20260620", "mtlsRootUrl": "https://health.mtls.googleapis.com/", "name": "health", "batchPath": "batch", "title": "Google Health API", "ownerName": "Google", "documentationLink": "https://developers.google.com/health", "schemas": { "HeartRateMetadata": { "type": "object", "description": "Heart rate metadata.", "id": "HeartRateMetadata", "properties": { "motionContext": { "type": "string", "enum": [ "MOTION_CONTEXT_UNSPECIFIED", "ACTIVE", "SEDENTARY" ], "description": "Optional. Indicates the user’s level of activity when the heart rate sample was measured", "enumDescriptions": [ "The default value when no data is available.", "The user is active.", "The user is inactive." ] }, "sensorLocation": { "description": "Optional. Indicates the location of the sensor that measured the heart rate.", "enumDescriptions": [ "The default value when no data is available.", "Chest sensor.", "Wrist sensor.", "Finger sensor.", "Hand sensor.", "Ear lobe sensor.", "Foot sensor." ], "enum": [ "SENSOR_LOCATION_UNSPECIFIED", "CHEST", "WRIST", "FINGER", "HAND", "EAR_LOBE", "FOOT" ], "type": "string" } } }, "DailyRollupDataPoint": { "description": "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.", "id": "DailyRollupDataPoint", "properties": { "activeZoneMinutes": { "$ref": "ActiveZoneMinutesRollupValue", "description": "Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier." }, "floors": { "$ref": "FloorsRollupValue", "description": "Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier." }, "nutritionLog": { "$ref": "NutritionLogRollupValue", "description": "Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier." }, "heartRateVariabilityPersonalRange": { "$ref": "HeartRateVariabilityPersonalRangeRollupValue", "description": "Returned by default when rolling up data points from the `daily-heart-rate-variability` data type, or when requested explicitly using the `heart-rate-variability-personal-range` rollup type identifier." }, "steps": { "description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier.", "$ref": "StepsRollupValue" }, "activityLevel": { "description": "Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier.", "$ref": "ActivityLevelRollupValue" }, "weight": { "description": "Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier.", "$ref": "WeightRollupValue" }, "civilEndTime": { "description": "End time of the window this value aggregates over", "$ref": "CivilDateTime" }, "bloodGlucose": { "$ref": "BloodGlucoseRollupValue", "description": "Returned by default when rolling up data points from the `blood-glucose` data type." }, "heartRate": { "$ref": "HeartRateRollupValue", "description": "Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier." }, "runVo2Max": { "$ref": "RunVO2MaxRollupValue", "description": "Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier." }, "activeEnergyBurned": { "description": "Returned by default when rolling up data points from the `active-energy-burned` data type.", "$ref": "ActiveEnergyBurnedRollupValue" }, "hydrationLog": { "description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier.", "$ref": "HydrationLogRollupValue" }, "civilStartTime": { "$ref": "CivilDateTime", "description": "Start time of the window this value aggregates over" }, "bodyFat": { "$ref": "BodyFatRollupValue", "description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier." }, "coreBodyTemperature": { "description": "Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier.", "$ref": "CoreBodyTemperatureRollupValue" }, "activeMinutes": { "$ref": "ActiveMinutesRollupValue", "description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier." }, "sedentaryPeriod": { "description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier.", "$ref": "SedentaryPeriodRollupValue" }, "swimLengthsData": { "description": "Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier.", "$ref": "SwimLengthsDataRollupValue" }, "restingHeartRatePersonalRange": { "$ref": "RestingHeartRatePersonalRangeRollupValue", "description": "Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier." }, "distance": { "description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.", "$ref": "DistanceRollupValue" }, "totalCalories": { "$ref": "TotalCaloriesRollupValue", "description": "Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier." }, "timeInHeartRateZone": { "description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier.", "$ref": "TimeInHeartRateZoneRollupValue" }, "altitude": { "description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.", "$ref": "AltitudeRollupValue" }, "caloriesInHeartRateZone": { "$ref": "CaloriesInHeartRateZoneRollupValue", "description": "Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier." } }, "type": "object" }, "ActiveMinutes": { "type": "object", "description": "Record of active minutes in a given time interval.", "id": "ActiveMinutes", "properties": { "interval": { "description": "Required. Observed interval.", "$ref": "ObservationTimeInterval" }, "activeMinutesByActivityLevel": { "description": "Required. Active minutes by activity level. At most one record per activity level is allowed.", "type": "array", "items": { "$ref": "ActiveMinutesByActivityLevel" } } } }, "SleepStage": { "id": "SleepStage", "properties": { "startTime": { "description": "Required. Sleep stage start time.", "type": "string", "format": "google-datetime" }, "endUtcOffset": { "type": "string", "format": "google-duration", "description": "Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC)." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Creation time of this sleep stages segment.", "readOnly": true }, "startUtcOffset": { "type": "string", "format": "google-duration", "description": "Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC)." }, "endTime": { "format": "google-datetime", "type": "string", "description": "Required. Sleep stage end time." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Last update time of this sleep stages segment.", "readOnly": true }, "type": { "type": "string", "enum": [ "SLEEP_STAGE_TYPE_UNSPECIFIED", "AWAKE", "LIGHT", "DEEP", "REM", "ASLEEP", "RESTLESS" ], "description": "Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.", "enumDescriptions": [ "The default unset value.", "Sleep stage AWAKE.", "Sleep stage LIGHT.", "Sleep stage DEEP.", "Sleep stage REM.", "Sleep stage ASLEEP.", "Sleep stage RESTLESS." ] } }, "description": "Sleep stage segment.", "type": "object" }, "Sleep": { "description": "A sleep session possibly including stages.", "id": "Sleep", "properties": { "outOfBedSegments": { "type": "array", "items": { "$ref": "OutOfBedSegment" }, "description": "Optional. “Out of bed” segments that can overlap with sleep stages." }, "createTime": { "description": "Output only. Creation time of this sleep observation.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Last update time of this sleep observation.", "readOnly": true }, "summary": { "$ref": "SleepSummary", "description": "Output only. Sleep summary: metrics and stages summary.", "readOnly": true }, "metadata": { "$ref": "SleepMetadata", "description": "Optional. Sleep metadata: processing, main, manually edited, stages status." }, "interval": { "description": "Required. Observed sleep interval.", "$ref": "SessionTimeInterval" }, "type": { "description": "Optional. SleepType: classic or stages.", "enumDescriptions": [ "Sleep type is unspecified.", "Classic sleep is a sleep with 3 stages types: AWAKE, RESTLESS and ASLEEP.", "On top of \"classic\" sleep stages an additional processing pass can calculate stages more precisely, overwriting the prior stages with AWAKE, LIGHT, REM and DEEP." ], "type": "string", "enum": [ "SLEEP_TYPE_UNSPECIFIED", "CLASSIC", "STAGES" ] }, "stages": { "description": "Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.", "type": "array", "items": { "$ref": "SleepStage" } } }, "type": "object" }, "DailyVO2Max": { "type": "object", "description": "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.", "id": "DailyVO2Max", "properties": { "date": { "$ref": "Date", "description": "Required. The date for which the Daily VO2 max was measured." }, "estimated": { "description": "Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.", "type": "boolean" }, "vo2Max": { "description": "Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.", "type": "number", "format": "double" }, "cardioFitnessLevel": { "description": "Optional. Represents the user's cardio fitness level based on their VO2 max.", "enumDescriptions": [ "Unspecified cardio fitness level.", "Poor cardio fitness level.", "Fair cardio fitness level.", "Average cardio fitness level.", "Good cardio fitness level.", "Very good cardio fitness level.", "Excellent cardio fitness level." ], "type": "string", "enum": [ "CARDIO_FITNESS_LEVEL_UNSPECIFIED", "POOR", "FAIR", "AVERAGE", "GOOD", "VERY_GOOD", "EXCELLENT" ] }, "vo2MaxCovariance": { "description": "Optional. The covariance of the VO2 max value.", "format": "double", "type": "number" } } }, "ActivityLevelRollupValue": { "type": "object", "description": "Represents the result of the rollup of the activity level data type.", "id": "ActivityLevelRollupValue", "properties": { "activityLevelRollupsByActivityLevelType": { "description": "List of total durations in each activity level type.", "type": "array", "items": { "$ref": "ActivityLevelRollupByActivityLevelType" } } } }, "RollupDataPoint": { "type": "object", "id": "RollupDataPoint", "properties": { "heartRate": { "$ref": "HeartRateRollupValue", "description": "Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier." }, "bloodGlucose": { "description": "Returned by default when rolling up data points from the `blood-glucose` data type.", "$ref": "BloodGlucoseRollupValue" }, "startTime": { "format": "google-datetime", "type": "string", "description": "Start time of the window this value aggregates over" }, "weight": { "$ref": "WeightRollupValue", "description": "Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier." }, "altitude": { "description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.", "$ref": "AltitudeRollupValue" }, "caloriesInHeartRateZone": { "description": "Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier.", "$ref": "CaloriesInHeartRateZoneRollupValue" }, "activeEnergyBurned": { "$ref": "ActiveEnergyBurnedRollupValue", "description": "Returned by default when rolling up data points from the `active-energy-burned` data type." }, "distance": { "description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.", "$ref": "DistanceRollupValue" }, "totalCalories": { "$ref": "TotalCaloriesRollupValue", "description": "Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier." }, "runVo2Max": { "description": "Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier.", "$ref": "RunVO2MaxRollupValue" }, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZoneRollupValue", "description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier." }, "bodyFat": { "description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier.", "$ref": "BodyFatRollupValue" }, "coreBodyTemperature": { "description": "Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier.", "$ref": "CoreBodyTemperatureRollupValue" }, "hydrationLog": { "$ref": "HydrationLogRollupValue", "description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier." }, "activeZoneMinutes": { "description": "Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier.", "$ref": "ActiveZoneMinutesRollupValue" }, "sedentaryPeriod": { "$ref": "SedentaryPeriodRollupValue", "description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier." }, "activityLevel": { "$ref": "ActivityLevelRollupValue", "description": "Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier." }, "swimLengthsData": { "$ref": "SwimLengthsDataRollupValue", "description": "Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier." }, "steps": { "$ref": "StepsRollupValue", "description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." }, "activeMinutes": { "description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier.", "$ref": "ActiveMinutesRollupValue" }, "floors": { "description": "Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier.", "$ref": "FloorsRollupValue" }, "nutritionLog": { "description": "Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier.", "$ref": "NutritionLogRollupValue" }, "endTime": { "format": "google-datetime", "type": "string", "description": "End time of the window this value aggregates over" } }, "description": "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." }, "Empty": { "description": "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); }", "id": "Empty", "properties": {}, "type": "object" }, "BloodGlucose": { "type": "object", "description": "Represents a blood glucose level measurement. LINT: LEGACY_NAMES", "id": "BloodGlucose", "properties": { "sampleTime": { "description": "Required. The time at which blood glucose was measured.", "$ref": "ObservationSampleTime" }, "mealType": { "description": "Optional. Meal type of the measurement.", "enumDescriptions": [ "Unspecified meal type.", "Breakfast.", "Lunch.", "Dinner.", "Snack." ], "enum": [ "MEAL_TYPE_UNSPECIFIED", "BREAKFAST", "LUNCH", "DINNER", "SNACK" ], "type": "string" }, "measurementTiming": { "type": "string", "enum": [ "MEASUREMENT_TIMING_UNSPECIFIED", "AFTER_MEAL", "BEFORE_MEAL", "FASTING", "GENERAL", "BEFORE_BED", "OVER_NIGHT" ], "description": "Optional. Timing of the measurement.", "enumDescriptions": [ "Unspecified measurement timing.", "Measurement taken after meal.", "Measurement taken before meal.", "Measurement taken while fasting.", "General measurement (not associated with a meal or time of day).", "Measurement taken before bed.", "Measurement taken over night." ] }, "specimen": { "enum": [ "SPECIMEN_UNSPECIFIED", "CAPILLARY_BLOOD", "INTERSTITIAL_FLUID", "PLASMA", "SERUM", "TEARS", "WHOLE_BLOOD" ], "type": "string", "description": "Optional. Type of body fluid used to measure the blood glucose.", "enumDescriptions": [ "Unspecified specimen.", "Capillary blood.", "Interstitial fluid.", "Plasma.", "Serum.", "Tears.", "Whole blood." ] }, "bloodGlucoseMilligramsPerDeciliter": { "type": "number", "format": "double", "description": "Required. Blood glucose level concentration in mg/dL." }, "measurementSource": { "description": "Optional. Source of the measurement.", "enumDescriptions": [ "Unspecified measurement source.", "Self-monitoring of blood glucose (Blood glucose meter)", "Continuous glucose monitoring device", "Laboratory test" ], "enum": [ "MEASUREMENT_SOURCE_UNSPECIFIED", "SELF_MONITORING_BLOOD_GLUCOSE", "CONTINUOUS_GLUCOSE_MONITORING", "LAB_TEST" ], "type": "string" }, "notes": { "description": "Optional. Standard free-form notes captured at manual logging.", "type": "string" } } }, "ActiveMinutesRollupValue": { "id": "ActiveMinutesRollupValue", "properties": { "activeMinutesRollupByActivityLevel": { "description": "Active minutes by activity level. At most one record per activity level is allowed.", "type": "array", "items": { "$ref": "ActiveMinutesRollupByActivityLevel" } } }, "description": "Represents the result of the rollup of the active minutes data type.", "type": "object" }, "ListPairedDevicesResponse": { "id": "ListPairedDevicesResponse", "properties": { "pairedDevices": { "type": "array", "items": { "$ref": "PairedDevice" }, "description": "The paired devices of the user." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for ListPairedDevices.", "type": "object" }, "DataPoint": { "type": "object", "description": "A computed or recorded metric.", "id": "DataPoint", "properties": { "steps": { "description": "Optional. Data for points in the `steps` interval data type collection.", "$ref": "Steps" }, "activityLevel": { "description": "Optional. Data for points in the `activity-level` daily data type collection.", "$ref": "ActivityLevel" }, "dailyRespiratoryRate": { "description": "Optional. Data for points in the `daily-respiratory-rate` daily data type collection.", "$ref": "DailyRespiratoryRate" }, "floors": { "description": "Optional. Data for points in the `floors` interval data type collection.", "$ref": "Floors" }, "nutritionLog": { "$ref": "NutritionLog", "description": "Optional. Data for points in the `nutrition-log` session data type collection." }, "dataSource": { "description": "Optional. Data source information for the metric", "$ref": "DataSource" }, "activeZoneMinutes": { "$ref": "ActiveZoneMinutes", "description": "Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes." }, "dailyHeartRateZones": { "$ref": "DailyHeartRateZones", "description": "Optional. Data for points in the `daily-heart-rate-zones` daily data type collection." }, "activeEnergyBurned": { "$ref": "ActiveEnergyBurned", "description": "Optional. Data for points in the `active-energy-burned` interval data type collection." }, "heartRateVariability": { "$ref": "HeartRateVariability", "description": "Optional. Data for points in the `heart-rate-variability` sample data type collection." }, "runVo2Max": { "$ref": "RunVO2Max", "description": "Optional. Data for points in the `run-vo2-max` sample data type collection." }, "bloodGlucose": { "$ref": "BloodGlucose", "description": "Optional. Data for points in the `blood-glucose` sample data type collection." }, "heartRate": { "$ref": "HeartRate", "description": "Optional. Data for points in the `heart-rate` sample data type collection." }, "oxygenSaturation": { "description": "Optional. Data for points in the `oxygen-saturation` sample data type collection.", "$ref": "OxygenSaturation" }, "weight": { "description": "Optional. Data for points in the `weight` sample data type collection.", "$ref": "Weight" }, "foodMeasurementUnit": { "$ref": "FoodMeasurementUnit", "description": "Optional. The food measurement unit details." }, "irregularRhythmNotification": { "description": "Optional. Data for points in the `irregular-rhythm-notification` session data type collection.", "$ref": "IrregularRhythmNotification" }, "dailyOxygenSaturation": { "description": "Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.", "$ref": "DailyOxygenSaturation" }, "activeMinutes": { "description": "Optional. Data for points in the `active-minutes` interval data type collection.", "$ref": "ActiveMinutes" }, "respiratoryRateSleepSummary": { "$ref": "RespiratoryRateSleepSummary", "description": "Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection." }, "sedentaryPeriod": { "description": "Optional. Data for points in the `sedentary-period` interval data type collection.", "$ref": "SedentaryPeriod" }, "swimLengthsData": { "description": "Optional. Data for points in the `swim-lengths-data` interval data type collection.", "$ref": "SwimLengthsData" }, "dailyRestingHeartRate": { "description": "Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.", "$ref": "DailyRestingHeartRate" }, "bodyFat": { "description": "Optional. Data for points in the `body-fat` sample data type collection.", "$ref": "BodyFat" }, "coreBodyTemperature": { "description": "Optional. Data for points in the `core-body-temperature` sample data type collection.", "$ref": "CoreBodyTemperature" }, "name": { "description": "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_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_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.", "type": "string" }, "sleep": { "description": "Optional. Data for points in the `sleep` session data type collection.", "$ref": "Sleep" }, "exercise": { "description": "Optional. Data for points in the `exercise` session data type collection.", "$ref": "Exercise" }, "electrocardiogram": { "description": "Optional. Data for points in the `electrocardiogram` session data type collection.", "$ref": "Electrocardiogram" }, "hydrationLog": { "$ref": "HydrationLog", "description": "Optional. Data for points in the `hydration-log` session data type collection." }, "vo2Max": { "description": "Optional. Data for points in the `vo2-max` sample data type collection.", "$ref": "VO2Max" }, "altitude": { "description": "Optional. Data for points in the `altitude` interval data type collection.", "$ref": "Altitude" }, "timeInHeartRateZone": { "description": "Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection.", "$ref": "TimeInHeartRateZone" }, "height": { "description": "Optional. Data for points in the `height` sample data type collection.", "$ref": "Height" }, "dailySleepTemperatureDerivations": { "description": "Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.", "$ref": "DailySleepTemperatureDerivations" }, "distance": { "$ref": "Distance", "description": "Optional. Data for points in the `distance` interval data type collection." }, "basalEnergyBurned": { "description": "Optional. Data for points in the `basal-energy-burned` interval data type collection.", "$ref": "BasalEnergyBurned" }, "food": { "$ref": "Food", "description": "Optional. The food details." }, "dailyHeartRateVariability": { "$ref": "DailyHeartRateVariability", "description": "Optional. Data for points in the `daily-heart-rate-variability` daily data type collection." }, "dailyVo2Max": { "$ref": "DailyVO2Max", "description": "Optional. Data for points in the `daily-vo2-max` daily data type collection." } } }, "FoodMeasurementUnit": { "description": "Represents a food measurement unit.", "id": "FoodMeasurementUnit", "properties": { "displayName": { "description": "Required. The display name of the food measurement unit (e.g., \"gram\", \"piece\").", "type": "string" }, "pluralDisplayName": { "description": "Optional. The plural display name of the food measurement unit (e.g., \"grams\", \"pieces\").", "type": "string" } }, "type": "object" }, "EnergyQuantity": { "description": "Represents the energy quantity.", "id": "EnergyQuantity", "properties": { "kcal": { "description": "Required. Value representing the energy in kilocalories.", "format": "double", "type": "number" }, "userProvidedUnit": { "description": "Optional. Value representing the user provided unit.", "enumDescriptions": [ "Unspecified energy unit.", "Value representing joule.", "Value representing kilojoule.", "Value representing kilocalorie.", "Value representing small calorie.", "Value representing calorie." ], "type": "string", "enum": [ "ENERGY_UNIT_UNSPECIFIED", "JOULE", "KILOJOULE", "KILOCALORIE", "SMALL_CALORIE", "CALORIE" ] } }, "type": "object" }, "GoogleDevicesandservicesHealthV4User": { "type": "object", "id": "GoogleDevicesandservicesHealthV4User", "properties": { "name": { "description": "Identifier. The resource name of the user. The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. Format: `users/{user}`", "type": "string" } }, "description": "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." }, "DailyRespiratoryRate": { "type": "object", "description": "A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep.", "id": "DailyRespiratoryRate", "properties": { "date": { "description": "Required. The date on which the respiratory rate was measured.", "$ref": "Date" }, "breathsPerMinute": { "description": "Required. The average number of breaths taken per minute.", "format": "double", "type": "number" } } }, "Application": { "type": "object", "id": "Application", "properties": { "googleWebClientId": { "description": "Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.", "readOnly": true, "type": "string" }, "packageName": { "description": "Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.", "readOnly": true, "type": "string" }, "webClientId": { "description": "Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.", "readOnly": true, "type": "string" } }, "description": "Optional metadata for the application that provided this data." }, "SessionTimeInterval": { "id": "SessionTimeInterval", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Required. The start time of the observed session." }, "startUtcOffset": { "format": "google-duration", "type": "string", "description": "Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC)." }, "endTime": { "type": "string", "format": "google-datetime", "description": "Required. The end time of the observed session." }, "civilEndTime": { "$ref": "CivilDateTime", "description": "Output only. Session end time in civil time in the timezone the subject is in at the end of the session.", "readOnly": true }, "endUtcOffset": { "description": "Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).", "format": "google-duration", "type": "string" }, "civilStartTime": { "$ref": "CivilDateTime", "description": "Output only. Session start time in civil time in the timezone the subject is in at the start of the session.", "readOnly": true } }, "description": "Represents a time interval of session data point, which bundles multiple observed metrics together.", "type": "object" }, "ActivityLevel": { "id": "ActivityLevel", "properties": { "interval": { "description": "Required. Observed interval.", "$ref": "ObservationTimeInterval" }, "activityLevelType": { "type": "string", "enum": [ "ACTIVITY_LEVEL_TYPE_UNSPECIFIED", "SEDENTARY", "LIGHTLY_ACTIVE", "MODERATELY_ACTIVE", "VERY_ACTIVE" ], "description": "Required. Activity level type in the given time interval.", "enumDescriptions": [ "Unspecified activity level type.", "Sedentary activity level.", "Lightly active activity level.", "Moderately active activity level.", "Very active activity level." ] } }, "description": "Internal type to capture activity level during a certain time interval.", "type": "object" }, "AlertWindow": { "type": "object", "id": "AlertWindow", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Required. Observed interval. The start time of the analysis window." }, "positive": { "description": "Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.", "type": "boolean" }, "endUtcOffset": { "format": "google-duration", "type": "string", "description": "Required. The UTC offset of the user's timezone when the analysis window ended." }, "startUtcOffset": { "description": "Required. The UTC offset of the user's timezone when the analysis window started.", "type": "string", "format": "google-duration" }, "endTime": { "description": "Required. The end time of the analysis window.", "type": "string", "format": "google-datetime" }, "civilEndTime": { "description": "Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval", "readOnly": true, "$ref": "CivilDateTime" }, "heartBeats": { "type": "array", "items": { "$ref": "HeartBeat" }, "description": "Optional. All heart beats in the interval contained in this analysis window." }, "civilStartTime": { "description": "Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval", "readOnly": true, "$ref": "CivilDateTime" } }, "description": "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)." }, "CivilTimeInterval": { "description": "Counterpart of google.type.Interval, but using CivilDateTime.", "id": "CivilTimeInterval", "properties": { "start": { "$ref": "CivilDateTime", "description": "Required. The inclusive start of the range." }, "end": { "$ref": "CivilDateTime", "description": "Required. The exclusive end of the range." } }, "type": "object" }, "GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog": { "type": "object", "description": "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.", "id": "GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog", "properties": { "httpResponse": { "$ref": "HttpResponse", "description": "Required. Represents the HTTP response. This message includes the status code, reason phrase, headers, and body." } } }, "BatchDeleteDataPointsRequest": { "type": "object", "id": "BatchDeleteDataPointsRequest", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "Required. The names of the DataPoints to delete. A maximum of 10000 data points can be deleted in a single request." } }, "description": "Request to delete a batch of identifiable data points." }, "TotalCaloriesRollupValue": { "id": "TotalCaloriesRollupValue", "properties": { "kcalSum": { "type": "number", "format": "double", "description": "Sum of the total calories in kilocalories." } }, "description": "Represents the result of the rollup of the user's total calories.", "type": "object" }, "Identity": { "type": "object", "description": "Represents details about the Google user's identity.", "id": "Identity", "properties": { "legacyUserId": { "description": "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.", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The resource name of this Identity resource. Format: `users/me/identity`", "type": "string" }, "healthUserId": { "description": "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.", "readOnly": true, "type": "string" } } }, "EndpointAuthorization": { "description": "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.", "id": "EndpointAuthorization", "properties": { "secretSet": { "description": "Output only. Whether the secret is set.", "readOnly": true, "type": "boolean" }, "secret": { "description": "Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the \"Authorization\" header. The value must include the authorization scheme, e.g., \"Bearer \" or \"Basic \", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.", "type": "string" } }, "type": "object" }, "Steps": { "type": "object", "id": "Steps", "properties": { "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval." }, "count": { "format": "int64", "type": "string", "description": "Required. Number of steps in the recorded interval." } }, "description": "Step count over the time interval." }, "Serving": { "id": "Serving", "properties": { "amount": { "description": "Optional. Amount of food consumed, fractional values are supported.", "type": "number", "format": "double" }, "foodMeasurementUnitDisplayName": { "type": "string", "description": "Output only. Legacy measurement unit for serving size in singular form (e.g. \"piece\", \"gram\").", "readOnly": true }, "foodMeasurementUnit": { "description": "Required. Food measurement unit", "type": "string" } }, "description": "Represents different properties and information about the serving of a specific food.", "type": "object" }, "MobilityMetrics": { "type": "object", "id": "MobilityMetrics", "properties": { "avgCadenceStepsPerMinute": { "format": "double", "type": "number", "description": "Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout." }, "avgVerticalOscillationMillimeters": { "description": "Optional. Distance off the ground your center of mass moves with each stride while running", "format": "int64", "type": "string" }, "avgGroundContactTimeDuration": { "description": "Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride", "type": "string", "format": "google-duration" }, "avgVerticalRatio": { "type": "number", "format": "double", "description": "Optional. Vertical oscillation/stride length between [5.0, 11.0]." }, "avgStrideLengthMillimeters": { "description": "Optional. Stride length is a measure of the distance covered by a single stride", "format": "int64", "type": "string" } }, "description": "Mobility workouts specific metrics" }, "Distance": { "description": "Distance traveled over an interval of time.", "id": "Distance", "properties": { "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval." }, "millimeters": { "format": "int64", "type": "string", "description": "Required. Distance in millimeters over the observed interval." } }, "type": "object" }, "NutrientQuantity": { "type": "object", "description": "Represents the quantity of a nutrient.", "id": "NutrientQuantity", "properties": { "quantity": { "$ref": "WeightQuantity", "description": "Required. Value representing the quantity of the nutrient." }, "nutrient": { "enum": [ "NUTRIENT_UNSPECIFIED", "BIOTIN", "CAFFEINE", "CALCIUM", "CHLORIDE", "CARBOHYDRATES", "CHOLESTEROL", "CHROMIUM", "COPPER", "DIETARY_FIBER", "FOLIC_ACID", "IODINE", "IRON", "MAGNESIUM", "MANGANESE", "MOLYBDENUM", "MONOUNSATURATED_FAT", "NIACIN", "PANTOTHENIC_ACID", "PHOSPHORUS", "POLYUNSATURATED_FAT", "POTASSIUM", "PROTEIN", "RIBOFLAVIN", "SATURATED_FAT", "SELENIUM", "SODIUM", "SUGAR", "THIAMIN", "TRANS_FAT", "UNSATURATED_FAT", "VITAMIN_A", "VITAMIN_B12", "VITAMIN_B6", "VITAMIN_C", "VITAMIN_D", "VITAMIN_E", "VITAMIN_K", "ZINC", "FOLATE" ], "type": "string", "description": "Required. Value representing the nutrient.", "enumDescriptions": [ "Unspecified nutrient.", "Value representing biotin nutrient.", "Value representing caffeine nutrient.", "Value representing calcium nutrient.", "Value representing chloride nutrient.", "Value representing carbohydrates nutrient.", "Value representing cholesterol nutrient.", "Value representing chromium nutrient.", "Value representing copper nutrient.", "Value representing dietary fiber nutrient.", "Value representing folic acid nutrient.", "Value representing iodine nutrient.", "Value representing iron nutrient.", "Value representing magnesium nutrient.", "Value representing manganese nutrient.", "Value representing molybdenum nutrient.", "Value representing monounsaturated fat nutrient.", "Value representing niacin nutrient.", "Value representing pantothenic acid nutrient.", "Value representing phosphorus nutrient.", "Value representing polyunsaturated fat nutrient.", "Value representing potassium nutrient.", "Value representing protein nutrient.", "Value representing riboflavin nutrient.", "Value representing saturated fat nutrient.", "Value representing selenium nutrient.", "Value representing sodium nutrient.", "Value representing sugar nutrient.", "Value representing thiamin nutrient.", "Value representing trans fat nutrient.", "Value representing unsaturated fat nutrient.", "Value representing vitamin A nutrient.", "Value representing vitamin B12 nutrient.", "Value representing vitamin B6 nutrient.", "Value representing vitamin C nutrient.", "Value representing vitamin D nutrient.", "Value representing vitamin E nutrient.", "Value representing vitamin K nutrient.", "Value representing zinc nutrient.", "Value representing folate nutrient." ] } } }, "RespiratoryRateSleepSummaryStatistics": { "type": "object", "description": "Respiratory rate statistics for a given sleep stage.", "id": "RespiratoryRateSleepSummaryStatistics", "properties": { "signalToNoise": { "format": "double", "type": "number", "description": "Optional. How trustworthy the data is for the computation." }, "breathsPerMinute": { "description": "Required. Average breaths per minute.", "type": "number", "format": "double" }, "standardDeviation": { "description": "Optional. Standard deviation of the respiratory rate during sleep.", "format": "double", "type": "number" } } }, "ExerciseEvent": { "type": "object", "description": "Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.", "id": "ExerciseEvent", "properties": { "exerciseEventType": { "enum": [ "EXERCISE_EVENT_TYPE_UNSPECIFIED", "START", "STOP", "PAUSE", "RESUME", "AUTO_PAUSE", "AUTO_RESUME" ], "type": "string", "description": "Required. The type of the event, such as start, stop, pause, resume.", "enumDescriptions": [ "Exercise event type is unspecified.", "Exercise start event.", "Exercise stop event.", "Exercise pause event.", "Exercise resume event.", "Exercise auto-pause event.", "Exercise auto-resume event." ] }, "eventTime": { "description": "Required. Exercise event time", "type": "string", "format": "google-datetime" }, "eventUtcOffset": { "type": "string", "format": "google-duration", "description": "Required. Exercise event time offset from UTC" } } }, "ReconcileDataPointsResponse": { "description": "Response containing the list of reconciled DataPoints.", "id": "ReconcileDataPointsResponse", "properties": { "dataPoints": { "description": "Data points matching the query", "type": "array", "items": { "$ref": "ReconciledDataPoint" } }, "nextPageToken": { "description": "Next page token, empty if the response is complete", "type": "string" } }, "type": "object" }, "AltitudeRollupValue": { "type": "object", "id": "AltitudeRollupValue", "properties": { "gainMillimetersSum": { "description": "Sum of the altitude gain in millimeters.", "format": "int64", "type": "string" } }, "description": "Represents the result of the rollup of the user's altitude." }, "DailyRestingHeartRateMetadata": { "id": "DailyRestingHeartRateMetadata", "properties": { "calculationMethod": { "type": "string", "enum": [ "CALCULATION_METHOD_UNSPECIFIED", "WITH_SLEEP", "ONLY_WITH_AWAKE_DATA" ], "description": "Required. The method used to calculate the resting heart rate.", "enumDescriptions": [ "The calculation method is unspecified.", "The resting heart rate is calculated using the sleep data.", "The resting heart rate is calculated using only awake data." ] } }, "description": "Metadata for the daily resting heart rate.", "type": "object" }, "ExerciseMetadata": { "id": "ExerciseMetadata", "properties": { "poolLengthMillimeters": { "description": "Optional. Pool length in millimeters. Only present in the swimming exercises.", "type": "string", "format": "int64" }, "hasGps": { "description": "Optional. Whether the exercise had GPS tracking.", "type": "boolean" } }, "description": "Additional exercise metadata.", "type": "object" }, "TimeInHeartRateZoneValue": { "id": "TimeInHeartRateZoneValue", "properties": { "heartRateZone": { "enum": [ "HEART_RATE_ZONE_TYPE_UNSPECIFIED", "LIGHT", "MODERATE", "VIGOROUS", "PEAK" ], "type": "string", "description": "The heart rate zone.", "enumDescriptions": [ "Unspecified heart rate zone.", "The light heart rate zone.", "The moderate heart rate zone.", "The vigorous heart rate zone.", "The peak heart rate zone." ] }, "duration": { "format": "google-duration", "type": "string", "description": "The total time spent in the specified heart rate zone." } }, "description": "Represents the total time spent in a specific heart rate zone.", "type": "object" }, "IrregularRhythmNotification": { "type": "object", "id": "IrregularRhythmNotification", "properties": { "interval": { "description": "Required. Observed interval.", "$ref": "SessionTimeInterval" }, "alertWindows": { "type": "array", "items": { "$ref": "AlertWindow" }, "description": "Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm." }, "medicalDeviceInfo": { "$ref": "MedicalDeviceInfo", "description": "Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.", "readOnly": true } }, "description": "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." }, "ExportExerciseTcxResponse": { "id": "ExportExerciseTcxResponse", "properties": { "tcxData": { "description": "Contains the exported TCX data. This field is intended for gRPC clients, as media download integration is not supported for gRPC. HTTP clients should instead use the `alt=media` query parameter to download the raw binary TCX file.", "type": "string" } }, "description": "Represents a Response for exporting exercise data in TCX format.", "type": "object" }, "Date": { "id": "Date", "properties": { "year": { "format": "int32", "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year." }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer", "format": "int32" }, "day": { "format": "int32", "type": "integer", "description": "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't significant." } }, "description": "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", "type": "object" }, "TimeInHeartRateZone": { "id": "TimeInHeartRateZone", "properties": { "heartRateZoneType": { "description": "Required. Heart rate zone type.", "enumDescriptions": [ "Unspecified heart rate zone.", "The light heart rate zone.", "The moderate heart rate zone.", "The vigorous heart rate zone.", "The peak heart rate zone." ], "type": "string", "enum": [ "HEART_RATE_ZONE_TYPE_UNSPECIFIED", "LIGHT", "MODERATE", "VIGOROUS", "PEAK" ] }, "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval." } }, "description": "Time in heart rate zone record. It's an interval spent in specific heart rate zone.", "type": "object" }, "TimeOfDay": { "type": "object", "id": "TimeOfDay", "properties": { "seconds": { "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "type": "integer", "format": "int32" }, "minutes": { "type": "integer", "format": "int32", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59." }, "hours": { "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "nanos": { "type": "integer", "format": "int32", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999." } }, "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`." }, "SleepSummary": { "description": " Sleep summary: metrics and stages summary.", "id": "SleepSummary", "properties": { "minutesToFallAsleep": { "format": "int64", "type": "string", "description": "Output only. Minutes to fall asleep calculated by restlessness algorithm.", "readOnly": true }, "minutesAsleep": { "type": "string", "format": "int64", "description": "Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For \"stages\" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).", "readOnly": true }, "stagesSummary": { "description": "Output only. List of summaries (total duration and segment count) per each sleep stage type.", "readOnly": true, "type": "array", "items": { "$ref": "StageSummary" } }, "minutesInSleepPeriod": { "format": "int64", "type": "string", "description": "Output only. Delta between wake time and bedtime. It is the sum of all stages.", "readOnly": true }, "minutesAfterWakeUp": { "description": "Output only. Minutes after wake up calculated by restlessness algorithm.", "readOnly": true, "format": "int64", "type": "string" }, "minutesAwake": { "description": "Output only. Total number of minutes awake. It is a sum of all AWAKE stages.", "readOnly": true, "format": "int64", "type": "string" } }, "type": "object" }, "OxygenSaturation": { "id": "OxygenSaturation", "properties": { "percentage": { "description": "Required. The oxygen saturation percentage. Valid values are from 0 to 100.", "type": "number", "format": "double" }, "sampleTime": { "$ref": "ObservationSampleTime", "description": "Required. The time at which oxygen saturation was measured." } }, "description": "Captures the user's instantaneous oxygen saturation percentage (SpO2).", "type": "object" }, "Status": { "type": "object", "description": "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](https://github.com/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](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } } }, "BloodGlucoseRollupValue": { "type": "object", "id": "BloodGlucoseRollupValue", "properties": { "bloodGlucoseMilligramsPerDeciliterAvg": { "format": "double", "type": "number", "description": "Average blood glucose level in mg/dL." } }, "description": "Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES" }, "Exercise": { "type": "object", "id": "Exercise", "properties": { "exerciseType": { "description": "Required. The type of activity performed during an exercise.", "enumDescriptions": [ "Exercise type is unspecified.", "Aerobic workout type.", "Archery type.", "Assault bike type.", "Backpacking type.", "Badminton type.", "Ballet type.", "Ballroom dance type.", "Barre class type.", "Baseball type.", "Basketball type.", "Biking type.", "Billiards type.", "Body weight type.", "Bootcamp type.", "Bowling type.", "Boxing type.", "Breakdancing type.", "Calisthenics type.", "Canoeing type.", "Cardio sculpt type.", "Cardio workout type.", "Carpentry type.", "Cheerleading type.", "Circuit training type.", "Cleaning type.", "Climbing type.", "Core training type.", "Cricket type.", "Croquet type.", "Cross country ski type.", "Cross training type.", "Crossfit type.", "Curling type.", "Dancing type.", "Diving type.", "Electric bike type.", "Electric scooter type.", "Elliptical type.", "Equestrian sports type.", "Exercise class type.", "Fencing type.", "Field hockey type.", "Fishing type.", "Fitness gaming type.", "Foiling type.", "Football american type.", "Football australian type.", "Free weights type.", "Frisbee playing general type.", "Functional strength training type.", "Gardening type.", "Golf type.", "Gymnastics type.", "Handball type.", "Hand cycling type.", "Hiit type.", "Hiking type.", "Hip hop type.", "Hockey type.", "Hoeing type.", "Household chores type.", "Hunting type.", "Ice skating type.", "Incline run type.", "Incline walk type.", "Indoor climbing type.", "Interval workout type.", "Jazz dance type.", "Jiu jitsu type.", "Jumping rope type.", "Karate type.", "Kayaking type.", "Kickboxing type.", "Kitesurfing type.", "Lacrosse type.", "Martial arts type.", "Meditate type.", "Modern dance type.", "Motocross type.", "Motorcycle type.", "Mountain bike type.", "Mowing lawn type.", "Muay thai type.", "Multisport type.", "Musical performance type.", "Nordic walking type.", "Orienteering type.", "Other type.", "Outdoor bike type.", "Outdoor workout type.", "Paddleboarding type.", "Padel type.", "Painting type.", "Paragliding type.", "Parkour type.", "Pickelball type.", "Pilates type.", "Polo type.", "Powerlifting type.", "Power walking type.", "Racket sports type.", "Racquetball type.", "Resistance bands type.", "Rock climbing type.", "Rollerblading type.", "Roller skating type.", "Rowing type.", "Rowing machine type.", "Rucking type.", "Rugby type.", "Running type.", "Sailing type.", "Scootering type.", "Scuba diving type.", "Shooting type.", "Shoveling type.", "Skateboarding type.", "Skating type.", "Skiing type.", "Skydiving type.", "Snorkeling type.", "Snowboarding type.", "Snowmobiling type.", "Snowshoeing type.", "Snow sport type.", "Soccer type.", "Softball type.", "Speed skating type.", "Spinning type.", "Sport type.", "Squash type.", "Stairclimber type.", "Stationary bike type.", "Step training type.", "Strength training type.", "Stretching type.", "Stroller walk type.", "Surfing type.", "Swimming type.", "Swimming open water type.", "Swimming pool type.", "Synchronized swimming type.", "Tabata workout type.", "Table tennis type.", "Taekwondo type.", "Tai chi type.", "Tango type.", "Tennis type.", "Track and field type.", "Trail run type.", "Trampoline type.", "Treadmill type.", "Treadmill walk type.", "Trx type.", "Ultimate frisbee type.", "Unicycling type.", "Volleyball type.", "Volleyball beach type.", "Wakeboarding type.", "Walking type.", "Walk with weights type.", "Water aerobics type.", "Water jogging type.", "Water polo type.", "Water skiing type.", "Water sport type.", "Water volleyball type.", "Weeding type.", "Weightlifting type.", "Weight machines type.", "Weights type.", "Wheelchair type.", "Windsurfing type.", "Workout type.", "Wrestling type.", "Yoga type.", "Yoga bikram type.", "Yoga hatha type.", "Yoga power type.", "Yoga vinyasa type.", "Zumba type." ], "type": "string", "enum": [ "EXERCISE_TYPE_UNSPECIFIED", "AEROBIC_WORKOUT", "ARCHERY", "ASSAULT_BIKE", "BACKPACKING", "BADMINTON", "BALLET", "BALLROOM_DANCE", "BARRE_CLASS", "BASEBALL", "BASKETBALL", "BIKING", "BILLIARDS", "BODY_WEIGHT", "BOOTCAMP", "BOWLING", "BOXING", "BREAKDANCING", "CALISTHENICS", "CANOEING", "CARDIO_SCULPT", "CARDIO_WORKOUT", "CARPENTRY", "CHEERLEADING", "CIRCUIT_TRAINING", "CLEANING", "CLIMBING", "CORE_TRAINING", "CRICKET", "CROQUET", "CROSS_COUNTRY_SKI", "CROSS_TRAINING", "CROSSFIT", "CURLING", "DANCING", "DIVING", "ELECTRIC_BIKE", "ELECTRIC_SCOOTER", "ELLIPTICAL", "EQUESTRIAN_SPORTS", "EXERCISE_CLASS", "FENCING", "FIELD_HOCKEY", "FISHING", "FITNESS_GAMING", "FOILING", "FOOTBALL_AMERICAN", "FOOTBALL_AUSTRALIAN", "FREE_WEIGHTS", "FRISBEE_PLAYING_GENERAL", "FUNCTIONAL_STRENGTH_TRAINING", "GARDENING", "GOLF", "GYMNASTICS", "HANDBALL", "HAND_CYCLING", "HIIT", "HIKING", "HIP_HOP", "HOCKEY", "HOEING", "HOUSEHOLD_CHORES", "HUNTING", "ICE_SKATING", "INCLINE_RUN", "INCLINE_WALK", "INDOOR_CLIMBING", "INTERVAL_WORKOUT", "JAZZ_DANCE", "JIU_JITSU", "JUMPING_ROPE", "KARATE", "KAYAKING", "KICKBOXING", "KITESURFING", "LACROSSE", "MARTIAL_ARTS", "MEDITATE", "MODERN_DANCE", "MOTOCROSS", "MOTORCYCLE", "MOUNTAIN_BIKE", "MOWING_LAWN", "MUAY_THAI", "MULTISPORT", "MUSICAL_PERFORMANCE", "NORDIC_WALKING", "ORIENTEERING", "OTHER", "OUTDOOR_BIKE", "OUTDOOR_WORKOUT", "PADDLEBOARDING", "PADEL", "PAINTING", "PARAGLIDING", "PARKOUR", "PICKELBALL", "PILATES", "POLO", "POWERLIFTING", "POWER_WALKING", "RACKET_SPORTS", "RACQUETBALL", "RESISTANCE_BANDS", "ROCK_CLIMBING", "ROLLERBLADING", "ROLLER_SKATING", "ROWING", "ROWING_MACHINE", "RUCKING", "RUGBY", "RUNNING", "SAILING", "SCOOTERING", "SCUBA_DIVING", "SHOOTING", "SHOVELING", "SKATEBOARDING", "SKATING", "SKIING", "SKYDIVING", "SNORKELING", "SNOWBOARDING", "SNOWMOBILING", "SNOWSHOEING", "SNOW_SPORT", "SOCCER", "SOFTBALL", "SPEED_SKATING", "SPINNING", "SPORT", "SQUASH", "STAIRCLIMBER", "STATIONARY_BIKE", "STEP_TRAINING", "STRENGTH_TRAINING", "STRETCHING", "STROLLER_WALK", "SURFING", "SWIMMING", "SWIMMING_OPEN_WATER", "SWIMMING_POOL", "SYNCHRONIZED_SWIMMING", "TABATA_WORKOUT", "TABLE_TENNIS", "TAEKWONDO", "TAI_CHI", "TANGO", "TENNIS", "TRACK_AND_FIELD", "TRAIL_RUN", "TRAMPOLINE", "TREADMILL", "TREADMILL_WALK", "TRX", "ULTIMATE_FRISBEE", "UNICYCLING", "VOLLEYBALL", "VOLLEYBALL_BEACH", "WAKEBOARDING", "WALKING", "WALK_WITH_WEIGHTS", "WATER_AEROBICS", "WATER_JOGGING", "WATER_POLO", "WATER_SKIING", "WATER_SPORT", "WATER_VOLLEYBALL", "WEEDING", "WEIGHTLIFTING", "WEIGHT_MACHINES", "WEIGHTS", "WHEELCHAIR", "WINDSURFING", "WORKOUT", "WRESTLING", "YOGA", "YOGA_BIKRAM", "YOGA_HATHA", "YOGA_POWER", "YOGA_VINYASA", "ZUMBA" ] }, "exerciseMetadata": { "$ref": "ExerciseMetadata", "description": "Optional. Additional exercise metadata." }, "displayName": { "description": "Required. Exercise display name.", "type": "string" }, "metricsSummary": { "$ref": "MetricsSummary", "description": "Required. Summary metrics for this exercise ( )" }, "interval": { "description": "Required. Observed exercise interval", "$ref": "SessionTimeInterval" }, "activeDuration": { "description": "Optional. Duration excluding pauses.", "type": "string", "format": "google-duration" }, "splitSummaries": { "type": "array", "items": { "$ref": "SplitSummary" }, "description": "Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other." }, "notes": { "description": "Optional. Standard free-form notes captured at manual logging.", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. This is the timestamp of the last update to the exercise.", "readOnly": true }, "splits": { "type": "array", "items": { "$ref": "SplitSummary" }, "description": "Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits" }, "exerciseEvents": { "type": "array", "items": { "$ref": "ExerciseEvent" }, "description": "Optional. Exercise events that happen during an exercise, such as pause & restarts." }, "createTime": { "description": "Output only. Represents the timestamp of the creation of the exercise.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "description": "An exercise that stores information about a physical activity." }, "ListSubscriptionsResponse": { "id": "ListSubscriptionsResponse", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "Subscription" }, "description": "The subscriptions from the specified subscriber." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for ListSubscriptions.", "type": "object" }, "GoogleDevicesandservicesHealthV4DataType": { "type": "object", "id": "GoogleDevicesandservicesHealthV4DataType", "properties": { "name": { "description": "Identifier. The resource name of the data type. Format: `users/{user}/dataTypes/{data_type}` See DataPoint.name for examples and possible values.", "type": "string" } }, "description": "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." }, "WeightQuantity": { "type": "object", "id": "WeightQuantity", "properties": { "grams": { "description": "Required. Value representing the weight in grams.", "format": "double", "type": "number" }, "userProvidedUnit": { "type": "string", "enum": [ "WEIGHT_UNIT_UNSPECIFIED", "GRAM", "KILOGRAM", "OUNCE", "POUND", "STONE", "MILLIGRAM", "MICROGRAM", "NANOGRAM" ], "description": "Optional. Value representing the user provided unit.", "enumDescriptions": [ "Unspecified weight unit.", "Value representing gram.", "Value representing kilogram.", "Value representing ounce.", "Value representing pound.", "Value representing stone.", "Value representing milligram.", "Value representing microgram.", "Value representing nanogram." ] } }, "description": "Represents the weight quantity." }, "Interval": { "type": "object", "id": "Interval", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end." }, "startTime": { "format": "google-datetime", "type": "string", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start." } }, "description": "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." }, "ObservationTimeInterval": { "type": "object", "description": "Represents a time interval of an observed data point.", "id": "ObservationTimeInterval", "properties": { "civilStartTime": { "$ref": "CivilDateTime", "description": "Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval", "readOnly": true }, "startTime": { "description": "Required. Observed interval start time.", "type": "string", "format": "google-datetime" }, "endUtcOffset": { "format": "google-duration", "type": "string", "description": "Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC)." }, "startUtcOffset": { "description": "Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).", "format": "google-duration", "type": "string" }, "endTime": { "description": "Required. Observed interval end time.", "format": "google-datetime", "type": "string" }, "civilEndTime": { "$ref": "CivilDateTime", "description": "Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval", "readOnly": true } } }, "DailyRollUpDataPointsRequest": { "type": "object", "description": "Request to roll up data points by civil time intervals.", "id": "DailyRollUpDataPointsRequest", "properties": { "windowSizeDays": { "description": "Optional. Aggregation window size, in number of days. Defaults to 1 if not specified.", "format": "int32", "type": "integer" }, "dataSourceFamily": { "description": "Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources", "type": "string" }, "pageToken": { "description": "Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", "type": "string" }, "range": { "description": "Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days.", "$ref": "CivilTimeInterval" }, "pageSize": { "description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.", "format": "int32", "type": "integer" } } }, "CreateSubscriptionPayload": { "id": "CreateSubscriptionPayload", "properties": { "dataTypes": { "type": "array", "items": { "type": "string" }, "description": "Optional. Data types subscribed to." }, "user": { "description": "Required. Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).", "type": "string" } }, "description": "Payload for creating a subscription.", "type": "object" }, "Electrocardiogram": { "description": "Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review.", "id": "Electrocardiogram", "properties": { "waveformSamples": { "description": "Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading.", "type": "array", "items": { "format": "int32", "type": "integer" } }, "medicalDeviceInfo": { "description": "Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`.", "readOnly": true, "$ref": "MedicalDeviceInfo" }, "beatsPerMinuteAvg": { "format": "int64", "type": "string", "description": "Optional. Average heart rate recorded during ECG reading in beats per minute." }, "resultClassification": { "description": "Optional. The result classification of the ECG reading.", "enumDescriptions": [ "Unspecified result classification.", "Heart rhythm appears normal. Corresponds to result \"Normal Sinus Rhythm\".", "Signs of Atrial Fibrillation detected. Corresponds to result \"Atrial Fibrillation\".", "The reading is inconclusive as it could not be classified. Corresponds to result \"Inconclusive\".", "The reading is inconclusive as it could not be classified because heart rate is high (\u003e120bpm). Corresponds to result \"Inconclusive: High heart rate\".", "The reading is inconclusive as it could not be classified because heart rate is low (\u003c50bpm). Corresponds to result \"Inconclusive: Low heart rate\".", "The reading is unreadable.", "The reading was not analyzed." ], "type": "string", "enum": [ "RESULT_CLASSIFICATION_UNSPECIFIED", "NORMAL_SINUS_RHYTHM", "ATRIAL_FIBRILLATION", "INCONCLUSIVE", "INCONCLUSIVE_HIGH_HEART_RATE", "INCONCLUSIVE_LOW_HEART_RATE", "UNREADABLE", "NOT_ANALYZED" ] }, "leadNumber": { "format": "int32", "type": "integer", "description": "Optional. The number of leads used for ECG reading." }, "interval": { "$ref": "SessionTimeInterval", "description": "Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time." }, "samplingFrequencyHertz": { "type": "integer", "format": "int32", "description": "Optional. The sampling frequency of waveform samples in hertz." }, "millivoltsScalingFactor": { "description": "Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.", "format": "int32", "type": "integer" } }, "type": "object" }, "HydrationLog": { "type": "object", "description": "Holds information about a user logged hydration.", "id": "HydrationLog", "properties": { "interval": { "description": "Required. Observed interval.", "$ref": "SessionTimeInterval" }, "amountConsumed": { "description": "Required. Amount of liquid (ex. water) consumed.", "$ref": "VolumeQuantity" } } }, "VolumeQuantityRollup": { "description": "Rollup for volume quantity.", "id": "VolumeQuantityRollup", "properties": { "millilitersSum": { "description": "Required. The sum of volume in milliliters.", "type": "number", "format": "double" }, "userProvidedUnitLast": { "enum": [ "VOLUME_UNIT_UNSPECIFIED", "CUP_IMPERIAL", "CUP_US", "FLUID_OUNCE_IMPERIAL", "FLUID_OUNCE_US", "LITER", "MILLILITER", "PINT_IMPERIAL", "PINT_US" ], "type": "string", "description": "Optional. The user provided unit on the last element.", "enumDescriptions": [ "Unspecified volume unit.", "Cup (imperial)", "Cup (US)", "Fluid ounce (imperial)", "Fluid ounce (US)", "Liter", "Milliliter", "Pint (imperial)", "Pint (US)" ] } }, "type": "object" }, "HeartRateVariability": { "type": "object", "id": "HeartRateVariability", "properties": { "standardDeviationMilliseconds": { "description": "Optional. The standard deviation of the heart rate variability measurement.", "format": "double", "type": "number" }, "sampleTime": { "description": "Required. The time of the heart rate variability measurement.", "$ref": "ObservationSampleTime" }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": { "description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.", "format": "double", "type": "number" } }, "description": "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)." }, "ListSubscribersResponse": { "id": "ListSubscribersResponse", "properties": { "totalSize": { "type": "integer", "format": "int32", "description": "The total number of subscribers matching the request." }, "subscribers": { "type": "array", "items": { "$ref": "Subscriber" }, "description": "Subscribers from the specified project." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for ListSubscribers.", "type": "object" }, "Device": { "description": "Captures metadata about the device that recorded the measurement.", "id": "Device", "properties": { "manufacturer": { "description": "Optional. An optional manufacturer of the device.", "type": "string" }, "displayName": { "description": "Optional. An optional name for the device.", "type": "string" }, "formFactor": { "description": "Optional. Captures the form factor of the device.", "enumDescriptions": [ "The form factor is unspecified.", "The device is a fitness band.", "The device is a watch.", "The device is a phone.", "The device is a ring.", "The device is a chest strap.", "The device is a scale.", "The device is a tablet.", "The device is a head mounted device.", "The device is a smart display." ], "enum": [ "FORM_FACTOR_UNSPECIFIED", "FITNESS_BAND", "WATCH", "PHONE", "RING", "CHEST_STRAP", "SCALE", "TABLET", "HEAD_MOUNTED", "SMART_DISPLAY" ], "type": "string" } }, "type": "object" }, "Floors": { "type": "object", "description": "Gained elevation measured in floors over the time interval", "id": "Floors", "properties": { "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval" }, "count": { "description": "Required. Number of floors in the recorded interval", "format": "int64", "type": "string" } } }, "HeartRateRollupValue": { "type": "object", "id": "HeartRateRollupValue", "properties": { "beatsPerMinuteMin": { "description": "The minimum heart rate value in the interval.", "format": "double", "type": "number" }, "beatsPerMinuteMax": { "description": "The maximum heart rate value in the interval.", "format": "double", "type": "number" }, "beatsPerMinuteAvg": { "description": "The average heart rate value in the interval.", "format": "double", "type": "number" } }, "description": "Represents the result of the rollup of the heart rate data type." }, "NutritionLogRollupValue": { "type": "object", "id": "NutritionLogRollupValue", "properties": { "totalFat": { "description": "Total fat rollup.", "$ref": "WeightQuantityRollup" }, "energy": { "description": "Energy rollup.", "$ref": "EnergyQuantityRollup" }, "totalCarbohydrate": { "description": "Total carbohydrate rollup.", "$ref": "WeightQuantityRollup" }, "nutrients": { "type": "array", "items": { "$ref": "NutrientQuantityRollup" }, "description": "List of the nutrient roll-ups by the nutrient type." }, "energyFromFat": { "description": "Value Energy from fat rollup.", "$ref": "EnergyQuantityRollup" } }, "description": "Represents the result of the rollup of the nutrition log data type." }, "CreateSubscriberPayload": { "type": "object", "description": "Payload for creating a subscriber.", "id": "CreateSubscriberPayload", "properties": { "endpointUri": { "description": "Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during the `CreateSubscriber` call. See CreateSubscriber RPC documentation for verification details.", "type": "string" }, "subscriberConfigs": { "description": "Optional. Configuration for the subscriber.", "type": "array", "items": { "$ref": "SubscriberConfig" } }, "endpointAuthorization": { "$ref": "EndpointAuthorization", "description": "Required. Authorization mechanism for the subscriber endpoint. The `secret` within this message is crucial for endpoint verification and for securing webhook notifications." } } }, "PairedDevice": { "type": "object", "description": "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.", "id": "PairedDevice", "properties": { "lastSyncTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time of last sync with the Fitbit mobile application.", "readOnly": true }, "batteryStatus": { "description": "Output only. The battery status of the device. Supported: High | Medium | Low | Empty", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The resource name of this Device resource. Format: `users/{user}/pairedDevices/{paired_device}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`", "type": "string" }, "features": { "description": "Output only. Lists of unique features supported by the device. Comprehensive list of supported features: **Fitness Tracking** - `ACTIVE_MINUTES`: Legacy active minutes. - `AUTOSTRIDE`: Automatic stride length calculation. - `BIKE_ONBOARDING`: Cycling UI support. - `CALORIES`: Daily burned calories. - `DISTANCE`: Daily distance tracking. - `ELEVATION`: Floors climbed. - `INACTIVITY_ALERTS`: Reminders to move. - `SEDENTARY_TIME`: Tracks inactive time. - `STEPS`: Daily steps. - `SWIM`: Swim tracking (laps/strokes). - `AUTORUN`: Automatic run detection. - `ACTIVE_ZONE_MINUTES`: Active Zone Minutes (AZM). **Heart Rate & Health** - `HEART_RATE`: Continuous heart rate (PPG). - `BAT_SIGNAL`: High/Low Heart Rate Alerts. **Advanced Sensors** - `SPO2`: Blood oxygen saturation. - `NIGHTTIME_OXYGEN_SATURATION`: Sleep SpO2. - `ESTIMATED_OXYGEN_VARIATION`: Estimated Oxygen Variation. - `EDA`: Electrodermal Activity (stress). - `SKIN_TEMPERATURE`: Skin temperature variation. - `INTERNAL_DEVICE_TEMPERATURE`: Internal device temperature. **Sleep & Wellness** - `SLEEP`: Basic sleep tracking. - `SMART_SLEEP`: Advanced sleep tracking (stages/score). - `BEDTIME_REMINDER`: Bedtime reminders. - `SOUNDSCAPE`: Snore and noise detection. **Advanced Workouts** - `WB`: Custom Workout Builder. - `AUTOCUES`: Auto Cues / Auto Lap. - `DWR_RUN`: Daily Run Recommendations. - `ADVANCED_RUNNING`: Advanced Running Dynamics (e.g., GCT, VO). **GPS & Location** - `GPS`: Built-in GPS. - `CONNECTED_GPS`: Connected GPS (uses phone). - `LOCATION_HINT`: Location helper. **Payments & NFC** - `PAYMENTS`: NFC payments (Fitbit Pay/Google Wallet). - `FELICA`: FeliCa support (Japan payments/transit). **Activity Detection** - `GROK`: SmartTrack automatic activity detection. - `RETRO_AR`: Retroactive Activity Recognition prompts. **Smart Features & UI** - `ALARMS`: Silent alarms. - `BLE_MUSIC_CONTROL`: BLE music control. - `MUSIC`: Direct music storage/control. - `YOUTUBE_MUSIC_SUPPORTED`: YouTube Music support. - `GALLERY`: App Gallery. - `TUTORIAL_SUPPORTED`: On-screen tutorials. - `SMILEY_EMOTE`: Legacy Zip face. - `MOBILE_TO_DEVICE_DEEPLINK`: Mobile to device settings deep link. - `HIDE_GALLERY`: Option to hide Gallery. - `HIDE_GOAL_SELECTION`: Option to hide goal selection. - `DIGITAL_WARRANTY_SUPPORTED`: Digital warranty display. - `DIRECT_DEVICE_SETTINGS_SUPPORTED`: Direct device settings management. **Gym HR Broadcasting** - `ASPEN_SUPPORTED`: Broadcast HR to gym equipment. - `ASPEN_REMOTE_UI_SUPPORTED`: Remote UI for HR sharing. **Privacy & Security** - `FINITE_IMPROBABILITY`: BLE Resolvable Private Address (RPA) privacy. - `DOMAIN_KEY_SYNC`: Domain key synchronization. **BLE Protocol** - `BONDING`: Secure BLE bonding. - `ADVERTISES_SERIAL`: Advertises serial number. - `STATUS_CHARACTERISTIC`: BLE Status Characteristic. - `TRACKER_CHANNEL_CHARACTERISTIC`: BLE Tracker Channel Characteristic. - `PING_CHARACTERISTIC`: BLE Ping Characteristic. **Cellular & Wi-Fi** - `MOBILE_DATA`: LTE cellular support. - `SINGLE_AP_WIFI`: Single AP Wi-Fi. - `MULTI_AP_WIFI`: Multi AP Wi-Fi. - `WIFI_FWUP`: Firmware updates over Wi-Fi. **Data Sync & Transfer** - `APP_SYNC`: Background app sync. - `LIVE_DATA`: Real-time data streaming. - `EVENT_BASED_SYNC_SUPPORTED`: Event-based sync. - `TIME_SERVICE`: Time synchronization service. - `REMOTE_FILE_PROVIDER`: Remote file transfer. - `DIRECT_COMMS_ALARMS`: Direct communication for alarms. - `DIRECT_COMMS_EXERCISE`: Direct communication for exercise. - `DIRECT_COMMS_BATTERY_ALERTS`: Direct communication for battery alerts. **Google Integrations** - `PARROT_TREE_SUPPORTED`: Find My Device support.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "deviceType": { "readOnly": true, "enumDescriptions": [ "Device type is not specified.", "Device type is tracker.", "Device type is scale." ], "description": "Output only. The device type. Supported: TRACKER | SCALE", "type": "string", "enum": [ "DEVICE_TYPE_UNSPECIFIED", "TRACKER", "SCALE" ] }, "batteryLevel": { "type": "integer", "format": "int32", "description": "Output only. The battery level of the device.", "readOnly": true }, "deviceVersion": { "type": "string", "description": "Output only. The product name of the device", "readOnly": true }, "macAddress": { "type": "string", "description": "Output only. Mac ID number of the device.", "readOnly": true } } }, "HttpResponse": { "description": "Represents an HTTP response.", "id": "HttpResponse", "properties": { "status": { "type": "integer", "format": "int32", "description": "The HTTP status code, such as 200 or 404." }, "headers": { "type": "array", "items": { "$ref": "HttpHeader" }, "description": "The HTTP response headers. The ordering of the headers is significant. Multiple headers with the same key may present for the response." }, "body": { "description": "The HTTP response body. If the body is not expected, it should be empty.", "type": "string", "format": "byte" }, "reason": { "description": "The HTTP reason phrase, such as \"OK\" or \"Not Found\".", "type": "string" } }, "type": "object" }, "ObservationSampleTime": { "description": "Represents a sample time of an observed data point.", "id": "ObservationSampleTime", "properties": { "physicalTime": { "description": "Required. The time of the observation.", "type": "string", "format": "google-datetime" }, "utcOffset": { "format": "google-duration", "type": "string", "description": "Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC)." }, "civilTime": { "description": "Output only. The civil time in the timezone the subject is in at the time of the observation.", "readOnly": true, "$ref": "CivilDateTime" } }, "type": "object" }, "DailyHeartRateZones": { "id": "DailyHeartRateZones", "properties": { "date": { "$ref": "Date", "description": "Required. Date (in user's timezone) of the heart rate zones record." }, "heartRateZones": { "type": "array", "items": { "$ref": "HeartRateZone" }, "description": "Required. The heart rate zones." } }, "description": "User's heart rate zone thresholds based on the Karvonen algorithm for a specific day.", "type": "object" }, "OutOfBedSegment": { "id": "OutOfBedSegment", "properties": { "startUtcOffset": { "format": "google-duration", "type": "string", "description": "Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC)." }, "endTime": { "description": "Required. Segment end time.", "type": "string", "format": "google-datetime" }, "endUtcOffset": { "description": "Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).", "format": "google-duration", "type": "string" }, "startTime": { "format": "google-datetime", "type": "string", "description": "Required. Segment tart time." } }, "description": "A time interval to represent an out-of-bed segment.", "type": "object" }, "HeartRate": { "description": "A heart rate measurement.", "id": "HeartRate", "properties": { "sampleTime": { "$ref": "ObservationSampleTime", "description": "Required. Observation time" }, "metadata": { "$ref": "HeartRateMetadata", "description": "Optional. Metadata about the heart rate sample." }, "beatsPerMinute": { "description": "Required. The heart rate value in beats per minute.", "format": "int64", "type": "string" } }, "type": "object" }, "DailyRestingHeartRate": { "type": "object", "id": "DailyRestingHeartRate", "properties": { "date": { "$ref": "Date", "description": "Required. Date (in the user's timezone) of the resting heart rate measurement." }, "dailyRestingHeartRateMetadata": { "description": "Optional. Metadata for the daily resting heart rate.", "$ref": "DailyRestingHeartRateMetadata" }, "beatsPerMinute": { "type": "string", "format": "int64", "description": "Required. The resting heart rate value in beats per minute." } }, "description": "Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements." }, "HeartBeat": { "type": "object", "description": "A single heart beat measurement.", "id": "HeartBeat", "properties": { "beatsPerMinute": { "type": "integer", "format": "int32", "description": "Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval)." }, "physicalTime": { "format": "google-datetime", "type": "string", "description": "Required. The time of the heart beat measurement." }, "utcOffset": { "type": "string", "format": "google-duration", "description": "Required. The UTC offset of the user's timezone when the heart beat measurement occurred." }, "civilTime": { "$ref": "CivilDateTime", "description": "Output only. The civil time in the timezone the subject is in at the time of the observation.", "readOnly": true } } }, "SleepMetadata": { "type": "object", "description": "Additional information about how the sleep was processed.", "id": "SleepMetadata", "properties": { "manuallyEdited": { "description": "Output only. Some sleeps autodetected by algorithms can be manually edited by users.", "readOnly": true, "type": "boolean" }, "nap": { "description": "Output only. Naps are sleeps without stages and relatively short durations.", "readOnly": true, "type": "boolean" }, "externalId": { "description": "Optional. Sleep identifier relevant in the context of the data source.", "type": "string" }, "processed": { "type": "boolean", "description": "Output only. Sleep and sleep stages algorithms finished processing. A `true` value indicates whether all data processing for the session is complete. A `false` value means sleep period is detected but sleep stages is still processing.", "readOnly": true }, "stagesStatus": { "description": "Output only. Sleep stages algorithm processing status.", "type": "string", "enum": [ "STAGES_STATE_UNSPECIFIED", "REJECTED_COVERAGE", "REJECTED_MAX_GAP", "REJECTED_START_GAP", "REJECTED_END_GAP", "REJECTED_NAP", "REJECTED_SERVER", "TIMEOUT", "SUCCEEDED", "PROCESSING_INTERNAL_ERROR" ], "readOnly": true, "enumDescriptions": [ "Output only. Sleep stages status is unspecified.", "Output only. Sleep stages cannot be computed due to low RR coverage.", "Output only. Sleep stages cannot be computed due to the large middle gap (2h).", "Output only. Sleep stages cannot be computed due to the large start gap (1h).", "Output only. Sleep stages cannot be computed due to the large end gap (1h).", "Output only. Sleep stages cannot be computed because the sleep log is a nap (has \u003c 3h duration).", "Output only. Sleep stages cannot be computed because input data is not available (PPGV2, wake magnitude, etc).", "Output only. Sleep stages cannot be computed due to server timeout.", "Output only. Sleep stages successfully computed.", "Output only. Sleep stages cannot be computed due to server internal error." ] } } }, "RespiratoryRateSleepSummary": { "id": "RespiratoryRateSleepSummary", "properties": { "lightSleepStats": { "description": "Optional. Respiratory rate statistics for light sleep.", "$ref": "RespiratoryRateSleepSummaryStatistics" }, "sampleTime": { "description": "Required. The time at which respiratory rate was measured.", "$ref": "ObservationSampleTime" }, "fullSleepStats": { "description": "Required. Full respiratory rate statistics.", "$ref": "RespiratoryRateSleepSummaryStatistics" }, "deepSleepStats": { "description": "Optional. Respiratory rate statistics for deep sleep.", "$ref": "RespiratoryRateSleepSummaryStatistics" }, "remSleepStats": { "$ref": "RespiratoryRateSleepSummaryStatistics", "description": "Optional. Respiratory rate statistics for REM sleep." } }, "description": "Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times.", "type": "object" }, "ListDataPointsResponse": { "id": "ListDataPointsResponse", "properties": { "dataPoints": { "description": "Data points matching the query", "type": "array", "items": { "$ref": "DataPoint" } }, "nextPageToken": { "description": "Next page token, empty if the response is complete", "type": "string" } }, "description": "Response containing raw data points matching the query", "type": "object" }, "ActiveEnergyBurnedRollupValue": { "type": "object", "id": "ActiveEnergyBurnedRollupValue", "properties": { "kcalSum": { "type": "number", "format": "double", "description": "Output only. Sum of the active energy burned in kilocalories.", "readOnly": true } }, "description": "Represents the result of the rollup of active energy burned." }, "TimeZone": { "type": "object", "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "id": "TimeZone", "properties": { "version": { "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", "type": "string" }, "id": { "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", "type": "string" } } }, "WeightRollupValue": { "description": "Represents the result of the rollup of the weight data type.", "id": "WeightRollupValue", "properties": { "weightGramsAvg": { "type": "number", "format": "double", "description": "Average weight in grams." } }, "type": "object" }, "MedicalDeviceInfo": { "id": "MedicalDeviceInfo", "properties": { "serviceVersion": { "type": "string", "description": "Output only. The service version used by the feature.", "readOnly": true }, "firmwareVersion": { "type": "string", "description": "Output only. The firmware version running on the compatible device used to collect the data.", "readOnly": true }, "featureVersion": { "description": "Output only. The version of the feature/app running on the device.", "readOnly": true, "type": "string" }, "algorithmVersion": { "description": "Output only. The algorithm version used by the feature.", "readOnly": true, "type": "string" }, "deviceModel": { "description": "Output only. The model name or device type of the compatible device used to collect the data.", "readOnly": true, "type": "string" } }, "description": "Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI).", "type": "object" }, "BodyFat": { "type": "object", "description": "Body fat measurement.", "id": "BodyFat", "properties": { "sampleTime": { "$ref": "ObservationSampleTime", "description": "Required. The time at which body fat was measured." }, "percentage": { "description": "Required. Body fat percentage, in range [0, 100].", "format": "double", "type": "number" } } }, "SwimLengthsData": { "description": "Swim lengths data over the time interval.", "id": "SwimLengthsData", "properties": { "interval": { "description": "Required. Observed interval.", "$ref": "ObservationTimeInterval" }, "swimStrokeType": { "enum": [ "SWIM_STROKE_TYPE_UNSPECIFIED", "FREESTYLE", "BACKSTROKE", "BREASTSTROKE", "BUTTERFLY" ], "type": "string", "description": "Required. Swim stroke type.", "enumDescriptions": [ "Swim stroke type is unspecified.", "Freestyle swim stroke type.", "Backstroke swim stroke type.", "Breaststroke swim stroke type.", "Butterfly swim stroke type." ] }, "strokeCount": { "format": "int64", "type": "string", "description": "Required. Number of strokes in the lap." } }, "type": "object" }, "DistanceRollupValue": { "type": "object", "description": "Result of the rollup of the user's distance.", "id": "DistanceRollupValue", "properties": { "millimetersSum": { "description": "Sum of the distance in millimeters.", "format": "int64", "type": "string" } } }, "NutritionLog": { "type": "object", "description": "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.", "id": "NutritionLog", "properties": { "totalFat": { "description": "Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually.", "$ref": "WeightQuantity" }, "mealType": { "description": "Optional. Value representing the meal type of the nutrition log.", "enumDescriptions": [ "Unspecified meal type.", "Value representing a meal before breakfast.", "Value representing a breakfast.", "Value representing a morning snack.", "Value representing a lunch.", "Value representing an afternoon snack.", "Value representing dinner.", "Value representing an evening snack.", "Value representing any meal outside of the usual three meals per day.", "Value representing any time (legacy NA)." ], "enum": [ "MEAL_TYPE_UNSPECIFIED", "BEFORE_BREAKFAST", "BREAKFAST", "BEFORE_LUNCH", "LUNCH", "BEFORE_DINNER", "DINNER", "AFTER_DINNER", "SNACK", "ANYTIME" ], "type": "string" }, "nutrients": { "description": "Optional. Value representing the nutrients of the nutrition log.", "type": "array", "items": { "$ref": "NutrientQuantity" } }, "foodDisplayName": { "description": "Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually.", "type": "string" }, "energy": { "description": "Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually.", "$ref": "EnergyQuantity" }, "serving": { "description": "Optional. Value representing the nutrition log serving.", "$ref": "Serving" }, "interval": { "description": "Required. Observed interval.", "$ref": "SessionTimeInterval" }, "totalCarbohydrate": { "description": "Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually.", "$ref": "WeightQuantity" }, "food": { "description": "Required. Represents the food ID.", "type": "string" }, "energyFromFat": { "$ref": "EnergyQuantity", "description": "Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." } } }, "SplitSummary": { "description": "Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.", "id": "SplitSummary", "properties": { "startUtcOffset": { "description": "Required. Lap start time offset from UTC", "type": "string", "format": "google-duration" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Required. Lap end time" }, "endUtcOffset": { "type": "string", "format": "google-duration", "description": "Required. Lap end time offset from UTC" }, "startTime": { "format": "google-datetime", "type": "string", "description": "Required. Lap start time" }, "metricsSummary": { "description": "Required. Summary metrics for this split.", "$ref": "MetricsSummary" }, "splitType": { "description": "Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.", "enumDescriptions": [ "Split type is unspecified.", "Manual split.", "Split by duration.", "Split by distance.", "Split by calories." ], "type": "string", "enum": [ "SPLIT_TYPE_UNSPECIFIED", "MANUAL", "DURATION", "DISTANCE", "CALORIES" ] }, "activeDuration": { "description": "Output only. Lap time excluding the pauses.", "readOnly": true, "format": "google-duration", "type": "string" } }, "type": "object" }, "CoreBodyTemperatureRollupValue": { "type": "object", "id": "CoreBodyTemperatureRollupValue", "properties": { "temperatureCelsiusMax": { "description": "Maximum core body temperature in Celsius.", "format": "double", "type": "number" }, "temperatureCelsiusMin": { "format": "double", "type": "number", "description": "Minimum core body temperature in Celsius." }, "temperatureCelsiusAvg": { "description": "Average core body temperature in Celsius.", "format": "double", "type": "number" } }, "description": "Represents the result of the rollup of the core body temperature data type." }, "VolumeQuantity": { "type": "object", "id": "VolumeQuantity", "properties": { "milliliters": { "type": "number", "format": "double", "description": "Required. Value representing the volume in milliliters." }, "userProvidedUnit": { "type": "string", "enum": [ "VOLUME_UNIT_UNSPECIFIED", "CUP_IMPERIAL", "CUP_US", "FLUID_OUNCE_IMPERIAL", "FLUID_OUNCE_US", "LITER", "MILLILITER", "PINT_IMPERIAL", "PINT_US" ], "description": "Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.", "enumDescriptions": [ "Unspecified volume unit.", "Cup (imperial)", "Cup (US)", "Fluid ounce (imperial)", "Fluid ounce (US)", "Liter", "Milliliter", "Pint (imperial)", "Pint (US)" ] } }, "description": "Represents the volume quantity." }, "SubscriberConfig": { "id": "SubscriberConfig", "properties": { "dataTypes": { "type": "array", "items": { "type": "string" }, "description": "Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case." }, "subscriptionCreatePolicy": { "description": "Required. Policy for subscription creation.", "enumDescriptions": [ "Represents an unspecified policy.", "When using `AUTOMATIC`, individual subscriptions are not created or stored. Instead, eligibility for notifications is computed dynamically. When a data update occurs for a given data type, notifications are sent to all subscribers with an `AUTOMATIC` policy for that data type, provided the user has granted the necessary consents. This means you do not need to call `CreateSubscription` for each user; notifications are managed automatically based on user consents. As `Subscription` resources are not stored, they cannot be retrieved or managed through `GetSubscription`, `ListSubscriptions`, `UpdateSubscription`, or `DeleteSubscription`.", "Requires subscriptions to be created manually for new users. The developer needs to call CreateSubscription for new users." ], "type": "string", "enum": [ "SUBSCRIPTION_CREATE_POLICY_UNSPECIFIED", "AUTOMATIC", "MANUAL" ] } }, "description": "Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type.", "type": "object" }, "Food": { "type": "object", "description": "Represents a food item.", "id": "Food", "properties": { "energyMin": { "description": "Optional. Value representing the minimum energy of the food for the default serving.", "$ref": "EnergyQuantity" }, "totalCarbohydrate": { "description": "Optional. Value representing the total carbohydrate of the food for the default serving.", "$ref": "WeightQuantity" }, "description": { "description": "Optional. The description of the food.", "type": "string" }, "servings": { "description": "Optional. The serving of the food.", "type": "array", "items": { "$ref": "FoodServing" } }, "nutrients": { "type": "array", "items": { "$ref": "NutrientQuantity" }, "description": "Optional. Value representing the nutrients of the food for the default serving." }, "displayName": { "description": "Required. The display name of the food.", "type": "string" }, "accessLevel": { "type": "string", "enum": [ "FOOD_ACCESS_LEVEL_UNSPECIFIED", "FOOD_ACCESS_LEVEL_PUBLIC", "FOOD_ACCESS_LEVEL_PRIVATE" ], "description": "Required. The access level of the food.", "enumDescriptions": [ "Unspecified food access level.", "Public food access level.", "Private food access level." ] }, "languageCode": { "description": "Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.", "type": "string" }, "totalFat": { "$ref": "WeightQuantity", "description": "Optional. Value representing the total fat of the food for the default serving." }, "energyFromFat": { "description": "Optional. Value representing the energy from fat of the food for the default serving.", "$ref": "EnergyQuantity" }, "brand": { "description": "Optional. The brand of the food.", "type": "string" }, "energyAvg": { "description": "Optional. Value representing the average energy of the food for the default serving.", "$ref": "EnergyQuantity" }, "energyMax": { "description": "Optional. Value representing the maximum energy of the food for the default serving.", "$ref": "EnergyQuantity" }, "mealType": { "description": "Optional. The meal type associated with this food.", "enumDescriptions": [ "Unspecified meal type.", "Value representing a meal before breakfast.", "Value representing a breakfast.", "Value representing a morning snack.", "Value representing a lunch.", "Value representing an afternoon snack.", "Value representing dinner.", "Value representing an evening snack.", "Value representing any meal outside of the usual three meals per day.", "Value representing any time (legacy NA)." ], "type": "string", "enum": [ "MEAL_TYPE_UNSPECIFIED", "BEFORE_BREAKFAST", "BREAKFAST", "BEFORE_LUNCH", "LUNCH", "BEFORE_DINNER", "DINNER", "AFTER_DINNER", "SNACK", "ANYTIME" ] }, "defaultServing": { "description": "Required. Value representing the default serving of the food.", "$ref": "FoodServing" } } }, "CaloriesInHeartRateZoneRollupValue": { "type": "object", "description": "Represents the result of the rollup of the calories in heart rate zone data type.", "id": "CaloriesInHeartRateZoneRollupValue", "properties": { "caloriesInHeartRateZones": { "type": "array", "items": { "$ref": "CaloriesInHeartRateZoneValue" }, "description": "List of calories burned in each heart rate zone." } } }, "Altitude": { "description": "Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters.", "id": "Altitude", "properties": { "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval." }, "gainMillimeters": { "description": "Required. Altitude gain in millimeters over the observed interval.", "type": "string", "format": "int64" } }, "type": "object" }, "DailyOxygenSaturation": { "id": "DailyOxygenSaturation", "properties": { "averagePercentage": { "description": "Required. The average value of the oxygen saturation samples during the sleep.", "format": "double", "type": "number" }, "date": { "description": "Required. Date (in user's timezone) of the daily oxygen saturation record.", "$ref": "Date" }, "lowerBoundPercentage": { "type": "number", "format": "double", "description": "Required. The lower bound of the confidence interval of oxygen saturation samples during sleep." }, "upperBoundPercentage": { "description": "Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.", "format": "double", "type": "number" }, "standardDeviationPercentage": { "type": "number", "format": "double", "description": "Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days." } }, "description": "A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep.", "type": "object" }, "FoodServing": { "id": "FoodServing", "properties": { "foodMeasurementUnit": { "description": "Required. Food measurement unit", "type": "string" }, "foodMeasurementUnitDisplayName": { "description": "Output only. Legacy measurement unit for serving size in singular form (e.g. \"piece\", \"gram\").", "readOnly": true, "type": "string" }, "amount": { "type": "number", "format": "double", "description": "Optional. Amount of food consumed, fractional values are supported." }, "multiplier": { "description": "Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.", "type": "number", "format": "double" }, "foodMeasurementUnitDisplayNamePlural": { "type": "string", "description": "Output only. Legacy measurement unit for serving size in plural form (e.g. \"pieces\", \"grams\").", "readOnly": true } }, "description": "Represents different properties and information about the serving of a specific food.", "type": "object" }, "RunVO2MaxRollupValue": { "type": "object", "description": "Represents the result of the rollup of the user's daily heart rate variability personal range.", "id": "RunVO2MaxRollupValue", "properties": { "rateMin": { "description": "Minimum value of run VO2 max in the interval..", "type": "number", "format": "double" }, "rateMax": { "description": "Maximum value of run VO2 max in the interval.", "type": "number", "format": "double" }, "rateAvg": { "description": "Average value of run VO2 max in the interval.", "type": "number", "format": "double" } } }, "Subscriber": { "id": "Subscriber", "properties": { "name": { "description": "Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef", "type": "string" }, "updateTime": { "description": "Output only. The time at which the subscriber was last updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "subscriberConfigs": { "description": "Optional. Configuration for the subscriber.", "type": "array", "items": { "$ref": "SubscriberConfig" } }, "endpointAuthorization": { "description": "Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified.", "$ref": "EndpointAuthorization" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which the subscriber was created.", "readOnly": true }, "endpointUri": { "description": "Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details.", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "UNVERIFIED", "ACTIVE", "INACTIVE" ], "description": "Output only. The state of the subscriber.", "readOnly": true, "enumDescriptions": [ "Represents an unspecified subscriber state.", "Represents an unverified subscriber. This is the initial state of the subscriber when it is created. The backend will verify the subscriber's endpoint_uri.", "Represents an active subscriber. The endpoint has been verified.", "Represents an inactive subscriber." ] } }, "description": "-- Resource Messages -- A subscriber receives notifications from Google Health API.", "type": "object" }, "FloorsRollupValue": { "type": "object", "description": "Represents the result of the rollup of the user's floors.", "id": "FloorsRollupValue", "properties": { "countSum": { "description": "Sum of the floors count.", "format": "int64", "type": "string" } } }, "DailySleepTemperatureDerivations": { "type": "object", "id": "DailySleepTemperatureDerivations", "properties": { "baselineTemperatureCelsius": { "description": "Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.", "format": "double", "type": "number" }, "relativeNightlyStddev30dCelsius": { "description": "Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.", "format": "double", "type": "number" }, "nightlyTemperatureCelsius": { "description": "Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.", "type": "number", "format": "double" }, "date": { "description": "Required. Date for which the sleep temperature derivations are calculated.", "$ref": "Date" } }, "description": "Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep." }, "EnergyQuantityRollup": { "id": "EnergyQuantityRollup", "properties": { "kcalSum": { "description": "Required. The sum of the energy in kilocalories.", "type": "number", "format": "double" }, "userProvidedUnitLast": { "description": "Optional. The user provided unit on the last element.", "enumDescriptions": [ "Unspecified energy unit.", "Value representing joule.", "Value representing kilojoule.", "Value representing kilocalorie.", "Value representing small calorie.", "Value representing calorie." ], "type": "string", "enum": [ "ENERGY_UNIT_UNSPECIFIED", "JOULE", "KILOJOULE", "KILOCALORIE", "SMALL_CALORIE", "CALORIE" ] } }, "description": "Rollup for the energy quantity.", "type": "object" }, "ActivityLevelRollupByActivityLevelType": { "description": "Represents the total duration in a specific activity level type.", "id": "ActivityLevelRollupByActivityLevelType", "properties": { "totalDuration": { "format": "google-duration", "type": "string", "description": "Total duration in the activity level type." }, "activityLevelType": { "description": "Activity level type.", "enumDescriptions": [ "Unspecified activity level type.", "Sedentary activity level.", "Lightly active activity level.", "Moderately active activity level.", "Very active activity level." ], "type": "string", "enum": [ "ACTIVITY_LEVEL_TYPE_UNSPECIFIED", "SEDENTARY", "LIGHTLY_ACTIVE", "MODERATELY_ACTIVE", "VERY_ACTIVE" ] } }, "type": "object" }, "HeartRateVariabilityPersonalRangeRollupValue": { "description": "Represents the result of the rollup of the user's daily heart rate variability personal range.", "id": "HeartRateVariabilityPersonalRangeRollupValue", "properties": { "averageHeartRateVariabilityMillisecondsMin": { "description": "The lower bound of the user's average heart rate variability personal range.", "format": "double", "type": "number" }, "averageHeartRateVariabilityMillisecondsMax": { "format": "double", "type": "number", "description": "The upper bound of the user's average heart rate variability personal range." } }, "type": "object" }, "DataSource": { "id": "DataSource", "properties": { "recordingMethod": { "enum": [ "RECORDING_METHOD_UNSPECIFIED", "MANUAL", "PASSIVELY_MEASURED", "DERIVED", "ACTIVELY_MEASURED", "UNKNOWN" ], "type": "string", "description": "Optional. Captures how the data was recorded.", "enumDescriptions": [ "The recording method is unspecified.", "The data was manually entered by the user.", "The data was passively measured by a device.", "The data was derived from other data, e.g., by an algorithm in the backend.", "The data was actively measured by a device.", "The recording method is unknown. This is set when the data is uploaded from a third party app that does not provide this information." ] }, "device": { "$ref": "Device", "description": "Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync." }, "application": { "description": "Output only. Captures metadata for the application that provided this data.", "readOnly": true, "$ref": "Application" }, "platform": { "readOnly": true, "enumDescriptions": [ "The platform is unspecified.", "The data was uploaded from Fitbit.", "The data was uploaded from Health Connect.", "The data was uploaded from Health Kit.", "The data was uploaded from Google Fit.", "The data was uploaded from Fitbit legacy Web API.", "The data was uploaded from Nest devices.", "The data was uploaded from Google Health API.", "The data was uploaded from Google Partner Integrations." ], "type": "string", "enum": [ "PLATFORM_UNSPECIFIED", "FITBIT", "HEALTH_CONNECT", "HEALTH_KIT", "FIT", "FITBIT_WEB_API", "NEST", "GOOGLE_WEB_API", "GOOGLE_PARTNER_INTEGRATION" ], "description": "Output only. Captures the platform that uploaded the data." } }, "description": "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).", "type": "object" }, "StepsRollupValue": { "id": "StepsRollupValue", "properties": { "countSum": { "type": "string", "format": "int64", "description": "Total number of steps in the interval." } }, "description": "Represents the result of the rollup of the steps data type.", "type": "object" }, "Subscription": { "type": "object", "id": "Subscription", "properties": { "dataTypes": { "description": "Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format \"users/{health_user_id}/dataTypes/{data_type}\" where `{data_type}` is one of \"altitude\", \"distance\", \"floors\", \"sleep\", \"steps\", \"weight\".", "type": "array", "items": { "type": "string" } }, "name": { "description": "Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.", "type": "string" }, "user": { "description": "Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).", "type": "string" } }, "description": "A subscription to a data collection for a specific user, to be delivered to a subscriber." }, "BodyFatRollupValue": { "id": "BodyFatRollupValue", "properties": { "bodyFatPercentageAvg": { "description": "Average body fat percentage.", "format": "double", "type": "number" } }, "description": "Represents the result of the rollup of the body fat data type.", "type": "object" }, "ActiveMinutesByActivityLevel": { "type": "object", "description": "Active minutes at a given activity level.", "id": "ActiveMinutesByActivityLevel", "properties": { "activeMinutes": { "description": "Required. Number of whole minutes spent in activity.", "type": "string", "format": "int64" }, "activityLevel": { "type": "string", "enum": [ "ACTIVITY_LEVEL_UNSPECIFIED", "LIGHT", "MODERATE", "VIGOROUS" ], "description": "Required. The level of activity.", "enumDescriptions": [ "Activity level is unspecified.", "Light activity level.", "Moderate activity level.", "Vigorous activity level." ] } } }, "ReconciledDataPoint": { "type": "object", "id": "ReconciledDataPoint", "properties": { "sedentaryPeriod": { "$ref": "SedentaryPeriod", "description": "Data for points in the `sedentary-period` interval data type collection." }, "swimLengthsData": { "description": "Data for points in the `swim-lengths-data` interval data type collection.", "$ref": "SwimLengthsData" }, "activeMinutes": { "$ref": "ActiveMinutes", "description": "Data for points in the `active-minutes` interval data type collection." }, "respiratoryRateSleepSummary": { "description": "Data for points in the `respiratory-rate-sleep-summary` sample data type collection.", "$ref": "RespiratoryRateSleepSummary" }, "dailyOxygenSaturation": { "$ref": "DailyOxygenSaturation", "description": "Data for points in the `daily-oxygen-saturation` daily data type collection." }, "dailyRestingHeartRate": { "$ref": "DailyRestingHeartRate", "description": "Data for points in the `daily-resting-heart-rate` daily data type collection." }, "bodyFat": { "$ref": "BodyFat", "description": "Data for points in the `body-fat` sample data type collection." }, "coreBodyTemperature": { "$ref": "CoreBodyTemperature", "description": "Data for points in the `core-body-temperature` sample data type collection." }, "hydrationLog": { "description": "Data for points in the `hydration-log` session data type collection.", "$ref": "HydrationLog" }, "sleep": { "description": "Data for points in the `sleep` session data type collection.", "$ref": "Sleep" }, "exercise": { "$ref": "Exercise", "description": "Data for points in the `exercise` session data type collection." }, "altitude": { "$ref": "Altitude", "description": "Data for points in the `altitude` interval data type collection." }, "vo2Max": { "description": "Data for points in the `vo2-max` sample data type collection.", "$ref": "VO2Max" }, "distance": { "$ref": "Distance", "description": "Data for points in the `distance` interval data type collection." }, "dailySleepTemperatureDerivations": { "description": "Data for points in the `daily-sleep-temperature-derivations` daily data type collection.", "$ref": "DailySleepTemperatureDerivations" }, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZone", "description": "Data for points in the `time-in-heart-rate-zone` interval data type collection." }, "height": { "$ref": "Height", "description": "Data for points in the `height` sample data type collection." }, "dataPointName": { "description": "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_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_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.", "type": "string" }, "basalEnergyBurned": { "description": "Data for points in the `basal-energy-burned` interval data type collection.", "$ref": "BasalEnergyBurned" }, "dailyHeartRateVariability": { "description": "Data for points in the `daily-heart-rate-variability` daily data type collection.", "$ref": "DailyHeartRateVariability" }, "dailyVo2Max": { "description": "Data for points in the `daily-vo2-max` daily data type collection.", "$ref": "DailyVO2Max" }, "activityLevel": { "description": "Data for points in the `activity-level` daily data type collection.", "$ref": "ActivityLevel" }, "steps": { "$ref": "Steps", "description": "Data for points in the `steps` interval data type collection." }, "floors": { "description": "Data for points in the `floors` interval data type collection.", "$ref": "Floors" }, "nutritionLog": { "$ref": "NutritionLog", "description": "Data for points in the `nutrition-log` session data type collection." }, "dailyRespiratoryRate": { "$ref": "DailyRespiratoryRate", "description": "Data for points in the `daily-respiratory-rate` daily data type collection." }, "activeZoneMinutes": { "description": "Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.", "$ref": "ActiveZoneMinutes" }, "heartRateVariability": { "$ref": "HeartRateVariability", "description": "Data for points in the `heart-rate-variability` sample data type collection." }, "activeEnergyBurned": { "$ref": "ActiveEnergyBurned", "description": "Data for points in the `active-energy-burned` interval data type collection." }, "dailyHeartRateZones": { "description": "Data for points in the `daily-heart-rate-zones` daily data type collection.", "$ref": "DailyHeartRateZones" }, "runVo2Max": { "description": "Data for points in the `run-vo2-max` sample data type collection.", "$ref": "RunVO2Max" }, "oxygenSaturation": { "$ref": "OxygenSaturation", "description": "Data for points in the `oxygen-saturation` sample data type collection." }, "heartRate": { "$ref": "HeartRate", "description": "Data for points in the `heart-rate` sample data type collection." }, "bloodGlucose": { "description": "Data for points in the `blood-glucose` sample data type collection.", "$ref": "BloodGlucose" }, "weight": { "$ref": "Weight", "description": "Data for points in the `weight` sample data type collection." } }, "description": "A reconciled computed or recorded metric." }, "MetricsSummary": { "type": "object", "id": "MetricsSummary", "properties": { "activeZoneMinutes": { "description": "Optional. Total active zone minutes for the exercise.", "type": "string", "format": "int64" }, "averagePaceSecondsPerMeter": { "description": "Optional. Average pace in seconds per meter.", "type": "number", "format": "double" }, "averageHeartRateBeatsPerMinute": { "type": "string", "format": "int64", "description": "Optional. Average heart rate during the exercise." }, "totalSwimLengths": { "description": "Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.", "format": "double", "type": "number" }, "mobilityMetrics": { "description": "Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.", "$ref": "MobilityMetrics" }, "averageSpeedMillimetersPerSecond": { "format": "double", "type": "number", "description": "Optional. Average speed in millimeters per second." }, "runVo2Max": { "type": "number", "format": "double", "description": "Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise." }, "elevationGainMillimeters": { "type": "number", "format": "double", "description": "Optional. Total elevation gain during the exercise." }, "caloriesKcal": { "description": "Optional. Total calories burned by the user during the exercise.", "format": "double", "type": "number" }, "steps": { "description": "Optional. Total steps taken during the exercise.", "type": "string", "format": "int64" }, "distanceMillimeters": { "description": "Optional. Total distance covered by the user during the exercise.", "format": "double", "type": "number" }, "heartRateZoneDurations": { "description": "Optional. Time spent in each heart rate zone.", "$ref": "TimeInHeartRateZones" } }, "description": "Summary metrics for an exercise." }, "VO2Max": { "description": "VO2 max measurement.", "id": "VO2Max", "properties": { "measurementMethod": { "description": "Optional. The method used to measure the VO2 max value.", "enumDescriptions": [ "Unspecified measurement method.", "Fitbit specific, measures VO2 max rate during a run.", "Google specific, measures VO2 max rate for a user based on their demographic data.", "Run as far as possible for 12 minutes. Distance correlated with age and gender translates to a VO2 max value.", "Maximum heart rate divided by the resting heart rate, with a multiplier applied. Does not require any exercise.", "Measured by a medical device called metabolic cart.", "Continuous 20m back-and-forth runs with increasing difficulty, until exhaustion.", "Measured using walking exercise.", "Healthkit specific, measures VO2 max rate by monitoring exercise to the user’s physical limit. Similar to COOPER_TEST or MULTISTAGE_FITNESS_TEST.", "Healthkit specific, estimates VO2 max rate based on low-intensity exercise. Similar to ROCKPORT_FITNESS_TEST.", "Healthkit specific, estimates VO2 max rate without any exercise. Similar to HEART_RATE_RATIO.", "Use when the method is not covered in this enum." ], "enum": [ "MEASUREMENT_METHOD_UNSPECIFIED", "FITBIT_RUN", "GOOGLE_DEMOGRAPHIC", "COOPER_TEST", "HEART_RATE_RATIO", "METABOLIC_CART", "MULTISTAGE_FITNESS_TEST", "ROCKPORT_FITNESS_TEST", "MAX_EXERCISE", "PREDICTION_SUB_MAX_EXERCISE", "PREDICTION_NON_EXERCISE", "OTHER" ], "type": "string" }, "vo2Max": { "description": "Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.", "type": "number", "format": "double" }, "sampleTime": { "$ref": "ObservationSampleTime", "description": "Required. The time at which VO2 max was measured." } }, "type": "object" }, "StageSummary": { "description": "Total duration and segment count for a stage.", "id": "StageSummary", "properties": { "type": { "description": "Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.", "enum": [ "SLEEP_STAGE_TYPE_UNSPECIFIED", "AWAKE", "LIGHT", "DEEP", "REM", "ASLEEP", "RESTLESS" ], "type": "string", "readOnly": true, "enumDescriptions": [ "The default unset value.", "Sleep stage AWAKE.", "Sleep stage LIGHT.", "Sleep stage DEEP.", "Sleep stage REM.", "Sleep stage ASLEEP.", "Sleep stage RESTLESS." ] }, "minutes": { "description": "Output only. Total duration in minutes of a sleep stage.", "readOnly": true, "type": "string", "format": "int64" }, "count": { "type": "string", "format": "int64", "description": "Output only. Number of sleep stages segments.", "readOnly": true } }, "type": "object" }, "SwimLengthsDataRollupValue": { "type": "object", "id": "SwimLengthsDataRollupValue", "properties": { "strokeCountSum": { "description": "Total number of swim strokes in the interval.", "type": "string", "format": "int64" } }, "description": "Represents the result of the rollup of the swim lengths data type." }, "ActiveEnergyBurned": { "type": "object", "id": "ActiveEnergyBurned", "properties": { "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval" }, "kcal": { "format": "double", "type": "number", "description": "Required. Energy burned during an activity, measured in kilocalories." } }, "description": "Energy burned as part of an activity, excluding the basal energy burn." }, "TimeInHeartRateZones": { "type": "object", "id": "TimeInHeartRateZones", "properties": { "lightTime": { "description": "Optional. Time spent in light heart rate zone.", "type": "string", "format": "google-duration" }, "moderateTime": { "description": "Optional. Time spent in moderate heart rate zone.", "format": "google-duration", "type": "string" }, "peakTime": { "description": "Optional. Time spent in peak heart rate zone.", "format": "google-duration", "type": "string" }, "vigorousTime": { "type": "string", "format": "google-duration", "description": "Optional. Time spent in vigorous heart rate zone." } }, "description": "Time spent in each heart rate zone." }, "Weight": { "id": "Weight", "properties": { "sampleTime": { "description": "Required. The time at which the weight was measured", "$ref": "ObservationSampleTime" }, "weightGrams": { "description": "Required. Weight of a user in grams.", "format": "double", "type": "number" }, "notes": { "description": "Optional. Standard free-form notes captured at manual logging.", "type": "string" } }, "description": "Body weight measurement.", "type": "object" }, "NutrientQuantityRollup": { "type": "object", "id": "NutrientQuantityRollup", "properties": { "quantity": { "description": "Required. Aggregated nutrient weight.", "$ref": "WeightQuantityRollup" }, "nutrient": { "type": "string", "enum": [ "NUTRIENT_UNSPECIFIED", "BIOTIN", "CAFFEINE", "CALCIUM", "CHLORIDE", "CARBOHYDRATES", "CHOLESTEROL", "CHROMIUM", "COPPER", "DIETARY_FIBER", "FOLIC_ACID", "IODINE", "IRON", "MAGNESIUM", "MANGANESE", "MOLYBDENUM", "MONOUNSATURATED_FAT", "NIACIN", "PANTOTHENIC_ACID", "PHOSPHORUS", "POLYUNSATURATED_FAT", "POTASSIUM", "PROTEIN", "RIBOFLAVIN", "SATURATED_FAT", "SELENIUM", "SODIUM", "SUGAR", "THIAMIN", "TRANS_FAT", "UNSATURATED_FAT", "VITAMIN_A", "VITAMIN_B12", "VITAMIN_B6", "VITAMIN_C", "VITAMIN_D", "VITAMIN_E", "VITAMIN_K", "ZINC", "FOLATE" ], "description": "Required. Aggregated nutrient.", "enumDescriptions": [ "Unspecified nutrient.", "Value representing biotin nutrient.", "Value representing caffeine nutrient.", "Value representing calcium nutrient.", "Value representing chloride nutrient.", "Value representing carbohydrates nutrient.", "Value representing cholesterol nutrient.", "Value representing chromium nutrient.", "Value representing copper nutrient.", "Value representing dietary fiber nutrient.", "Value representing folic acid nutrient.", "Value representing iodine nutrient.", "Value representing iron nutrient.", "Value representing magnesium nutrient.", "Value representing manganese nutrient.", "Value representing molybdenum nutrient.", "Value representing monounsaturated fat nutrient.", "Value representing niacin nutrient.", "Value representing pantothenic acid nutrient.", "Value representing phosphorus nutrient.", "Value representing polyunsaturated fat nutrient.", "Value representing potassium nutrient.", "Value representing protein nutrient.", "Value representing riboflavin nutrient.", "Value representing saturated fat nutrient.", "Value representing selenium nutrient.", "Value representing sodium nutrient.", "Value representing sugar nutrient.", "Value representing thiamin nutrient.", "Value representing trans fat nutrient.", "Value representing unsaturated fat nutrient.", "Value representing vitamin A nutrient.", "Value representing vitamin B12 nutrient.", "Value representing vitamin B6 nutrient.", "Value representing vitamin C nutrient.", "Value representing vitamin D nutrient.", "Value representing vitamin E nutrient.", "Value representing vitamin K nutrient.", "Value representing zinc nutrient.", "Value representing folate nutrient." ] } }, "description": "Nutrient quantity rollup." }, "SedentaryPeriodRollupValue": { "type": "object", "id": "SedentaryPeriodRollupValue", "properties": { "durationSum": { "type": "string", "format": "google-duration", "description": "The total time user spent sedentary during the interval." } }, "description": "Represents the result of the rollup of the user's sedentary periods." }, "RestingHeartRatePersonalRangeRollupValue": { "type": "object", "description": "Represents the rollup value for the daily resting heart rate data type.", "id": "RestingHeartRatePersonalRangeRollupValue", "properties": { "beatsPerMinuteMax": { "description": "The upper bound of the user's daily resting heart rate personal range.", "format": "double", "type": "number" }, "beatsPerMinuteMin": { "description": "The lower bound of the user's daily resting heart rate personal range.", "type": "number", "format": "double" } } }, "DateTime": { "type": "object", "description": "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.", "id": "DateTime", "properties": { "seconds": { "description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" }, "hours": { "description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "day": { "description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.", "type": "integer", "format": "int32" }, "minutes": { "description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", "format": "int32", "type": "integer" }, "month": { "type": "integer", "format": "int32", "description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month." }, "utcOffset": { "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", "type": "string", "format": "google-duration" }, "timeZone": { "$ref": "TimeZone", "description": "Time zone." }, "year": { "format": "int32", "type": "integer", "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year." }, "nanos": { "description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", "type": "integer", "format": "int32" } } }, "ActiveMinutesRollupByActivityLevel": { "id": "ActiveMinutesRollupByActivityLevel", "properties": { "activityLevel": { "type": "string", "enum": [ "ACTIVITY_LEVEL_UNSPECIFIED", "LIGHT", "MODERATE", "VIGOROUS" ], "description": "The level of activity.", "enumDescriptions": [ "Activity level is unspecified.", "Light activity level.", "Moderate activity level.", "Vigorous activity level." ] }, "activeMinutesSum": { "description": "Number of whole minutes spent in activity.", "format": "int64", "type": "string" } }, "description": "Active minutes by activity level.", "type": "object" }, "TimeInHeartRateZoneRollupValue": { "type": "object", "id": "TimeInHeartRateZoneRollupValue", "properties": { "timeInHeartRateZones": { "description": "List of time spent in each heart rate zone.", "type": "array", "items": { "$ref": "TimeInHeartRateZoneValue" } } }, "description": "Represents the result of the rollup of the time in heart rate zone data type." }, "ActiveZoneMinutes": { "id": "ActiveZoneMinutes", "properties": { "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval." }, "activeZoneMinutes": { "format": "int64", "type": "string", "description": "Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak)." }, "heartRateZone": { "description": "Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.", "enumDescriptions": [ "Unspecified heart rate zone.", "The fat burn heart rate zone.", "The cardio heart rate zone.", "The peak heart rate zone." ], "enum": [ "HEART_RATE_ZONE_UNSPECIFIED", "FAT_BURN", "CARDIO", "PEAK" ], "type": "string" } }, "description": "Record of active zone minutes in a given time interval.", "type": "object" }, "ActiveZoneMinutesRollupValue": { "type": "object", "description": "Represents the result of the rollup of the active zone minutes data type.", "id": "ActiveZoneMinutesRollupValue", "properties": { "sumInFatBurnHeartZone": { "description": "Active zone minutes in `HeartRateZone.FAT_BURN`.", "type": "string", "format": "int64" }, "sumInPeakHeartZone": { "description": "Active zone minutes in `HeartRateZone.PEAK`.", "type": "string", "format": "int64" }, "sumInCardioHeartZone": { "format": "int64", "type": "string", "description": "Active zone minutes in `HeartRateZone.CARDIO`." } } }, "DailyHeartRateVariability": { "type": "object", "id": "DailyHeartRateVariability", "properties": { "entropy": { "description": "Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.", "type": "number", "format": "double" }, "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": { "description": "Optional. The root mean square of successive differences (RMSSD) value during deep sleep.", "type": "number", "format": "double" }, "averageHeartRateVariabilityMilliseconds": { "format": "double", "type": "number", "description": "Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats." }, "date": { "$ref": "Date", "description": "Required. Date (in the user's timezone) of heart rate variability measurement." }, "nonRemHeartRateBeatsPerMinute": { "type": "string", "format": "int64", "description": "Optional. Non-REM heart rate" } }, "description": "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`" }, "Operation": { "id": "Operation", "properties": { "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object" }, "HeartRateZone": { "type": "object", "description": "The heart rate zone.", "id": "HeartRateZone", "properties": { "heartRateZoneType": { "description": "Required. The heart rate zone type.", "enumDescriptions": [ "Unspecified heart rate zone.", "The light heart rate zone.", "The moderate heart rate zone.", "The vigorous heart rate zone.", "The peak heart rate zone." ], "type": "string", "enum": [ "HEART_RATE_ZONE_TYPE_UNSPECIFIED", "LIGHT", "MODERATE", "VIGOROUS", "PEAK" ] }, "minBeatsPerMinute": { "type": "string", "format": "int64", "description": "Required. Minimum heart rate for this zone in beats per minute." }, "maxBeatsPerMinute": { "description": "Required. Maximum heart rate for this zone in beats per minute.", "type": "string", "format": "int64" } } }, "CoreBodyTemperature": { "id": "CoreBodyTemperature", "properties": { "temperatureCelsius": { "format": "double", "type": "number", "description": "Required. The core body temperature in Celsius." }, "measurementLocation": { "enum": [ "MEASUREMENT_LOCATION_UNSPECIFIED", "OTHER", "ARMPIT", "BODY", "EAR", "FINGER", "GASTRO_INTESTINAL", "MOUTH", "RECTUM", "TOE", "EAR_DRUM", "TEMPORAL_ARTERY", "FOREHEAD", "URINARY_BLADDER", "NASAL", "NASOPHARYNGEAL", "WRIST", "VAGINA" ], "type": "string", "description": "Optional. The location of the core body temperature measurement.", "enumDescriptions": [ "Measurement location is unspecified.", "Other measurement location.", "Armpit measurement location.", "Body measurement location.", "Ear measurement location.", "Finger measurement location.", "Gastro-intestinal measurement location.", "Mouth measurement location.", "Rectum measurement location.", "Toe measurement location.", "Ear drum measurement location.", "Temporal artery measurement location.", "Forehead measurement location.", "Urinary bladder measurement location.", "Nasal measurement location.", "Nasopharyngeal measurement location.", "Wrist measurement location.", "Vagina measurement location." ] }, "id": { "description": "Optional. The unique identifier of the core body temperature measurement.", "type": "string" }, "sampleTime": { "description": "Required. The time at which core body temperature was measured.", "$ref": "ObservationSampleTime" } }, "description": "Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs.", "type": "object" }, "BasalEnergyBurned": { "description": "Number of calories burned due to basal metabolic rate (BMR) over a period of time.", "id": "BasalEnergyBurned", "properties": { "kcal": { "type": "number", "format": "double", "description": "Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval." }, "interval": { "$ref": "ObservationTimeInterval", "description": "Required. Observed interval." } }, "type": "object" }, "Profile": { "type": "object", "description": "Profile details.", "id": "Profile", "properties": { "age": { "type": "integer", "format": "int32", "description": "Optional. The age in years based on the user's birth date. Updates to this field are currently not supported." }, "autoRunningStrideLengthMm": { "type": "integer", "format": "int32", "description": "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`", "readOnly": true }, "autoWalkingStrideLengthMm": { "description": "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`", "readOnly": true, "format": "int32", "type": "integer" }, "name": { "description": "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.", "type": "string" }, "membershipStartDate": { "description": "Output only. The date the user created their account. Updates to this field are currently not supported.", "readOnly": true, "$ref": "Date" }, "userConfiguredWalkingStrideLengthMm": { "type": "integer", "format": "int32", "description": "Optional. The user'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`" }, "userConfiguredRunningStrideLengthMm": { "description": "Optional. The user'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`", "format": "int32", "type": "integer" } } }, "HydrationLogRollupValue": { "id": "HydrationLogRollupValue", "properties": { "amountConsumed": { "description": "Rollup for amount consumed.", "$ref": "VolumeQuantityRollup" } }, "description": "Represents the result of the rollup of the hydration log data type.", "type": "object" }, "IrnProfile": { "description": "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.", "id": "IrnProfile", "properties": { "onboardingStatus": { "description": "Required. Whether or not the user has onboarded onto the IRN feature.", "type": "boolean" }, "enrollmentStatus": { "description": "Required. Whether or not the user is currently enrolled in having their data processed for IRN alerts.", "type": "boolean" }, "name": { "description": "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.", "type": "string" }, "updateTime": { "description": "Output only. The timestamp of the last piece of analyzable data synced by the user.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object" }, "SedentaryPeriod": { "id": "SedentaryPeriod", "properties": { "interval": { "description": "Required. Observed interval.", "$ref": "ObservationTimeInterval" } }, "description": "SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device).", "type": "object" }, "Height": { "description": "Body height measurement.", "id": "Height", "properties": { "sampleTime": { "$ref": "ObservationSampleTime", "description": "Required. The time at which the height was recorded." }, "heightMillimeters": { "description": "Required. Height of the user in millimeters.", "type": "string", "format": "int64" } }, "type": "object" }, "WeightQuantityRollup": { "description": "Rollup for the weight.", "id": "WeightQuantityRollup", "properties": { "gramsSum": { "type": "number", "format": "double", "description": "Required. The sum of the weight in grams." }, "userProvidedUnitLast": { "description": "Optional. The user provided unit on the last element.", "enumDescriptions": [ "Unspecified weight unit.", "Value representing gram.", "Value representing kilogram.", "Value representing ounce.", "Value representing pound.", "Value representing stone.", "Value representing milligram.", "Value representing microgram.", "Value representing nanogram." ], "type": "string", "enum": [ "WEIGHT_UNIT_UNSPECIFIED", "GRAM", "KILOGRAM", "OUNCE", "POUND", "STONE", "MILLIGRAM", "MICROGRAM", "NANOGRAM" ] } }, "type": "object" }, "HttpHeader": { "description": "Represents an HTTP header.", "id": "HttpHeader", "properties": { "key": { "description": "The HTTP header key. It is case insensitive.", "type": "string" }, "value": { "description": "The HTTP header value.", "type": "string" } }, "type": "object" }, "Settings": { "type": "object", "description": "Settings details.", "id": "Settings", "properties": { "weightUnit": { "description": "Optional. The measurement unit defined in the user's account settings.", "enumDescriptions": [ "Weight unit is not specified.", "Weight unit is pounds.", "Weight unit is stones.", "Weight unit is kilograms." ], "enum": [ "WEIGHT_UNIT_UNSPECIFIED", "WEIGHT_UNIT_POUNDS", "WEIGHT_UNIT_STONE", "WEIGHT_UNIT_KILOGRAMS" ], "type": "string" }, "distanceUnit": { "type": "string", "enum": [ "DISTANCE_UNIT_UNSPECIFIED", "DISTANCE_UNIT_MILES", "DISTANCE_UNIT_KILOMETERS" ], "description": "Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported.", "enumDescriptions": [ "Distance unit is not specified.", "Distance unit is miles.", "Distance unit is kilometers." ] }, "glucoseUnit": { "type": "string", "enum": [ "GLUCOSE_UNIT_UNSPECIFIED", "GLUCOSE_UNIT_MG_DL", "GLUCOSE_UNIT_MMOL_L" ], "description": "Optional. The measurement unit defined in the user's account settings.", "enumDescriptions": [ "Glucose unit is not specified.", "Glucose unit is mg/dL.", "Glucose unit is mmol/l." ] }, "name": { "description": "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.", "type": "string" }, "heightUnit": { "enum": [ "HEIGHT_UNIT_UNSPECIFIED", "HEIGHT_UNIT_INCHES", "HEIGHT_UNIT_CENTIMETERS" ], "type": "string", "description": "Optional. The measurement unit defined in the user's account settings.", "enumDescriptions": [ "Height unit is not specified.", "Height unit is inches.", "Height unit is cm." ] }, "foodLanguageCode": { "description": "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.", "readOnly": true, "type": "string" }, "waterUnit": { "enum": [ "WATER_UNIT_UNSPECIFIED", "WATER_UNIT_ML", "WATER_UNIT_FL_OZ", "WATER_UNIT_CUP" ], "type": "string", "description": "Optional. The measurement unit defined in the user's account settings.", "enumDescriptions": [ "Water unit is not specified.", "Water unit is milliliters.", "Water unit is fluid ounces.", "Water unit is cups." ] }, "utcOffset": { "format": "google-duration", "type": "string", "description": "Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported." }, "timeZone": { "description": "Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.", "type": "string" }, "swimUnit": { "description": "Optional. The measurement unit defined in the user's account settings.", "enumDescriptions": [ "Swim unit is not specified.", "Swim unit is meters.", "Swim unit is yards." ], "enum": [ "SWIM_UNIT_UNSPECIFIED", "SWIM_UNIT_METERS", "SWIM_UNIT_YARDS" ], "type": "string" }, "temperatureUnit": { "description": "Optional. The measurement unit defined in the user's account settings.", "enumDescriptions": [ "Temperature unit is not specified.", "Temperature unit is Celsius.", "Temperature unit is Fahrenheit." ], "type": "string", "enum": [ "TEMPERATURE_UNIT_UNSPECIFIED", "TEMPERATURE_UNIT_CELSIUS", "TEMPERATURE_UNIT_FAHRENHEIT" ] }, "autoStrideEnabled": { "description": "Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.", "type": "boolean" }, "strideLengthWalkingType": { "type": "string", "enum": [ "STRIDE_LENGTH_TYPE_UNSPECIFIED", "STRIDE_LENGTH_TYPE_DEFAULT", "STRIDE_LENGTH_TYPE_MANUAL", "STRIDE_LENGTH_TYPE_AUTO" ], "description": "Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.", "enumDescriptions": [ "Stride length type is not specified.", "Stride length type is computed based on the user's gender and height.", "Stride length type is manually set by the user.", "Stride length type is determined automatically." ] }, "languageLocale": { "description": "Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.", "type": "string" }, "strideLengthRunningType": { "description": "Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.", "enumDescriptions": [ "Stride length type is not specified.", "Stride length type is computed based on the user's gender and height.", "Stride length type is manually set by the user.", "Stride length type is determined automatically." ], "enum": [ "STRIDE_LENGTH_TYPE_UNSPECIFIED", "STRIDE_LENGTH_TYPE_DEFAULT", "STRIDE_LENGTH_TYPE_MANUAL", "STRIDE_LENGTH_TYPE_AUTO" ], "type": "string" } } }, "CaloriesInHeartRateZoneValue": { "type": "object", "id": "CaloriesInHeartRateZoneValue", "properties": { "heartRateZone": { "description": "The heart rate zone.", "enumDescriptions": [ "Unspecified heart rate zone.", "The light heart rate zone.", "The moderate heart rate zone.", "The vigorous heart rate zone.", "The peak heart rate zone." ], "type": "string", "enum": [ "HEART_RATE_ZONE_TYPE_UNSPECIFIED", "LIGHT", "MODERATE", "VIGOROUS", "PEAK" ] }, "kcal": { "description": "The amount of kilocalories burned in the specified heart rate zone.", "type": "number", "format": "double" } }, "description": "Represents the amount of kilocalories burned in a specific heart rate zone." }, "RollUpDataPointsResponse": { "description": "Response containing the list of rolled up data points.", "id": "RollUpDataPointsResponse", "properties": { "rollupDataPoints": { "description": "Values for each aggregation time window.", "type": "array", "items": { "$ref": "RollupDataPoint" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "RunVO2Max": { "description": "VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min.", "id": "RunVO2Max", "properties": { "sampleTime": { "description": "Required. The time at which the metric was measured.", "$ref": "ObservationSampleTime" }, "runVo2Max": { "description": "Required. Run VO2 max value in ml/kg/min.", "format": "double", "type": "number" } }, "type": "object" }, "DailyRollUpDataPointsResponse": { "id": "DailyRollUpDataPointsResponse", "properties": { "rollupDataPoints": { "type": "array", "items": { "$ref": "DailyRollupDataPoint" }, "description": "Values for each aggregation time window." } }, "description": "Response containing the list of rolled up data points.", "type": "object" }, "CivilDateTime": { "description": "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.", "id": "CivilDateTime", "properties": { "date": { "description": "Required. Calendar date.", "$ref": "Date" }, "time": { "$ref": "TimeOfDay", "description": "Optional. Time of day. Defaults to the start of the day, at midnight if omitted." } }, "type": "object" }, "RollUpDataPointsRequest": { "description": "Request to roll up data points by physical time intervals.", "id": "RollUpDataPointsRequest", "properties": { "dataSourceFamily": { "description": "Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources", "type": "string" }, "windowSize": { "description": "Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.", "format": "google-duration", "type": "string" }, "range": { "description": "Required. Closed-open range of data points that will be rolled up. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days.", "$ref": "Interval" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly." }, "pageToken": { "description": "Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", "type": "string" } }, "type": "object" } }, "servicePath": "", "id": "health:v4", "description": "The Google Health API lets you view and manage health and fitness metrics and measurement data.", "kind": "discovery#restDescription" }