@googleapis/health 6.2.0 → 6.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v4.d.ts +29 -29
- package/build/v4beta.d.ts +30 -30
- package/package.json +1 -1
- package/v4.ts +29 -29
- package/v4beta.ts +30 -30
package/v4beta.ts
CHANGED
|
@@ -761,7 +761,7 @@ export namespace health_v4beta {
|
|
|
761
761
|
*/
|
|
762
762
|
export interface Schema$DailyRollUpDataPointsRequest {
|
|
763
763
|
/**
|
|
764
|
-
* Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/
|
|
764
|
+
* Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/{user\}/dataSourceFamilies/{data_source_family\}` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, retrieved via GetIdentity (e.g. `users/me/dataSourceFamilies/...` or `users/1234567890/dataSourceFamilies/...`). The supported values are: - `users/{user\}/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/{user\}/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/{user\}/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/{user\}/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error.
|
|
765
765
|
*/
|
|
766
766
|
dataSourceFamily?: string | null;
|
|
767
767
|
/**
|
|
@@ -965,7 +965,7 @@ export namespace health_v4beta {
|
|
|
965
965
|
*/
|
|
966
966
|
moods?: Schema$Moods;
|
|
967
967
|
/**
|
|
968
|
-
* 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\}`
|
|
968
|
+
* 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\}` ## Examples: ## `users/me/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` `users/1234567890/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, which can be retrieved by calling GetIdentity (see 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.
|
|
969
969
|
*/
|
|
970
970
|
name?: string | null;
|
|
971
971
|
/**
|
|
@@ -1449,7 +1449,7 @@ export namespace health_v4beta {
|
|
|
1449
1449
|
*/
|
|
1450
1450
|
export interface Schema$GoogleDevicesandservicesHealthV4betaDataType {
|
|
1451
1451
|
/**
|
|
1452
|
-
* Identifier. The resource name of the data type. Format: `users/{user\}/dataTypes/{data_type\}` See DataPoint.name for examples and possible values.
|
|
1452
|
+
* Identifier. The resource name of the data type. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). See DataPoint.name for examples and possible values.
|
|
1453
1453
|
*/
|
|
1454
1454
|
name?: string | null;
|
|
1455
1455
|
}
|
|
@@ -1476,7 +1476,7 @@ export namespace health_v4beta {
|
|
|
1476
1476
|
*/
|
|
1477
1477
|
export interface Schema$GoogleDevicesandservicesHealthV4DataType {
|
|
1478
1478
|
/**
|
|
1479
|
-
* Identifier. The resource name of the data type. Format: `users/{user\}/dataTypes/{data_type\}` See DataPoint.name for examples and possible values.
|
|
1479
|
+
* Identifier. The resource name of the data type. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). See DataPoint.name for examples and possible values.
|
|
1480
1480
|
*/
|
|
1481
1481
|
name?: string | null;
|
|
1482
1482
|
}
|
|
@@ -2356,7 +2356,7 @@ export namespace health_v4beta {
|
|
|
2356
2356
|
*/
|
|
2357
2357
|
dailyVo2Max?: Schema$DailyVO2Max;
|
|
2358
2358
|
/**
|
|
2359
|
-
* 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\}`
|
|
2359
|
+
* 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\}` ## Examples: ## `users/me/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` `users/1234567890/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, which can be retrieved by calling GetIdentity (see 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.
|
|
2360
2360
|
*/
|
|
2361
2361
|
dataPointName?: string | null;
|
|
2362
2362
|
/**
|
|
@@ -2601,7 +2601,7 @@ export namespace health_v4beta {
|
|
|
2601
2601
|
*/
|
|
2602
2602
|
export interface Schema$RollUpDataPointsRequest {
|
|
2603
2603
|
/**
|
|
2604
|
-
* Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/
|
|
2604
|
+
* Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/{user\}/dataSourceFamilies/{data_source_family\}` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, retrieved via GetIdentity (e.g. `users/me/dataSourceFamilies/...` or `users/1234567890/dataSourceFamilies/...`). The supported values are: - `users/{user\}/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/{user\}/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/{user\}/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/{user\}/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error.
|
|
2605
2605
|
*/
|
|
2606
2606
|
dataSourceFamily?: string | null;
|
|
2607
2607
|
/**
|
|
@@ -2824,7 +2824,7 @@ export namespace health_v4beta {
|
|
|
2824
2824
|
weightUnit?: string | null;
|
|
2825
2825
|
}
|
|
2826
2826
|
/**
|
|
2827
|
-
*
|
|
2827
|
+
* Skin temperature measurement.
|
|
2828
2828
|
*/
|
|
2829
2829
|
export interface Schema$SkinTemperature {
|
|
2830
2830
|
/**
|
|
@@ -6055,7 +6055,7 @@ export namespace health_v4beta {
|
|
|
6055
6055
|
*
|
|
6056
6056
|
* // Do the magic
|
|
6057
6057
|
* const res = await health.users.dataTypes.dataPoints.batchDelete({
|
|
6058
|
-
* // Optional. Parent (data type) for the Data Point collection Format: `users/
|
|
6058
|
+
* // Optional. Parent (data type) for the Data Point collection Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/-` - `users/1234567890/dataTypes/-` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). 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.
|
|
6059
6059
|
* parent: 'users/my-user/dataTypes/my-dataType',
|
|
6060
6060
|
*
|
|
6061
6061
|
* // Request body metadata
|
|
@@ -6211,7 +6211,7 @@ export namespace health_v4beta {
|
|
|
6211
6211
|
*
|
|
6212
6212
|
* // Do the magic
|
|
6213
6213
|
* const res = await health.users.dataTypes.dataPoints.create({
|
|
6214
|
-
* // Required. The parent resource name where the data point will be created. Format: `users/{user\}/dataTypes/{data_type\}`
|
|
6214
|
+
* // Required. The parent resource name where the data point will be created. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity).
|
|
6215
6215
|
* parent: 'users/my-user/dataTypes/my-dataType',
|
|
6216
6216
|
*
|
|
6217
6217
|
* // Request body metadata
|
|
@@ -6421,7 +6421,7 @@ export namespace health_v4beta {
|
|
|
6421
6421
|
*
|
|
6422
6422
|
* // Do the magic
|
|
6423
6423
|
* const res = await health.users.dataTypes.dataPoints.dailyRollUp({
|
|
6424
|
-
* // 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.
|
|
6424
|
+
* // Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/distance` - `users/1234567890/dataTypes/distance` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the DailyRollupDataPoint value union field.
|
|
6425
6425
|
* parent: 'users/my-user/dataTypes/my-dataType',
|
|
6426
6426
|
*
|
|
6427
6427
|
* // Request body metadata
|
|
@@ -6547,7 +6547,7 @@ export namespace health_v4beta {
|
|
|
6547
6547
|
}
|
|
6548
6548
|
|
|
6549
6549
|
/**
|
|
6550
|
-
* Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file.
|
|
6550
|
+
* Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. ## Examples: ## `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` `https://health.googleapis.com/v4/users/1234567890/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.
|
|
6551
6551
|
* @example
|
|
6552
6552
|
* ```js
|
|
6553
6553
|
* // Before running the sample:
|
|
@@ -6580,7 +6580,7 @@ export namespace health_v4beta {
|
|
|
6580
6580
|
*
|
|
6581
6581
|
* // Do the magic
|
|
6582
6582
|
* const res = await health.users.dataTypes.dataPoints.exportExerciseTcx({
|
|
6583
|
-
* // Required. The resource name of the exercise data point to export. Format: `users/{user\}/dataTypes/exercise/dataPoints/{data_point\}`
|
|
6583
|
+
* // Required. The resource name of the exercise data point to export. Format: `users/{user\}/dataTypes/exercise/dataPoints/{data_point\}` Examples: - `users/me/dataTypes/exercise/dataPoints/2026443605080188808` - `users/1234567890/dataTypes/exercise/dataPoints/2026443605080188808` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). The `{data_point\}` ID maps to the exercise ID, which is a long integer.
|
|
6584
6584
|
* name: 'users/my-user/dataTypes/my-dataType/dataPoints/my-dataPoint',
|
|
6585
6585
|
* // 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.
|
|
6586
6586
|
* partialData: 'placeholder-value',
|
|
@@ -6740,7 +6740,7 @@ export namespace health_v4beta {
|
|
|
6740
6740
|
*
|
|
6741
6741
|
* // Do the magic
|
|
6742
6742
|
* const res = await health.users.dataTypes.dataPoints.get({
|
|
6743
|
-
* // 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.
|
|
6743
|
+
* // Required. The name of the data point to retrieve. Format: `users/{user\}/dataTypes/{data_type\}/dataPoints/{data_point\}` ## Examples: ## `users/me/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` `users/1234567890/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). See DataPoint.name for examples and possible values.
|
|
6744
6744
|
* name: 'users/my-user/dataTypes/my-dataType/dataPoints/my-dataPoint',
|
|
6745
6745
|
* });
|
|
6746
6746
|
* console.log(res.data);
|
|
@@ -6935,7 +6935,7 @@ export namespace health_v4beta {
|
|
|
6935
6935
|
*
|
|
6936
6936
|
* // Do the magic
|
|
6937
6937
|
* const res = await health.users.dataTypes.dataPoints.list({
|
|
6938
|
-
* // Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/
|
|
6938
|
+
* // Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/{user\}/dataSourceFamilies/{data_source_family\}` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, retrieved via GetIdentity (e.g. `users/me/dataSourceFamilies/...` or `users/1234567890/dataSourceFamilies/...`). The supported values are: - `users/{user\}/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/{user\}/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/{user\}/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/{user\}/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data types may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. Filtering by data source family is not supported for the `sleep`, `food` and `food-measurement-unit` data types, because the underlying listing implementation cannot restrict results by data source. Such requests fail with `INVALID_ARGUMENT` when the data source family is set explicitly, and with `PERMISSION_DENIED` when the restriction is only implied by the caller's scopes. For `sleep`, use ReconcileDataPoints instead.
|
|
6939
6939
|
* dataSourceFamily: 'placeholder-value',
|
|
6940
6940
|
* // 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.
|
|
6941
6941
|
* filter: 'placeholder-value',
|
|
@@ -6943,7 +6943,7 @@ export namespace health_v4beta {
|
|
|
6943
6943
|
* pageSize: 'placeholder-value',
|
|
6944
6944
|
* // Optional. The `next_page_token` from a previous request, if any.
|
|
6945
6945
|
* pageToken: 'placeholder-value',
|
|
6946
|
-
* // Required. Parent data type of the Data Point collection. Format: `users/
|
|
6946
|
+
* // Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/weight` - `users/1234567890/dataTypes/weight` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the DataPoint data union field.
|
|
6947
6947
|
* parent: 'users/my-user/dataTypes/my-dataType',
|
|
6948
6948
|
* });
|
|
6949
6949
|
* console.log(res.data);
|
|
@@ -7090,7 +7090,7 @@ export namespace health_v4beta {
|
|
|
7090
7090
|
*
|
|
7091
7091
|
* // Do the magic
|
|
7092
7092
|
* const res = await health.users.dataTypes.dataPoints.patch({
|
|
7093
|
-
* // 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\}`
|
|
7093
|
+
* // 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\}` ## Examples: ## `users/me/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` `users/1234567890/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, which can be retrieved by calling GetIdentity (see 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.
|
|
7094
7094
|
* name: 'users/my-user/dataTypes/my-dataType/dataPoints/my-dataPoint',
|
|
7095
7095
|
*
|
|
7096
7096
|
* // Request body metadata
|
|
@@ -7297,7 +7297,7 @@ export namespace health_v4beta {
|
|
|
7297
7297
|
*
|
|
7298
7298
|
* // Do the magic
|
|
7299
7299
|
* const res = await health.users.dataTypes.dataPoints.reconcile({
|
|
7300
|
-
* // Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/
|
|
7300
|
+
* // Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/{user\}/dataSourceFamilies/{data_source_family\}` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, retrieved via GetIdentity (e.g. `users/me/dataSourceFamilies/...` or `users/1234567890/dataSourceFamilies/...`). The supported values are: - `users/{user\}/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/{user\}/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/{user\}/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/{user\}/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error.
|
|
7301
7301
|
* dataSourceFamily: 'placeholder-value',
|
|
7302
7302
|
* // 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.
|
|
7303
7303
|
* filter: 'placeholder-value',
|
|
@@ -7305,7 +7305,7 @@ export namespace health_v4beta {
|
|
|
7305
7305
|
* pageSize: 'placeholder-value',
|
|
7306
7306
|
* // Optional. The `next_page_token` from a previous request, if any.
|
|
7307
7307
|
* pageToken: 'placeholder-value',
|
|
7308
|
-
* // Required. Parent data type of the Data Point collection. Format: `users/
|
|
7308
|
+
* // Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/heart-rate` - `users/1234567890/dataTypes/heart-rate` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the DataPoint data union field.
|
|
7309
7309
|
* parent: 'users/my-user/dataTypes/my-dataType',
|
|
7310
7310
|
* });
|
|
7311
7311
|
* console.log(res.data);
|
|
@@ -7464,7 +7464,7 @@ export namespace health_v4beta {
|
|
|
7464
7464
|
*
|
|
7465
7465
|
* // Do the magic
|
|
7466
7466
|
* const res = await health.users.dataTypes.dataPoints.rollUp({
|
|
7467
|
-
* // 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.
|
|
7467
|
+
* // Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/distance` - `users/1234567890/dataTypes/distance` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the RollupDataPoint value union field.
|
|
7468
7468
|
* parent: 'users/my-user/dataTypes/my-dataType',
|
|
7469
7469
|
*
|
|
7470
7470
|
* // Request body metadata
|
|
@@ -7589,7 +7589,7 @@ export namespace health_v4beta {
|
|
|
7589
7589
|
|
|
7590
7590
|
export interface Params$Resource$Users$Datatypes$Datapoints$Batchdelete extends StandardParameters {
|
|
7591
7591
|
/**
|
|
7592
|
-
* Optional. Parent (data type) for the Data Point collection Format: `users/
|
|
7592
|
+
* Optional. Parent (data type) for the Data Point collection Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/-` - `users/1234567890/dataTypes/-` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). 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.
|
|
7593
7593
|
*/
|
|
7594
7594
|
parent?: string;
|
|
7595
7595
|
|
|
@@ -7600,7 +7600,7 @@ export namespace health_v4beta {
|
|
|
7600
7600
|
}
|
|
7601
7601
|
export interface Params$Resource$Users$Datatypes$Datapoints$Create extends StandardParameters {
|
|
7602
7602
|
/**
|
|
7603
|
-
* Required. The parent resource name where the data point will be created. Format: `users/{user\}/dataTypes/{data_type\}`
|
|
7603
|
+
* Required. The parent resource name where the data point will be created. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity).
|
|
7604
7604
|
*/
|
|
7605
7605
|
parent?: string;
|
|
7606
7606
|
|
|
@@ -7611,7 +7611,7 @@ export namespace health_v4beta {
|
|
|
7611
7611
|
}
|
|
7612
7612
|
export interface Params$Resource$Users$Datatypes$Datapoints$Dailyrollup extends StandardParameters {
|
|
7613
7613
|
/**
|
|
7614
|
-
* 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.
|
|
7614
|
+
* Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/distance` - `users/1234567890/dataTypes/distance` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the DailyRollupDataPoint value union field.
|
|
7615
7615
|
*/
|
|
7616
7616
|
parent?: string;
|
|
7617
7617
|
|
|
@@ -7622,7 +7622,7 @@ export namespace health_v4beta {
|
|
|
7622
7622
|
}
|
|
7623
7623
|
export interface Params$Resource$Users$Datatypes$Datapoints$Exportexercisetcx extends StandardParameters {
|
|
7624
7624
|
/**
|
|
7625
|
-
* Required. The resource name of the exercise data point to export. Format: `users/{user\}/dataTypes/exercise/dataPoints/{data_point\}`
|
|
7625
|
+
* Required. The resource name of the exercise data point to export. Format: `users/{user\}/dataTypes/exercise/dataPoints/{data_point\}` Examples: - `users/me/dataTypes/exercise/dataPoints/2026443605080188808` - `users/1234567890/dataTypes/exercise/dataPoints/2026443605080188808` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). The `{data_point\}` ID maps to the exercise ID, which is a long integer.
|
|
7626
7626
|
*/
|
|
7627
7627
|
name?: string;
|
|
7628
7628
|
/**
|
|
@@ -7632,13 +7632,13 @@ export namespace health_v4beta {
|
|
|
7632
7632
|
}
|
|
7633
7633
|
export interface Params$Resource$Users$Datatypes$Datapoints$Get extends StandardParameters {
|
|
7634
7634
|
/**
|
|
7635
|
-
* 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.
|
|
7635
|
+
* Required. The name of the data point to retrieve. Format: `users/{user\}/dataTypes/{data_type\}/dataPoints/{data_point\}` ## Examples: ## `users/me/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` `users/1234567890/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). See DataPoint.name for examples and possible values.
|
|
7636
7636
|
*/
|
|
7637
7637
|
name?: string;
|
|
7638
7638
|
}
|
|
7639
7639
|
export interface Params$Resource$Users$Datatypes$Datapoints$List extends StandardParameters {
|
|
7640
7640
|
/**
|
|
7641
|
-
* Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/
|
|
7641
|
+
* Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/{user\}/dataSourceFamilies/{data_source_family\}` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, retrieved via GetIdentity (e.g. `users/me/dataSourceFamilies/...` or `users/1234567890/dataSourceFamilies/...`). The supported values are: - `users/{user\}/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/{user\}/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/{user\}/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/{user\}/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data types may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. Filtering by data source family is not supported for the `sleep`, `food` and `food-measurement-unit` data types, because the underlying listing implementation cannot restrict results by data source. Such requests fail with `INVALID_ARGUMENT` when the data source family is set explicitly, and with `PERMISSION_DENIED` when the restriction is only implied by the caller's scopes. For `sleep`, use ReconcileDataPoints instead.
|
|
7642
7642
|
*/
|
|
7643
7643
|
dataSourceFamily?: string;
|
|
7644
7644
|
/**
|
|
@@ -7654,13 +7654,13 @@ export namespace health_v4beta {
|
|
|
7654
7654
|
*/
|
|
7655
7655
|
pageToken?: string;
|
|
7656
7656
|
/**
|
|
7657
|
-
* Required. Parent data type of the Data Point collection. Format: `users/
|
|
7657
|
+
* Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/weight` - `users/1234567890/dataTypes/weight` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the DataPoint data union field.
|
|
7658
7658
|
*/
|
|
7659
7659
|
parent?: string;
|
|
7660
7660
|
}
|
|
7661
7661
|
export interface Params$Resource$Users$Datatypes$Datapoints$Patch extends StandardParameters {
|
|
7662
7662
|
/**
|
|
7663
|
-
* 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\}`
|
|
7663
|
+
* 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\}` ## Examples: ## `users/me/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` `users/1234567890/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, which can be retrieved by calling GetIdentity (see 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.
|
|
7664
7664
|
*/
|
|
7665
7665
|
name?: string;
|
|
7666
7666
|
|
|
@@ -7671,7 +7671,7 @@ export namespace health_v4beta {
|
|
|
7671
7671
|
}
|
|
7672
7672
|
export interface Params$Resource$Users$Datatypes$Datapoints$Reconcile extends StandardParameters {
|
|
7673
7673
|
/**
|
|
7674
|
-
* Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/
|
|
7674
|
+
* Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/{user\}/dataSourceFamilies/{data_source_family\}` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID, retrieved via GetIdentity (e.g. `users/me/dataSourceFamilies/...` or `users/1234567890/dataSourceFamilies/...`). The supported values are: - `users/{user\}/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/{user\}/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/{user\}/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/{user\}/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error.
|
|
7675
7675
|
*/
|
|
7676
7676
|
dataSourceFamily?: string;
|
|
7677
7677
|
/**
|
|
@@ -7687,13 +7687,13 @@ export namespace health_v4beta {
|
|
|
7687
7687
|
*/
|
|
7688
7688
|
pageToken?: string;
|
|
7689
7689
|
/**
|
|
7690
|
-
* Required. Parent data type of the Data Point collection. Format: `users/
|
|
7690
|
+
* Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/heart-rate` - `users/1234567890/dataTypes/heart-rate` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the DataPoint data union field.
|
|
7691
7691
|
*/
|
|
7692
7692
|
parent?: string;
|
|
7693
7693
|
}
|
|
7694
7694
|
export interface Params$Resource$Users$Datatypes$Datapoints$Rollup extends StandardParameters {
|
|
7695
7695
|
/**
|
|
7696
|
-
* 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.
|
|
7696
|
+
* Required. Parent data type of the Data Point collection. Format: `users/{user\}/dataTypes/{data_type\}`, e.g.: - `users/me/dataTypes/steps` - `users/1234567890/dataTypes/steps` - `users/me/dataTypes/distance` - `users/1234567890/dataTypes/distance` The `{user\}` can be either the alias `me` or the authenticated user's numeric Health User ID (retrieved via GetIdentity). For a list of the supported data types see the RollupDataPoint value union field.
|
|
7697
7697
|
*/
|
|
7698
7698
|
parent?: string;
|
|
7699
7699
|
|