2026-09-08
▼ ▲ health.projects.subscribers.subscriptions.patch
HTTP Method : PATCH
Description : Updates the data types for an existing user subscription.
Parameter Order : name
Flat Path : v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$
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
Description : Optional. The list of fields to update.
Format : google-fieldmask
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v4beta/{+name}
▼ ▲ health.projects.subscribers.subscriptions.delete
HTTP Method : DELETE
Flat Path : v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}
Parameter Order : name
Description : Deletes a specific user subscription, stopping notifications for this user to this subscriber.
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$
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
Path : v4beta/{+name}
▼ ▲ health.projects.subscribers.subscriptions.create
Parameters :
parent
Pattern : ^projects/[^/]+/subscribers/[^/]+$
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.
Location : path
Type : string
Required : Yes
subscriptionId
Type : string
Location : query
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.
Parameter Order : parent
HTTP Method : POST
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.
Flat Path : v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions
Path : v4beta/{+parent}/subscriptions
▼ ▲ health.projects.subscribers.subscriptions.list
Description : Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.
Flat Path : v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Type : integer
Format : int32
Location : query
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.
filter
Location : query
Type : string
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")
parent
Required : Yes
Location : path
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/[^/]+$
pageToken
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.
Type : string
Location : query
Parameter Order : parent
Path : v4beta/{+parent}/subscriptions
▼ ▲ health.projects.subscribers.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Flat Path : v4beta/projects/{projectsId}/subscribers/{subscribersId}
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.
Pattern : ^projects/[^/]+/subscribers/[^/]+$
Type : string
Required : Yes
Location : path
force
Location : query
Type : boolean
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.
Path : v4beta/{+name}
Parameter Order : name
Description : Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.
▼ ▲ health.projects.subscribers.create
Parameters :
parent
Pattern : ^projects/[^/]+$
Type : string
Description : Required. The parent resource where this subscriber will be created. Format: projects/{project_number} Example: projects/1234567890
Required : Yes
Location : path
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
HTTP Method : POST
Parameter Order : parent
Path : v4beta/{+parent}/subscribers
Flat Path : v4beta/projects/{projectsId}/subscribers
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ health.projects.subscribers.patch
Flat Path : v4beta/projects/{projectsId}/subscribers/{subscribersId}
Parameters :
name
Pattern : ^projects/[^/]+/subscribers/[^/]+$
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
Location : path
Required : Yes
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
Path : v4beta/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : 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.
HTTP Method : PATCH
▼ ▲ health.projects.subscribers.list
Description : Lists all subscribers registered within the owned Google Cloud Project.
Flat Path : v4beta/projects/{projectsId}/subscribers
Parameters :
pageSize
Location : query
Type : integer
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.
pageToken
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.
Type : string
parent
Location : path
Pattern : ^projects/[^/]+$
Type : string
Required : Yes
Description : Required. The parent, which owns this collection of subscribers. Format: projects/{project}
Path : v4beta/{+parent}/subscribers
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : parent
▼ ▲ health.shl.r.get
Parameters :
externalShlId
Location : path
Type : string
Required : Yes
Description : Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q
resourceToken
Required : Yes
Description : Required. Encoded, encrypted message containing resource access details
Type : string
Location : path
Parameter Order :
Description : Forward a resource request for a given SHL
Path : v4beta/shl/r/{externalShlId}/{resourceToken}
HTTP Method : GET
Flat Path : v4beta/shl/r/{externalShlId}/{resourceToken}
▼ ▲ health.shl.m.getShlManifest
HTTP Method : POST
Path : v4beta/shl/m/{externalShlId}
Description : Forward a manifest request for a given SHL
Parameter Order : externalShlId
Parameters :
externalShlId
Type : string
Description : Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q
Location : path
Required : Yes
Flat Path : v4beta/shl/m/{externalShlId}
▼ ▲ health.users.pairedDevices.get
Description : Returns user's Device.
Path : v4beta/{+name}
Flat Path : v4beta/users/{usersId}/pairedDevices/{pairedDevicesId}
Parameters :
name
Type : string
Description : Required. The name of the device to retrieve. Format: users/{user}/devices/{device}
Pattern : ^users/[^/]+/pairedDevices/[^/]+$
Location : path
Required : Yes
Parameter Order : name
Scopes : https://www.googleapis.com/auth/googlehealth.settings.readonly
HTTP Method : GET
▼ ▲ health.users.pairedDevices.list
Flat Path : v4beta/users/{usersId}/pairedDevices
Description : Returns the user's list of paired 1P trackers and smartwatches.
Parameters :
pageSize
Format : int32
Type : integer
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.
Location : query
parent
Location : path
Pattern : ^users/[^/]+$
Description : Required. The parent, which owns this collection of devices. Format: users/{user}
Required : Yes
Type : string
pageToken
Location : query
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.
Type : string
Path : v4beta/{+parent}/pairedDevices
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/googlehealth.settings.readonly
HTTP Method : GET
▼ ▲ health.users.dataTypes.dataPoints.exportExerciseTcx
HTTP Method : GET
Parameter Order : 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.
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}:exportExerciseTcx
Scopes :
Supportsmediadownload : Yes
Path : v4beta/{+name}:exportExerciseTcx
Usemediadownloadservice : Yes
Parameters :
name
Type : string
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.
Pattern : ^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$
Required : Yes
Location : path
partialData
Location : query
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
▼ ▲ health.users.dataTypes.dataPoints.create
Path : v4beta/{+parent}/dataPoints
Scopes :
HTTP Method : POST
Description : Creates a single identifiable data point.
Parameter Order : parent
Parameters :
parent
Description : Required. The parent resource name where the data point will be created. Format: `users/{user}/dataTypes/{data_type}`
Type : string
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Location : path
Required : Yes
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints
▼ ▲ health.users.dataTypes.dataPoints.list
Parameters :
parent
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.
Location : path
Type : string
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
pageSize
Format : int32
Type : integer
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.
Location : query
pageToken
Location : query
Description : Optional. The `next_page_token` from a previous request, if any.
Type : string
filter
Type : string
Location : query
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: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - 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 >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - 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 >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - 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 >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= "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: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - 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 >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order.
Path : v4beta/{+parent}/dataPoints
Description : Query user health and fitness data points.
Scopes :
Parameter Order : parent
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints
HTTP Method : GET
▼ ▲ health.users.dataTypes.dataPoints.get
Scopes :
Parameters :
name
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.
Pattern : ^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$
Location : path
Required : Yes
Description : Get a single identifyable data point.
Path : v4beta/{+name}
Parameter Order : name
HTTP Method : GET
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}
▼ ▲ health.users.dataTypes.dataPoints.reconcile
HTTP Method : GET
Scopes :
Parameters :
pageSize
Location : query
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
Format : int32
filter
Location : query
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
parent
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.
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
Type : string
Location : path
pageToken
Description : Optional. The `next_page_token` from a previous request, if any.
Location : query
Type : string
dataSourceFamily
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}` - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.
Location : query
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:reconcile
Description : Reconcile data points from multiple data sources into a single data stream.
Parameter Order : parent
Path : v4beta/{+parent}/dataPoints:reconcile
▼ ▲ health.users.dataTypes.dataPoints.dailyRollUp
Scopes :
Parameter Order : parent
Path : v4beta/{+parent}/dataPoints:dailyRollUp
Description : Roll up data points over civil time intervals for supported data types.
Parameters :
parent
Pattern : ^users/[^/]+/dataTypes/[^/]+$
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.
Location : path
Type : string
Required : Yes
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:dailyRollUp
HTTP Method : POST
▼ ▲ health.users.dataTypes.dataPoints.rollUp
Description : Roll up data points over physical time intervals for supported data types.
Path : v4beta/{+parent}/dataPoints:rollUp
Parameters :
parent
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Type : string
Location : path
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.
Required : Yes
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:rollUp
Parameter Order : parent
HTTP Method : POST
Scopes :
▼ ▲ health.users.dataTypes.dataPoints.patch
HTTP Method : PATCH
Path : v4beta/{+name}
Parameter Order : name
Description : Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.
Parameters :
name
Location : path
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
Required : Yes
Pattern : ^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$
Scopes :
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}
▼ ▲ health.users.dataTypes.dataPoints.batchDelete
Path : v4beta/{+parent}/dataPoints:batchDelete
Description : Delete a batch of identifyable data points.
Parameters :
parent
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Type : string
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.
Location : path
Required : Yes
Scopes :
Parameter Order : parent
HTTP Method : POST
Flat Path : v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:batchDelete
▼ ▲ health.users.getIdentity
Path : v4beta/{+name}
Flat Path : v4beta/users/{usersId}/identity
Parameters :
name
Location : path
Required : Yes
Pattern : ^users/[^/]+/identity$
Description : Required. The resource name of the Identity. Format: `users/me/identity`
Type : string
Parameter Order : 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.
Scopes :
HTTP Method : GET
▼ ▲ health.users.getProfile
Flat Path : v4beta/users/{usersId}/profile
Scopes : https://www.googleapis.com/auth/googlehealth.profile.readonly
Description : Returns user Profile details.
Parameters :
name
Pattern : ^users/[^/]+/profile$
Type : string
Location : path
Description : Required. The name of the Profile. Format: `users/me/profile`.
Required : Yes
Parameter Order : name
Path : v4beta/{+name}
HTTP Method : GET
▼ ▲ health.users.updateProfile
Parameter Order : name
Scopes : https://www.googleapis.com/auth/googlehealth.profile.writeonly
HTTP Method : PATCH
Parameters :
name
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.
Required : Yes
Location : path
Pattern : ^users/[^/]+/profile$
updateMask
Description : Optional. The list of fields to be updated.
Type : string
Location : query
Format : google-fieldmask
Description : Updates the user's profile details.
Flat Path : v4beta/users/{usersId}/profile
Path : v4beta/{+name}
▼ ▲ health.users.getSettings
Description : Returns user settings details.
Parameters :
name
Description : Required. The name of the Settings. Format: `users/me/settings`.
Required : Yes
Pattern : ^users/[^/]+/settings$
Location : path
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/googlehealth.settings.readonly
Path : v4beta/{+name}
HTTP Method : GET
Flat Path : v4beta/users/{usersId}/settings
▼ ▲ 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.
Required : Yes
Pattern : ^users/[^/]+/irnProfile$
Location : path
Type : string
Description : Returns user's IRN Profile details.
Scopes : https://www.googleapis.com/auth/googlehealth.irn.readonly
HTTP Method : GET
Flat Path : v4beta/users/{usersId}/irnProfile
Path : v4beta/{+name}
Parameter Order : name
▼ ▲ health.users.updateSettings
Description : Updates the user's settings details.
Flat Path : v4beta/users/{usersId}/settings
Scopes : https://www.googleapis.com/auth/googlehealth.settings.writeonly
HTTP Method : PATCH
Parameter Order : name
Path : v4beta/{+name}
Parameters :
updateMask
Location : query
Format : google-fieldmask
Description : Optional. The list of fields to be updated.
Type : string
name
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.
Required : Yes
Location : path
Pattern : ^users/[^/]+/settings$