@googleapis/health 1.0.0 → 3.0.0
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 +22 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v4.d.ts +1714 -139
- package/build/v4.js +334 -0
- package/build/v4.js.map +1 -1
- package/package.json +1 -1
- package/v4.ts +2371 -103
package/build/v4.d.ts
CHANGED
|
@@ -68,9 +68,32 @@ export declare namespace health_v4 {
|
|
|
68
68
|
export class Health {
|
|
69
69
|
context: APIRequestContext;
|
|
70
70
|
projects: Resource$Projects;
|
|
71
|
+
shl: Resource$Shl;
|
|
71
72
|
users: Resource$Users;
|
|
72
73
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
73
74
|
}
|
|
75
|
+
/**
|
|
76
|
+
* Energy burned as part of an activity, excluding the basal energy burn.
|
|
77
|
+
*/
|
|
78
|
+
export interface Schema$ActiveEnergyBurned {
|
|
79
|
+
/**
|
|
80
|
+
* Required. Observed interval
|
|
81
|
+
*/
|
|
82
|
+
interval?: Schema$ObservationTimeInterval;
|
|
83
|
+
/**
|
|
84
|
+
* Required. Energy burned during an activity, measured in kilocalories.
|
|
85
|
+
*/
|
|
86
|
+
kcal?: number | null;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Represents the result of the rollup of active energy burned.
|
|
90
|
+
*/
|
|
91
|
+
export interface Schema$ActiveEnergyBurnedRollupValue {
|
|
92
|
+
/**
|
|
93
|
+
* Output only. Sum of the active energy burned in kilocalories.
|
|
94
|
+
*/
|
|
95
|
+
kcalSum?: number | null;
|
|
96
|
+
}
|
|
74
97
|
/**
|
|
75
98
|
* Record of active minutes in a given time interval.
|
|
76
99
|
*/
|
|
@@ -188,6 +211,43 @@ export declare namespace health_v4 {
|
|
|
188
211
|
*/
|
|
189
212
|
activityLevelRollupsByActivityLevelType?: Schema$ActivityLevelRollupByActivityLevelType[];
|
|
190
213
|
}
|
|
214
|
+
/**
|
|
215
|
+
* 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).
|
|
216
|
+
*/
|
|
217
|
+
export interface Schema$AlertWindow {
|
|
218
|
+
/**
|
|
219
|
+
* Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
|
|
220
|
+
*/
|
|
221
|
+
civilEndTime?: Schema$CivilDateTime;
|
|
222
|
+
/**
|
|
223
|
+
* Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
|
|
224
|
+
*/
|
|
225
|
+
civilStartTime?: Schema$CivilDateTime;
|
|
226
|
+
/**
|
|
227
|
+
* Required. The end time of the analysis window.
|
|
228
|
+
*/
|
|
229
|
+
endTime?: string | null;
|
|
230
|
+
/**
|
|
231
|
+
* Required. The UTC offset of the user's timezone when the analysis window ended.
|
|
232
|
+
*/
|
|
233
|
+
endUtcOffset?: string | null;
|
|
234
|
+
/**
|
|
235
|
+
* Optional. All heart beats in the interval contained in this analysis window.
|
|
236
|
+
*/
|
|
237
|
+
heartBeats?: Schema$HeartBeat[];
|
|
238
|
+
/**
|
|
239
|
+
* 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.
|
|
240
|
+
*/
|
|
241
|
+
positive?: boolean | null;
|
|
242
|
+
/**
|
|
243
|
+
* Required. Observed interval. The start time of the analysis window.
|
|
244
|
+
*/
|
|
245
|
+
startTime?: string | null;
|
|
246
|
+
/**
|
|
247
|
+
* Required. The UTC offset of the user's timezone when the analysis window started.
|
|
248
|
+
*/
|
|
249
|
+
startUtcOffset?: string | null;
|
|
250
|
+
}
|
|
191
251
|
/**
|
|
192
252
|
* Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters.
|
|
193
253
|
*/
|
|
@@ -249,6 +309,48 @@ export declare namespace health_v4 {
|
|
|
249
309
|
*/
|
|
250
310
|
names?: string[] | null;
|
|
251
311
|
}
|
|
312
|
+
/**
|
|
313
|
+
* Represents a blood glucose level measurement. LINT: LEGACY_NAMES
|
|
314
|
+
*/
|
|
315
|
+
export interface Schema$BloodGlucose {
|
|
316
|
+
/**
|
|
317
|
+
* Required. Blood glucose level concentration in mg/dL.
|
|
318
|
+
*/
|
|
319
|
+
bloodGlucoseMilligramsPerDeciliter?: number | null;
|
|
320
|
+
/**
|
|
321
|
+
* Optional. Meal type of the measurement.
|
|
322
|
+
*/
|
|
323
|
+
mealType?: string | null;
|
|
324
|
+
/**
|
|
325
|
+
* Optional. Source of the measurement.
|
|
326
|
+
*/
|
|
327
|
+
measurementSource?: string | null;
|
|
328
|
+
/**
|
|
329
|
+
* Optional. Timing of the measurement.
|
|
330
|
+
*/
|
|
331
|
+
measurementTiming?: string | null;
|
|
332
|
+
/**
|
|
333
|
+
* Optional. Standard free-form notes captured at manual logging.
|
|
334
|
+
*/
|
|
335
|
+
notes?: string | null;
|
|
336
|
+
/**
|
|
337
|
+
* Required. The time at which blood glucose was measured.
|
|
338
|
+
*/
|
|
339
|
+
sampleTime?: Schema$ObservationSampleTime;
|
|
340
|
+
/**
|
|
341
|
+
* Optional. Type of body fluid used to measure the blood glucose.
|
|
342
|
+
*/
|
|
343
|
+
specimen?: string | null;
|
|
344
|
+
}
|
|
345
|
+
/**
|
|
346
|
+
* Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES
|
|
347
|
+
*/
|
|
348
|
+
export interface Schema$BloodGlucoseRollupValue {
|
|
349
|
+
/**
|
|
350
|
+
* Average blood glucose level in mg/dL.
|
|
351
|
+
*/
|
|
352
|
+
bloodGlucoseMilligramsPerDeciliterAvg?: number | null;
|
|
353
|
+
}
|
|
252
354
|
/**
|
|
253
355
|
* Body fat measurement.
|
|
254
356
|
*/
|
|
@@ -319,6 +421,44 @@ export declare namespace health_v4 {
|
|
|
319
421
|
*/
|
|
320
422
|
start?: Schema$CivilDateTime;
|
|
321
423
|
}
|
|
424
|
+
/**
|
|
425
|
+
* Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs.
|
|
426
|
+
*/
|
|
427
|
+
export interface Schema$CoreBodyTemperature {
|
|
428
|
+
/**
|
|
429
|
+
* Optional. The unique identifier of the core body temperature measurement.
|
|
430
|
+
*/
|
|
431
|
+
id?: string | null;
|
|
432
|
+
/**
|
|
433
|
+
* Optional. The location of the core body temperature measurement.
|
|
434
|
+
*/
|
|
435
|
+
measurementLocation?: string | null;
|
|
436
|
+
/**
|
|
437
|
+
* Required. The time at which core body temperature was measured.
|
|
438
|
+
*/
|
|
439
|
+
sampleTime?: Schema$ObservationSampleTime;
|
|
440
|
+
/**
|
|
441
|
+
* Required. The core body temperature in Celsius.
|
|
442
|
+
*/
|
|
443
|
+
temperatureCelsius?: number | null;
|
|
444
|
+
}
|
|
445
|
+
/**
|
|
446
|
+
* Represents the result of the rollup of the core body temperature data type.
|
|
447
|
+
*/
|
|
448
|
+
export interface Schema$CoreBodyTemperatureRollupValue {
|
|
449
|
+
/**
|
|
450
|
+
* Average core body temperature in Celsius.
|
|
451
|
+
*/
|
|
452
|
+
temperatureCelsiusAvg?: number | null;
|
|
453
|
+
/**
|
|
454
|
+
* Maximum core body temperature in Celsius.
|
|
455
|
+
*/
|
|
456
|
+
temperatureCelsiusMax?: number | null;
|
|
457
|
+
/**
|
|
458
|
+
* Minimum core body temperature in Celsius.
|
|
459
|
+
*/
|
|
460
|
+
temperatureCelsiusMin?: number | null;
|
|
461
|
+
}
|
|
322
462
|
/**
|
|
323
463
|
* Payload for creating a subscriber.
|
|
324
464
|
*/
|
|
@@ -336,6 +476,19 @@ export declare namespace health_v4 {
|
|
|
336
476
|
*/
|
|
337
477
|
subscriberConfigs?: Schema$SubscriberConfig[];
|
|
338
478
|
}
|
|
479
|
+
/**
|
|
480
|
+
* Payload for creating a subscription.
|
|
481
|
+
*/
|
|
482
|
+
export interface Schema$CreateSubscriptionPayload {
|
|
483
|
+
/**
|
|
484
|
+
* Optional. Data types subscribed to.
|
|
485
|
+
*/
|
|
486
|
+
dataTypes?: string[] | null;
|
|
487
|
+
/**
|
|
488
|
+
* 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`).
|
|
489
|
+
*/
|
|
490
|
+
user?: string | null;
|
|
491
|
+
}
|
|
339
492
|
/**
|
|
340
493
|
* 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`
|
|
341
494
|
*/
|
|
@@ -439,9 +592,13 @@ export declare namespace health_v4 {
|
|
|
439
592
|
calculationMethod?: string | null;
|
|
440
593
|
}
|
|
441
594
|
/**
|
|
442
|
-
* Value of a daily rollup for a single civil time interval (aggregation window)
|
|
595
|
+
* 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.
|
|
443
596
|
*/
|
|
444
597
|
export interface Schema$DailyRollupDataPoint {
|
|
598
|
+
/**
|
|
599
|
+
* Returned by default when rolling up data points from the `active-energy-burned` data type.
|
|
600
|
+
*/
|
|
601
|
+
activeEnergyBurned?: Schema$ActiveEnergyBurnedRollupValue;
|
|
445
602
|
/**
|
|
446
603
|
* 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.
|
|
447
604
|
*/
|
|
@@ -458,6 +615,10 @@ export declare namespace health_v4 {
|
|
|
458
615
|
* Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.
|
|
459
616
|
*/
|
|
460
617
|
altitude?: Schema$AltitudeRollupValue;
|
|
618
|
+
/**
|
|
619
|
+
* Returned by default when rolling up data points from the `blood-glucose` data type.
|
|
620
|
+
*/
|
|
621
|
+
bloodGlucose?: Schema$BloodGlucoseRollupValue;
|
|
461
622
|
/**
|
|
462
623
|
* 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.
|
|
463
624
|
*/
|
|
@@ -474,6 +635,10 @@ export declare namespace health_v4 {
|
|
|
474
635
|
* Start time of the window this value aggregates over
|
|
475
636
|
*/
|
|
476
637
|
civilStartTime?: Schema$CivilDateTime;
|
|
638
|
+
/**
|
|
639
|
+
* 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.
|
|
640
|
+
*/
|
|
641
|
+
coreBodyTemperature?: Schema$CoreBodyTemperatureRollupValue;
|
|
477
642
|
/**
|
|
478
643
|
* Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.
|
|
479
644
|
*/
|
|
@@ -494,6 +659,10 @@ export declare namespace health_v4 {
|
|
|
494
659
|
* 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.
|
|
495
660
|
*/
|
|
496
661
|
hydrationLog?: Schema$HydrationLogRollupValue;
|
|
662
|
+
/**
|
|
663
|
+
* 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.
|
|
664
|
+
*/
|
|
665
|
+
nutritionLog?: Schema$NutritionLogRollupValue;
|
|
497
666
|
/**
|
|
498
667
|
* 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.
|
|
499
668
|
*/
|
|
@@ -611,6 +780,10 @@ export declare namespace health_v4 {
|
|
|
611
780
|
* A computed or recorded metric.
|
|
612
781
|
*/
|
|
613
782
|
export interface Schema$DataPoint {
|
|
783
|
+
/**
|
|
784
|
+
* Optional. Data for points in the `active-energy-burned` interval data type collection.
|
|
785
|
+
*/
|
|
786
|
+
activeEnergyBurned?: Schema$ActiveEnergyBurned;
|
|
614
787
|
/**
|
|
615
788
|
* Optional. Data for points in the `active-minutes` interval data type collection.
|
|
616
789
|
*/
|
|
@@ -631,10 +804,18 @@ export declare namespace health_v4 {
|
|
|
631
804
|
* Optional. Data for points in the `basal-energy-burned` interval data type collection.
|
|
632
805
|
*/
|
|
633
806
|
basalEnergyBurned?: Schema$BasalEnergyBurned;
|
|
807
|
+
/**
|
|
808
|
+
* Optional. Data for points in the `blood-glucose` sample data type collection.
|
|
809
|
+
*/
|
|
810
|
+
bloodGlucose?: Schema$BloodGlucose;
|
|
634
811
|
/**
|
|
635
812
|
* Optional. Data for points in the `body-fat` sample data type collection.
|
|
636
813
|
*/
|
|
637
814
|
bodyFat?: Schema$BodyFat;
|
|
815
|
+
/**
|
|
816
|
+
* Optional. Data for points in the `core-body-temperature` sample data type collection.
|
|
817
|
+
*/
|
|
818
|
+
coreBodyTemperature?: Schema$CoreBodyTemperature;
|
|
638
819
|
/**
|
|
639
820
|
* Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
|
|
640
821
|
*/
|
|
@@ -671,6 +852,10 @@ export declare namespace health_v4 {
|
|
|
671
852
|
* Optional. Data for points in the `distance` interval data type collection.
|
|
672
853
|
*/
|
|
673
854
|
distance?: Schema$Distance;
|
|
855
|
+
/**
|
|
856
|
+
* Optional. Data for points in the `electrocardiogram` session data type collection.
|
|
857
|
+
*/
|
|
858
|
+
electrocardiogram?: Schema$Electrocardiogram;
|
|
674
859
|
/**
|
|
675
860
|
* Optional. Data for points in the `exercise` session data type collection.
|
|
676
861
|
*/
|
|
@@ -679,6 +864,14 @@ export declare namespace health_v4 {
|
|
|
679
864
|
* Optional. Data for points in the `floors` interval data type collection.
|
|
680
865
|
*/
|
|
681
866
|
floors?: Schema$Floors;
|
|
867
|
+
/**
|
|
868
|
+
* Optional. The food details.
|
|
869
|
+
*/
|
|
870
|
+
food?: Schema$Food;
|
|
871
|
+
/**
|
|
872
|
+
* Optional. The food measurement unit details.
|
|
873
|
+
*/
|
|
874
|
+
foodMeasurementUnit?: Schema$FoodMeasurementUnit;
|
|
682
875
|
/**
|
|
683
876
|
* Optional. Data for points in the `heart-rate` sample data type collection.
|
|
684
877
|
*/
|
|
@@ -696,9 +889,17 @@ export declare namespace health_v4 {
|
|
|
696
889
|
*/
|
|
697
890
|
hydrationLog?: Schema$HydrationLog;
|
|
698
891
|
/**
|
|
699
|
-
*
|
|
892
|
+
* Optional. Data for points in the `irregular-rhythm-notification` session data type collection.
|
|
893
|
+
*/
|
|
894
|
+
irregularRhythmNotification?: Schema$IrregularRhythmNotification;
|
|
895
|
+
/**
|
|
896
|
+
* 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.
|
|
700
897
|
*/
|
|
701
898
|
name?: string | null;
|
|
899
|
+
/**
|
|
900
|
+
* Optional. Data for points in the `nutrition-log` session data type collection.
|
|
901
|
+
*/
|
|
902
|
+
nutritionLog?: Schema$NutritionLog;
|
|
702
903
|
/**
|
|
703
904
|
* Optional. Data for points in the `oxygen-saturation` sample data type collection.
|
|
704
905
|
*/
|
|
@@ -859,7 +1060,49 @@ export declare namespace health_v4 {
|
|
|
859
1060
|
millimetersSum?: string | null;
|
|
860
1061
|
}
|
|
861
1062
|
/**
|
|
862
|
-
*
|
|
1063
|
+
* Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review.
|
|
1064
|
+
*/
|
|
1065
|
+
export interface Schema$Electrocardiogram {
|
|
1066
|
+
/**
|
|
1067
|
+
* Optional. Average heart rate recorded during ECG reading in beats per minute.
|
|
1068
|
+
*/
|
|
1069
|
+
beatsPerMinuteAvg?: string | null;
|
|
1070
|
+
/**
|
|
1071
|
+
* 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.
|
|
1072
|
+
*/
|
|
1073
|
+
interval?: Schema$SessionTimeInterval;
|
|
1074
|
+
/**
|
|
1075
|
+
* Optional. The number of leads used for ECG reading.
|
|
1076
|
+
*/
|
|
1077
|
+
leadNumber?: number | null;
|
|
1078
|
+
/**
|
|
1079
|
+
* 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`.
|
|
1080
|
+
*/
|
|
1081
|
+
medicalDeviceInfo?: Schema$MedicalDeviceInfo;
|
|
1082
|
+
/**
|
|
1083
|
+
* Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.
|
|
1084
|
+
*/
|
|
1085
|
+
millivoltsScalingFactor?: number | null;
|
|
1086
|
+
/**
|
|
1087
|
+
* Optional. The result classification of the ECG reading.
|
|
1088
|
+
*/
|
|
1089
|
+
resultClassification?: string | null;
|
|
1090
|
+
/**
|
|
1091
|
+
* Optional. The sampling frequency of waveform samples in hertz.
|
|
1092
|
+
*/
|
|
1093
|
+
samplingFrequencyHertz?: number | null;
|
|
1094
|
+
/**
|
|
1095
|
+
* 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.
|
|
1096
|
+
*/
|
|
1097
|
+
waveformSamples?: number[] | null;
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* 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); \}
|
|
1101
|
+
*/
|
|
1102
|
+
export interface Schema$Empty {
|
|
1103
|
+
}
|
|
1104
|
+
/**
|
|
1105
|
+
* 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 `GOOGLE-HEALTH-API-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.
|
|
863
1106
|
*/
|
|
864
1107
|
export interface Schema$EndpointAuthorization {
|
|
865
1108
|
/**
|
|
@@ -871,6 +1114,32 @@ export declare namespace health_v4 {
|
|
|
871
1114
|
*/
|
|
872
1115
|
secretSet?: boolean | null;
|
|
873
1116
|
}
|
|
1117
|
+
/**
|
|
1118
|
+
* Represents the energy quantity.
|
|
1119
|
+
*/
|
|
1120
|
+
export interface Schema$EnergyQuantity {
|
|
1121
|
+
/**
|
|
1122
|
+
* Required. The energy value in kilocalories.
|
|
1123
|
+
*/
|
|
1124
|
+
kcal?: number | null;
|
|
1125
|
+
/**
|
|
1126
|
+
* Optional. Value representing the user provided unit.
|
|
1127
|
+
*/
|
|
1128
|
+
userProvidedUnit?: string | null;
|
|
1129
|
+
}
|
|
1130
|
+
/**
|
|
1131
|
+
* Rollup for the energy quantity.
|
|
1132
|
+
*/
|
|
1133
|
+
export interface Schema$EnergyQuantityRollup {
|
|
1134
|
+
/**
|
|
1135
|
+
* Required. The sum of the energy in kilocalories.
|
|
1136
|
+
*/
|
|
1137
|
+
kcalSum?: number | null;
|
|
1138
|
+
/**
|
|
1139
|
+
* Optional. The user provided unit on the last element.
|
|
1140
|
+
*/
|
|
1141
|
+
userProvidedUnitLast?: string | null;
|
|
1142
|
+
}
|
|
874
1143
|
/**
|
|
875
1144
|
* An exercise that stores information about a physical activity.
|
|
876
1145
|
*/
|
|
@@ -959,7 +1228,7 @@ export declare namespace health_v4 {
|
|
|
959
1228
|
*/
|
|
960
1229
|
export interface Schema$ExportExerciseTcxResponse {
|
|
961
1230
|
/**
|
|
962
|
-
* Contains the exported TCX data.
|
|
1231
|
+
* 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.
|
|
963
1232
|
*/
|
|
964
1233
|
tcxData?: string | null;
|
|
965
1234
|
}
|
|
@@ -985,6 +1254,109 @@ export declare namespace health_v4 {
|
|
|
985
1254
|
*/
|
|
986
1255
|
countSum?: string | null;
|
|
987
1256
|
}
|
|
1257
|
+
/**
|
|
1258
|
+
* Represents a food item.
|
|
1259
|
+
*/
|
|
1260
|
+
export interface Schema$Food {
|
|
1261
|
+
/**
|
|
1262
|
+
* Required. The access level of the food.
|
|
1263
|
+
*/
|
|
1264
|
+
accessLevel?: string | null;
|
|
1265
|
+
/**
|
|
1266
|
+
* Optional. The brand of the food.
|
|
1267
|
+
*/
|
|
1268
|
+
brand?: string | null;
|
|
1269
|
+
/**
|
|
1270
|
+
* Required. Value representing the default serving of the food.
|
|
1271
|
+
*/
|
|
1272
|
+
defaultServing?: Schema$FoodServing;
|
|
1273
|
+
/**
|
|
1274
|
+
* Optional. The description of the food.
|
|
1275
|
+
*/
|
|
1276
|
+
description?: string | null;
|
|
1277
|
+
/**
|
|
1278
|
+
* Required. The display name of the food.
|
|
1279
|
+
*/
|
|
1280
|
+
displayName?: string | null;
|
|
1281
|
+
/**
|
|
1282
|
+
* Optional. Value representing the average energy of the food for the default serving.
|
|
1283
|
+
*/
|
|
1284
|
+
energyAvg?: Schema$EnergyQuantity;
|
|
1285
|
+
/**
|
|
1286
|
+
* Optional. Value representing the energy from fat of the food for the default serving.
|
|
1287
|
+
*/
|
|
1288
|
+
energyFromFat?: Schema$EnergyQuantity;
|
|
1289
|
+
/**
|
|
1290
|
+
* Optional. Value representing the maximum energy of the food for the default serving.
|
|
1291
|
+
*/
|
|
1292
|
+
energyMax?: Schema$EnergyQuantity;
|
|
1293
|
+
/**
|
|
1294
|
+
* Optional. Value representing the minimum energy of the food for the default serving.
|
|
1295
|
+
*/
|
|
1296
|
+
energyMin?: Schema$EnergyQuantity;
|
|
1297
|
+
/**
|
|
1298
|
+
* Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.
|
|
1299
|
+
*/
|
|
1300
|
+
languageCode?: string | null;
|
|
1301
|
+
/**
|
|
1302
|
+
* Optional. The meal type associated with this food.
|
|
1303
|
+
*/
|
|
1304
|
+
mealType?: string | null;
|
|
1305
|
+
/**
|
|
1306
|
+
* Optional. Value representing the nutrients of the food for the default serving.
|
|
1307
|
+
*/
|
|
1308
|
+
nutrients?: Schema$NutrientQuantity[];
|
|
1309
|
+
/**
|
|
1310
|
+
* Optional. The serving of the food.
|
|
1311
|
+
*/
|
|
1312
|
+
servings?: Schema$FoodServing[];
|
|
1313
|
+
/**
|
|
1314
|
+
* Optional. Value representing the total carbohydrate of the food for the default serving.
|
|
1315
|
+
*/
|
|
1316
|
+
totalCarbohydrate?: Schema$WeightQuantity;
|
|
1317
|
+
/**
|
|
1318
|
+
* Optional. Value representing the total fat of the food for the default serving.
|
|
1319
|
+
*/
|
|
1320
|
+
totalFat?: Schema$WeightQuantity;
|
|
1321
|
+
}
|
|
1322
|
+
/**
|
|
1323
|
+
* Represents a food measurement unit.
|
|
1324
|
+
*/
|
|
1325
|
+
export interface Schema$FoodMeasurementUnit {
|
|
1326
|
+
/**
|
|
1327
|
+
* Required. The display name of the food measurement unit (e.g., "gram", "piece").
|
|
1328
|
+
*/
|
|
1329
|
+
displayName?: string | null;
|
|
1330
|
+
/**
|
|
1331
|
+
* Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces").
|
|
1332
|
+
*/
|
|
1333
|
+
pluralDisplayName?: string | null;
|
|
1334
|
+
}
|
|
1335
|
+
/**
|
|
1336
|
+
* Represents different properties and information about the serving of a specific food.
|
|
1337
|
+
*/
|
|
1338
|
+
export interface Schema$FoodServing {
|
|
1339
|
+
/**
|
|
1340
|
+
* Optional. Amount of food consumed, fractional values are supported.
|
|
1341
|
+
*/
|
|
1342
|
+
amount?: number | null;
|
|
1343
|
+
/**
|
|
1344
|
+
* Required. Food measurement unit
|
|
1345
|
+
*/
|
|
1346
|
+
foodMeasurementUnit?: string | null;
|
|
1347
|
+
/**
|
|
1348
|
+
* Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
|
|
1349
|
+
*/
|
|
1350
|
+
foodMeasurementUnitDisplayName?: string | null;
|
|
1351
|
+
/**
|
|
1352
|
+
* Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
|
|
1353
|
+
*/
|
|
1354
|
+
foodMeasurementUnitDisplayNamePlural?: string | null;
|
|
1355
|
+
/**
|
|
1356
|
+
* Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
|
|
1357
|
+
*/
|
|
1358
|
+
multiplier?: number | null;
|
|
1359
|
+
}
|
|
988
1360
|
/**
|
|
989
1361
|
* 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.
|
|
990
1362
|
*/
|
|
@@ -994,6 +1366,15 @@ export declare namespace health_v4 {
|
|
|
994
1366
|
*/
|
|
995
1367
|
name?: string | null;
|
|
996
1368
|
}
|
|
1369
|
+
/**
|
|
1370
|
+
* 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.
|
|
1371
|
+
*/
|
|
1372
|
+
export interface Schema$GoogleDevicesandservicesHealthV4User {
|
|
1373
|
+
/**
|
|
1374
|
+
* 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\}`
|
|
1375
|
+
*/
|
|
1376
|
+
name?: string | null;
|
|
1377
|
+
}
|
|
997
1378
|
/**
|
|
998
1379
|
* 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.
|
|
999
1380
|
*/
|
|
@@ -1003,6 +1384,27 @@ export declare namespace health_v4 {
|
|
|
1003
1384
|
*/
|
|
1004
1385
|
httpResponse?: Schema$HttpResponse;
|
|
1005
1386
|
}
|
|
1387
|
+
/**
|
|
1388
|
+
* A single heart beat measurement.
|
|
1389
|
+
*/
|
|
1390
|
+
export interface Schema$HeartBeat {
|
|
1391
|
+
/**
|
|
1392
|
+
* 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).
|
|
1393
|
+
*/
|
|
1394
|
+
beatsPerMinute?: number | null;
|
|
1395
|
+
/**
|
|
1396
|
+
* Output only. The civil time in the timezone the subject is in at the time of the observation.
|
|
1397
|
+
*/
|
|
1398
|
+
civilTime?: Schema$CivilDateTime;
|
|
1399
|
+
/**
|
|
1400
|
+
* Required. The time of the heart beat measurement.
|
|
1401
|
+
*/
|
|
1402
|
+
physicalTime?: string | null;
|
|
1403
|
+
/**
|
|
1404
|
+
* Required. The UTC offset of the user's timezone when the heart beat measurement occurred.
|
|
1405
|
+
*/
|
|
1406
|
+
utcOffset?: string | null;
|
|
1407
|
+
}
|
|
1006
1408
|
/**
|
|
1007
1409
|
* A heart rate measurement.
|
|
1008
1410
|
*/
|
|
@@ -1055,7 +1457,7 @@ export declare namespace health_v4 {
|
|
|
1055
1457
|
*/
|
|
1056
1458
|
export interface Schema$HeartRateVariability {
|
|
1057
1459
|
/**
|
|
1058
|
-
* Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by
|
|
1460
|
+
* Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.
|
|
1059
1461
|
*/
|
|
1060
1462
|
rootMeanSquareOfSuccessiveDifferencesMilliseconds?: number | null;
|
|
1061
1463
|
/**
|
|
@@ -1110,6 +1512,25 @@ export declare namespace health_v4 {
|
|
|
1110
1512
|
*/
|
|
1111
1513
|
sampleTime?: Schema$ObservationSampleTime;
|
|
1112
1514
|
}
|
|
1515
|
+
/**
|
|
1516
|
+
* Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; \} service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); \} Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); \} Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
|
|
1517
|
+
*/
|
|
1518
|
+
export interface Schema$HttpBody {
|
|
1519
|
+
/**
|
|
1520
|
+
* The HTTP Content-Type header value specifying the content type of the body.
|
|
1521
|
+
*/
|
|
1522
|
+
contentType?: string | null;
|
|
1523
|
+
/**
|
|
1524
|
+
* The HTTP request/response body as raw binary.
|
|
1525
|
+
*/
|
|
1526
|
+
data?: string | null;
|
|
1527
|
+
/**
|
|
1528
|
+
* Application specific response metadata. Must be set in the first response for streaming APIs.
|
|
1529
|
+
*/
|
|
1530
|
+
extensions?: Array<{
|
|
1531
|
+
[key: string]: any;
|
|
1532
|
+
}> | null;
|
|
1533
|
+
}
|
|
1113
1534
|
/**
|
|
1114
1535
|
* Represents an HTTP header.
|
|
1115
1536
|
*/
|
|
@@ -1197,18 +1618,69 @@ export declare namespace health_v4 {
|
|
|
1197
1618
|
startTime?: string | null;
|
|
1198
1619
|
}
|
|
1199
1620
|
/**
|
|
1200
|
-
*
|
|
1621
|
+
* 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.
|
|
1201
1622
|
*/
|
|
1202
|
-
export interface Schema$
|
|
1623
|
+
export interface Schema$IrnProfile {
|
|
1203
1624
|
/**
|
|
1204
|
-
*
|
|
1625
|
+
* Required. Whether or not the user is currently enrolled in having their data processed for IRN alerts.
|
|
1205
1626
|
*/
|
|
1206
|
-
|
|
1627
|
+
enrollmentStatus?: boolean | null;
|
|
1628
|
+
/**
|
|
1629
|
+
* 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.
|
|
1630
|
+
*/
|
|
1631
|
+
name?: string | null;
|
|
1632
|
+
/**
|
|
1633
|
+
* Required. Whether or not the user has onboarded onto the IRN feature.
|
|
1634
|
+
*/
|
|
1635
|
+
onboardingStatus?: boolean | null;
|
|
1636
|
+
/**
|
|
1637
|
+
* Output only. The timestamp of the last piece of analyzable data synced by the user.
|
|
1638
|
+
*/
|
|
1639
|
+
updateTime?: string | null;
|
|
1640
|
+
}
|
|
1641
|
+
/**
|
|
1642
|
+
* 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.
|
|
1643
|
+
*/
|
|
1644
|
+
export interface Schema$IrregularRhythmNotification {
|
|
1645
|
+
/**
|
|
1646
|
+
* Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.
|
|
1647
|
+
*/
|
|
1648
|
+
alertWindows?: Schema$AlertWindow[];
|
|
1649
|
+
/**
|
|
1650
|
+
* Required. Observed interval.
|
|
1651
|
+
*/
|
|
1652
|
+
interval?: Schema$SessionTimeInterval;
|
|
1653
|
+
/**
|
|
1654
|
+
* 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`.
|
|
1655
|
+
*/
|
|
1656
|
+
medicalDeviceInfo?: Schema$MedicalDeviceInfo;
|
|
1657
|
+
}
|
|
1658
|
+
/**
|
|
1659
|
+
* Response containing raw data points matching the query
|
|
1660
|
+
*/
|
|
1661
|
+
export interface Schema$ListDataPointsResponse {
|
|
1662
|
+
/**
|
|
1663
|
+
* Data points matching the query
|
|
1664
|
+
*/
|
|
1665
|
+
dataPoints?: Schema$DataPoint[];
|
|
1207
1666
|
/**
|
|
1208
1667
|
* Next page token, empty if the response is complete
|
|
1209
1668
|
*/
|
|
1210
1669
|
nextPageToken?: string | null;
|
|
1211
1670
|
}
|
|
1671
|
+
/**
|
|
1672
|
+
* Response message for ListPairedDevices.
|
|
1673
|
+
*/
|
|
1674
|
+
export interface Schema$ListPairedDevicesResponse {
|
|
1675
|
+
/**
|
|
1676
|
+
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1677
|
+
*/
|
|
1678
|
+
nextPageToken?: string | null;
|
|
1679
|
+
/**
|
|
1680
|
+
* The paired devices of the user.
|
|
1681
|
+
*/
|
|
1682
|
+
pairedDevices?: Schema$PairedDevice[];
|
|
1683
|
+
}
|
|
1212
1684
|
/**
|
|
1213
1685
|
* Response message for ListSubscribers.
|
|
1214
1686
|
*/
|
|
@@ -1226,6 +1698,61 @@ export declare namespace health_v4 {
|
|
|
1226
1698
|
*/
|
|
1227
1699
|
totalSize?: number | null;
|
|
1228
1700
|
}
|
|
1701
|
+
/**
|
|
1702
|
+
* Response message for ListSubscriptions.
|
|
1703
|
+
*/
|
|
1704
|
+
export interface Schema$ListSubscriptionsResponse {
|
|
1705
|
+
/**
|
|
1706
|
+
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1707
|
+
*/
|
|
1708
|
+
nextPageToken?: string | null;
|
|
1709
|
+
/**
|
|
1710
|
+
* The subscriptions from the specified subscriber.
|
|
1711
|
+
*/
|
|
1712
|
+
subscriptions?: Schema$Subscription[];
|
|
1713
|
+
}
|
|
1714
|
+
/**
|
|
1715
|
+
* Represents the POST body contained in a GetShlManifestRequest This message is nested to represent that See https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-link-manifest-request
|
|
1716
|
+
*/
|
|
1717
|
+
export interface Schema$ManifestParams {
|
|
1718
|
+
/**
|
|
1719
|
+
* Optional. Integer upper bound on the length of embedded payloads
|
|
1720
|
+
*/
|
|
1721
|
+
embeddedLengthMax?: number | null;
|
|
1722
|
+
/**
|
|
1723
|
+
* Optional.
|
|
1724
|
+
*/
|
|
1725
|
+
passcode?: string | null;
|
|
1726
|
+
/**
|
|
1727
|
+
* Required. A string describing the recipient (e.g.,the name of an organization or person) suitable for display to the Receiving User
|
|
1728
|
+
*/
|
|
1729
|
+
recipient?: string | null;
|
|
1730
|
+
}
|
|
1731
|
+
/**
|
|
1732
|
+
* Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI).
|
|
1733
|
+
*/
|
|
1734
|
+
export interface Schema$MedicalDeviceInfo {
|
|
1735
|
+
/**
|
|
1736
|
+
* Output only. The algorithm version used by the feature.
|
|
1737
|
+
*/
|
|
1738
|
+
algorithmVersion?: string | null;
|
|
1739
|
+
/**
|
|
1740
|
+
* Output only. The model name or device type of the compatible device used to collect the data.
|
|
1741
|
+
*/
|
|
1742
|
+
deviceModel?: string | null;
|
|
1743
|
+
/**
|
|
1744
|
+
* Output only. The version of the feature/app running on the device.
|
|
1745
|
+
*/
|
|
1746
|
+
featureVersion?: string | null;
|
|
1747
|
+
/**
|
|
1748
|
+
* Output only. The firmware version running on the compatible device used to collect the data.
|
|
1749
|
+
*/
|
|
1750
|
+
firmwareVersion?: string | null;
|
|
1751
|
+
/**
|
|
1752
|
+
* Output only. The service version used by the feature.
|
|
1753
|
+
*/
|
|
1754
|
+
serviceVersion?: string | null;
|
|
1755
|
+
}
|
|
1229
1756
|
/**
|
|
1230
1757
|
* Summary metrics for an exercise.
|
|
1231
1758
|
*/
|
|
@@ -1304,6 +1831,102 @@ export declare namespace health_v4 {
|
|
|
1304
1831
|
*/
|
|
1305
1832
|
avgVerticalRatio?: number | null;
|
|
1306
1833
|
}
|
|
1834
|
+
/**
|
|
1835
|
+
* Represents the quantity of a nutrient.
|
|
1836
|
+
*/
|
|
1837
|
+
export interface Schema$NutrientQuantity {
|
|
1838
|
+
/**
|
|
1839
|
+
* Required. The nutrient type.
|
|
1840
|
+
*/
|
|
1841
|
+
nutrient?: string | null;
|
|
1842
|
+
/**
|
|
1843
|
+
* Required. The quantity of the nutrient, measured in grams.
|
|
1844
|
+
*/
|
|
1845
|
+
quantity?: Schema$WeightQuantity;
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* Nutrient quantity rollup.
|
|
1849
|
+
*/
|
|
1850
|
+
export interface Schema$NutrientQuantityRollup {
|
|
1851
|
+
/**
|
|
1852
|
+
* Required. Aggregated nutrient.
|
|
1853
|
+
*/
|
|
1854
|
+
nutrient?: string | null;
|
|
1855
|
+
/**
|
|
1856
|
+
* Required. Aggregated nutrient weight.
|
|
1857
|
+
*/
|
|
1858
|
+
quantity?: Schema$WeightQuantityRollup;
|
|
1859
|
+
}
|
|
1860
|
+
/**
|
|
1861
|
+
* Holds information about food logged by a user. 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 editable.
|
|
1862
|
+
*/
|
|
1863
|
+
export interface Schema$NutritionLog {
|
|
1864
|
+
/**
|
|
1865
|
+
* Optional. The total energy of the food, measured in kilocalories (`kcal`).
|
|
1866
|
+
*/
|
|
1867
|
+
energy?: Schema$EnergyQuantity;
|
|
1868
|
+
/**
|
|
1869
|
+
* Optional. The energy from fat, measured in kilocalories (`kcal`).
|
|
1870
|
+
*/
|
|
1871
|
+
energyFromFat?: Schema$EnergyQuantity;
|
|
1872
|
+
/**
|
|
1873
|
+
* Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.
|
|
1874
|
+
*/
|
|
1875
|
+
food?: string | null;
|
|
1876
|
+
/**
|
|
1877
|
+
* The display name of the food. For identified food logs, this is populated automatically from the referenced food.
|
|
1878
|
+
*/
|
|
1879
|
+
foodDisplayName?: string | null;
|
|
1880
|
+
/**
|
|
1881
|
+
* Required. The time window when the food was logged.
|
|
1882
|
+
*/
|
|
1883
|
+
interval?: Schema$SessionTimeInterval;
|
|
1884
|
+
/**
|
|
1885
|
+
* Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.
|
|
1886
|
+
*/
|
|
1887
|
+
mealType?: string | null;
|
|
1888
|
+
/**
|
|
1889
|
+
* Optional. An array of individual nutrient values for the nutrition log.
|
|
1890
|
+
*/
|
|
1891
|
+
nutrients?: Schema$NutrientQuantity[];
|
|
1892
|
+
/**
|
|
1893
|
+
* Optional. The serving information for the logged food.
|
|
1894
|
+
*/
|
|
1895
|
+
serving?: Schema$Serving;
|
|
1896
|
+
/**
|
|
1897
|
+
* Optional. The total carbohydrate content, measured in grams.
|
|
1898
|
+
*/
|
|
1899
|
+
totalCarbohydrate?: Schema$WeightQuantity;
|
|
1900
|
+
/**
|
|
1901
|
+
* Optional. The total fat content, measured in grams.
|
|
1902
|
+
*/
|
|
1903
|
+
totalFat?: Schema$WeightQuantity;
|
|
1904
|
+
}
|
|
1905
|
+
/**
|
|
1906
|
+
* Represents the result of the rollup of the nutrition log data type.
|
|
1907
|
+
*/
|
|
1908
|
+
export interface Schema$NutritionLogRollupValue {
|
|
1909
|
+
/**
|
|
1910
|
+
* Energy rollup.
|
|
1911
|
+
*/
|
|
1912
|
+
energy?: Schema$EnergyQuantityRollup;
|
|
1913
|
+
/**
|
|
1914
|
+
* Value Energy from fat rollup.
|
|
1915
|
+
*/
|
|
1916
|
+
energyFromFat?: Schema$EnergyQuantityRollup;
|
|
1917
|
+
/**
|
|
1918
|
+
* List of the nutrient roll-ups by the nutrient type.
|
|
1919
|
+
*/
|
|
1920
|
+
nutrients?: Schema$NutrientQuantityRollup[];
|
|
1921
|
+
/**
|
|
1922
|
+
* Total carbohydrate rollup.
|
|
1923
|
+
*/
|
|
1924
|
+
totalCarbohydrate?: Schema$WeightQuantityRollup;
|
|
1925
|
+
/**
|
|
1926
|
+
* Total fat rollup.
|
|
1927
|
+
*/
|
|
1928
|
+
totalFat?: Schema$WeightQuantityRollup;
|
|
1929
|
+
}
|
|
1307
1930
|
/**
|
|
1308
1931
|
* Represents a sample time of an observed data point.
|
|
1309
1932
|
*/
|
|
@@ -1413,6 +2036,43 @@ export declare namespace health_v4 {
|
|
|
1413
2036
|
*/
|
|
1414
2037
|
sampleTime?: Schema$ObservationSampleTime;
|
|
1415
2038
|
}
|
|
2039
|
+
/**
|
|
2040
|
+
* 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.
|
|
2041
|
+
*/
|
|
2042
|
+
export interface Schema$PairedDevice {
|
|
2043
|
+
/**
|
|
2044
|
+
* Output only. The battery level of the device.
|
|
2045
|
+
*/
|
|
2046
|
+
batteryLevel?: number | null;
|
|
2047
|
+
/**
|
|
2048
|
+
* Output only. The battery status of the device. Supported: High | Medium | Low | Empty
|
|
2049
|
+
*/
|
|
2050
|
+
batteryStatus?: string | null;
|
|
2051
|
+
/**
|
|
2052
|
+
* Output only. The device type. Supported: TRACKER | SCALE
|
|
2053
|
+
*/
|
|
2054
|
+
deviceType?: string | null;
|
|
2055
|
+
/**
|
|
2056
|
+
* Output only. The product name of the device
|
|
2057
|
+
*/
|
|
2058
|
+
deviceVersion?: string | null;
|
|
2059
|
+
/**
|
|
2060
|
+
* 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.
|
|
2061
|
+
*/
|
|
2062
|
+
features?: string[] | null;
|
|
2063
|
+
/**
|
|
2064
|
+
* Output only. The time of last sync with the Fitbit mobile application.
|
|
2065
|
+
*/
|
|
2066
|
+
lastSyncTime?: string | null;
|
|
2067
|
+
/**
|
|
2068
|
+
* Output only. Mac ID number of the device.
|
|
2069
|
+
*/
|
|
2070
|
+
macAddress?: string | null;
|
|
2071
|
+
/**
|
|
2072
|
+
* Identifier. The resource name of this Device resource. Format: `users/{user\}/pairedDevices/{paired_device\}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`
|
|
2073
|
+
*/
|
|
2074
|
+
name?: string | null;
|
|
2075
|
+
}
|
|
1416
2076
|
/**
|
|
1417
2077
|
* Profile details.
|
|
1418
2078
|
*/
|
|
@@ -1463,6 +2123,10 @@ export declare namespace health_v4 {
|
|
|
1463
2123
|
* A reconciled computed or recorded metric.
|
|
1464
2124
|
*/
|
|
1465
2125
|
export interface Schema$ReconciledDataPoint {
|
|
2126
|
+
/**
|
|
2127
|
+
* Data for points in the `active-energy-burned` interval data type collection.
|
|
2128
|
+
*/
|
|
2129
|
+
activeEnergyBurned?: Schema$ActiveEnergyBurned;
|
|
1466
2130
|
/**
|
|
1467
2131
|
* Data for points in the `active-minutes` interval data type collection.
|
|
1468
2132
|
*/
|
|
@@ -1483,10 +2147,18 @@ export declare namespace health_v4 {
|
|
|
1483
2147
|
* Data for points in the `basal-energy-burned` interval data type collection.
|
|
1484
2148
|
*/
|
|
1485
2149
|
basalEnergyBurned?: Schema$BasalEnergyBurned;
|
|
2150
|
+
/**
|
|
2151
|
+
* Data for points in the `blood-glucose` sample data type collection.
|
|
2152
|
+
*/
|
|
2153
|
+
bloodGlucose?: Schema$BloodGlucose;
|
|
1486
2154
|
/**
|
|
1487
2155
|
* Data for points in the `body-fat` sample data type collection.
|
|
1488
2156
|
*/
|
|
1489
2157
|
bodyFat?: Schema$BodyFat;
|
|
2158
|
+
/**
|
|
2159
|
+
* Data for points in the `core-body-temperature` sample data type collection.
|
|
2160
|
+
*/
|
|
2161
|
+
coreBodyTemperature?: Schema$CoreBodyTemperature;
|
|
1490
2162
|
/**
|
|
1491
2163
|
* Data for points in the `daily-heart-rate-variability` daily data type collection.
|
|
1492
2164
|
*/
|
|
@@ -1516,7 +2188,7 @@ export declare namespace health_v4 {
|
|
|
1516
2188
|
*/
|
|
1517
2189
|
dailyVo2Max?: Schema$DailyVO2Max;
|
|
1518
2190
|
/**
|
|
1519
|
-
* 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. `
|
|
2191
|
+
* 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.
|
|
1520
2192
|
*/
|
|
1521
2193
|
dataPointName?: string | null;
|
|
1522
2194
|
/**
|
|
@@ -1547,6 +2219,10 @@ export declare namespace health_v4 {
|
|
|
1547
2219
|
* Data for points in the `hydration-log` session data type collection.
|
|
1548
2220
|
*/
|
|
1549
2221
|
hydrationLog?: Schema$HydrationLog;
|
|
2222
|
+
/**
|
|
2223
|
+
* Data for points in the `nutrition-log` session data type collection.
|
|
2224
|
+
*/
|
|
2225
|
+
nutritionLog?: Schema$NutritionLog;
|
|
1550
2226
|
/**
|
|
1551
2227
|
* Data for points in the `oxygen-saturation` sample data type collection.
|
|
1552
2228
|
*/
|
|
@@ -1644,9 +2320,13 @@ export declare namespace health_v4 {
|
|
|
1644
2320
|
beatsPerMinuteMin?: number | null;
|
|
1645
2321
|
}
|
|
1646
2322
|
/**
|
|
1647
|
-
* Value of a rollup for a single physical time interval (aggregation window)
|
|
2323
|
+
* 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.
|
|
1648
2324
|
*/
|
|
1649
2325
|
export interface Schema$RollupDataPoint {
|
|
2326
|
+
/**
|
|
2327
|
+
* Returned by default when rolling up data points from the `active-energy-burned` data type.
|
|
2328
|
+
*/
|
|
2329
|
+
activeEnergyBurned?: Schema$ActiveEnergyBurnedRollupValue;
|
|
1650
2330
|
/**
|
|
1651
2331
|
* 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.
|
|
1652
2332
|
*/
|
|
@@ -1663,6 +2343,10 @@ export declare namespace health_v4 {
|
|
|
1663
2343
|
* Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.
|
|
1664
2344
|
*/
|
|
1665
2345
|
altitude?: Schema$AltitudeRollupValue;
|
|
2346
|
+
/**
|
|
2347
|
+
* Returned by default when rolling up data points from the `blood-glucose` data type.
|
|
2348
|
+
*/
|
|
2349
|
+
bloodGlucose?: Schema$BloodGlucoseRollupValue;
|
|
1666
2350
|
/**
|
|
1667
2351
|
* 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.
|
|
1668
2352
|
*/
|
|
@@ -1671,6 +2355,10 @@ export declare namespace health_v4 {
|
|
|
1671
2355
|
* 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.
|
|
1672
2356
|
*/
|
|
1673
2357
|
caloriesInHeartRateZone?: Schema$CaloriesInHeartRateZoneRollupValue;
|
|
2358
|
+
/**
|
|
2359
|
+
* 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.
|
|
2360
|
+
*/
|
|
2361
|
+
coreBodyTemperature?: Schema$CoreBodyTemperatureRollupValue;
|
|
1674
2362
|
/**
|
|
1675
2363
|
* Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.
|
|
1676
2364
|
*/
|
|
@@ -1691,6 +2379,10 @@ export declare namespace health_v4 {
|
|
|
1691
2379
|
* 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.
|
|
1692
2380
|
*/
|
|
1693
2381
|
hydrationLog?: Schema$HydrationLogRollupValue;
|
|
2382
|
+
/**
|
|
2383
|
+
* 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.
|
|
2384
|
+
*/
|
|
2385
|
+
nutritionLog?: Schema$NutritionLogRollupValue;
|
|
1694
2386
|
/**
|
|
1695
2387
|
* 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.
|
|
1696
2388
|
*/
|
|
@@ -1745,7 +2437,7 @@ export declare namespace health_v4 {
|
|
|
1745
2437
|
*/
|
|
1746
2438
|
range?: Schema$Interval;
|
|
1747
2439
|
/**
|
|
1748
|
-
* Required. The size of the time window to group data points into before applying the aggregation functions.
|
|
2440
|
+
* Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.
|
|
1749
2441
|
*/
|
|
1750
2442
|
windowSize?: string | null;
|
|
1751
2443
|
}
|
|
@@ -1810,6 +2502,23 @@ export declare namespace health_v4 {
|
|
|
1810
2502
|
*/
|
|
1811
2503
|
durationSum?: string | null;
|
|
1812
2504
|
}
|
|
2505
|
+
/**
|
|
2506
|
+
* Represents different properties and information about the serving of a specific food.
|
|
2507
|
+
*/
|
|
2508
|
+
export interface Schema$Serving {
|
|
2509
|
+
/**
|
|
2510
|
+
* Optional. The number of servings.
|
|
2511
|
+
*/
|
|
2512
|
+
amount?: number | null;
|
|
2513
|
+
/**
|
|
2514
|
+
* Required. Food measurement unit
|
|
2515
|
+
*/
|
|
2516
|
+
foodMeasurementUnit?: string | null;
|
|
2517
|
+
/**
|
|
2518
|
+
* Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
|
|
2519
|
+
*/
|
|
2520
|
+
foodMeasurementUnitDisplayName?: string | null;
|
|
2521
|
+
}
|
|
1813
2522
|
/**
|
|
1814
2523
|
* Represents a time interval of session data point, which bundles multiple observed metrics together.
|
|
1815
2524
|
*/
|
|
@@ -1851,6 +2560,10 @@ export declare namespace health_v4 {
|
|
|
1851
2560
|
* Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported.
|
|
1852
2561
|
*/
|
|
1853
2562
|
distanceUnit?: string | null;
|
|
2563
|
+
/**
|
|
2564
|
+
* 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.
|
|
2565
|
+
*/
|
|
2566
|
+
foodLanguageCode?: string | null;
|
|
1854
2567
|
/**
|
|
1855
2568
|
* Optional. The measurement unit defined in the user's account settings.
|
|
1856
2569
|
*/
|
|
@@ -1913,7 +2626,7 @@ export declare namespace health_v4 {
|
|
|
1913
2626
|
*/
|
|
1914
2627
|
interval?: Schema$SessionTimeInterval;
|
|
1915
2628
|
/**
|
|
1916
|
-
* Optional. Sleep metadata:
|
|
2629
|
+
* Optional. Sleep metadata: `processed`, `main_sleep`, `manually_edited`, and `stages_status`.
|
|
1917
2630
|
*/
|
|
1918
2631
|
metadata?: Schema$SleepMetadata;
|
|
1919
2632
|
/**
|
|
@@ -1945,6 +2658,10 @@ export declare namespace health_v4 {
|
|
|
1945
2658
|
* Optional. Sleep identifier relevant in the context of the data source.
|
|
1946
2659
|
*/
|
|
1947
2660
|
externalId?: string | null;
|
|
2661
|
+
/**
|
|
2662
|
+
* Output only. `main_sleep`: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the `main_sleep`. If there are multiple days of sleep in the response, there is one `main_sleep` per day.
|
|
2663
|
+
*/
|
|
2664
|
+
mainSleep?: boolean | null;
|
|
1948
2665
|
/**
|
|
1949
2666
|
* Output only. Some sleeps autodetected by algorithms can be manually edited by users.
|
|
1950
2667
|
*/
|
|
@@ -1954,7 +2671,7 @@ export declare namespace health_v4 {
|
|
|
1954
2671
|
*/
|
|
1955
2672
|
nap?: boolean | null;
|
|
1956
2673
|
/**
|
|
1957
|
-
* Output only. Sleep and sleep stages algorithms finished processing.
|
|
2674
|
+
* 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.
|
|
1958
2675
|
*/
|
|
1959
2676
|
processed?: boolean | null;
|
|
1960
2677
|
/**
|
|
@@ -2153,7 +2870,7 @@ export declare namespace health_v4 {
|
|
|
2153
2870
|
*/
|
|
2154
2871
|
export interface Schema$SubscriberConfig {
|
|
2155
2872
|
/**
|
|
2156
|
-
* Required.
|
|
2873
|
+
* 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.
|
|
2157
2874
|
*/
|
|
2158
2875
|
dataTypes?: string[] | null;
|
|
2159
2876
|
/**
|
|
@@ -2161,6 +2878,23 @@ export declare namespace health_v4 {
|
|
|
2161
2878
|
*/
|
|
2162
2879
|
subscriptionCreatePolicy?: string | null;
|
|
2163
2880
|
}
|
|
2881
|
+
/**
|
|
2882
|
+
* A subscription to a data collection for a specific user, to be delivered to a subscriber.
|
|
2883
|
+
*/
|
|
2884
|
+
export interface Schema$Subscription {
|
|
2885
|
+
/**
|
|
2886
|
+
* 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".
|
|
2887
|
+
*/
|
|
2888
|
+
dataTypes?: string[] | null;
|
|
2889
|
+
/**
|
|
2890
|
+
* 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.
|
|
2891
|
+
*/
|
|
2892
|
+
name?: string | null;
|
|
2893
|
+
/**
|
|
2894
|
+
* 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`).
|
|
2895
|
+
*/
|
|
2896
|
+
user?: string | null;
|
|
2897
|
+
}
|
|
2164
2898
|
/**
|
|
2165
2899
|
* Swim lengths data over the time interval.
|
|
2166
2900
|
*/
|
|
@@ -2278,7 +3012,7 @@ export declare namespace health_v4 {
|
|
|
2278
3012
|
version?: string | null;
|
|
2279
3013
|
}
|
|
2280
3014
|
/**
|
|
2281
|
-
* Represents the result of the rollup of the user's total calories.
|
|
3015
|
+
* Represents the result of the rollup of the user's total calories. Note: Queries for the `total-calories` data type must include a time interval filter (such as `total_calories.interval.start_time` or `total_calories.interval.civil_start_time`). The maximum range is 14 days. Example filter query: `total_calories.interval.start_time \>= "2026-04-20T00:00:00Z" AND total_calories.interval.start_time < "2026-04-21T00:00:00Z"`
|
|
2282
3016
|
*/
|
|
2283
3017
|
export interface Schema$TotalCaloriesRollupValue {
|
|
2284
3018
|
/**
|
|
@@ -2312,7 +3046,7 @@ export declare namespace health_v4 {
|
|
|
2312
3046
|
*/
|
|
2313
3047
|
milliliters?: number | null;
|
|
2314
3048
|
/**
|
|
2315
|
-
* Optional. Value representing the user provided unit.
|
|
3049
|
+
* 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.
|
|
2316
3050
|
*/
|
|
2317
3051
|
userProvidedUnit?: string | null;
|
|
2318
3052
|
}
|
|
@@ -2346,6 +3080,32 @@ export declare namespace health_v4 {
|
|
|
2346
3080
|
*/
|
|
2347
3081
|
weightGrams?: number | null;
|
|
2348
3082
|
}
|
|
3083
|
+
/**
|
|
3084
|
+
* Represents the weight quantity.
|
|
3085
|
+
*/
|
|
3086
|
+
export interface Schema$WeightQuantity {
|
|
3087
|
+
/**
|
|
3088
|
+
* Required. The weight value in grams.
|
|
3089
|
+
*/
|
|
3090
|
+
grams?: number | null;
|
|
3091
|
+
/**
|
|
3092
|
+
* Optional. Value representing the user provided unit.
|
|
3093
|
+
*/
|
|
3094
|
+
userProvidedUnit?: string | null;
|
|
3095
|
+
}
|
|
3096
|
+
/**
|
|
3097
|
+
* Rollup for the weight.
|
|
3098
|
+
*/
|
|
3099
|
+
export interface Schema$WeightQuantityRollup {
|
|
3100
|
+
/**
|
|
3101
|
+
* Required. The sum of the weight in grams.
|
|
3102
|
+
*/
|
|
3103
|
+
gramsSum?: number | null;
|
|
3104
|
+
/**
|
|
3105
|
+
* Optional. The user provided unit on the last element.
|
|
3106
|
+
*/
|
|
3107
|
+
userProvidedUnitLast?: string | null;
|
|
3108
|
+
}
|
|
2349
3109
|
/**
|
|
2350
3110
|
* Represents the result of the rollup of the weight data type.
|
|
2351
3111
|
*/
|
|
@@ -2362,6 +3122,7 @@ export declare namespace health_v4 {
|
|
|
2362
3122
|
}
|
|
2363
3123
|
export class Resource$Projects$Subscribers {
|
|
2364
3124
|
context: APIRequestContext;
|
|
3125
|
+
subscriptions: Resource$Projects$Subscribers$Subscriptions;
|
|
2365
3126
|
constructor(context: APIRequestContext);
|
|
2366
3127
|
/**
|
|
2367
3128
|
* 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.
|
|
@@ -2394,7 +3155,7 @@ export declare namespace health_v4 {
|
|
|
2394
3155
|
*
|
|
2395
3156
|
* // Do the magic
|
|
2396
3157
|
* const res = await health.projects.subscribers.create({
|
|
2397
|
-
* // Required. The parent resource where this subscriber will be created. Format: projects/{
|
|
3158
|
+
* // Required. The parent resource where this subscriber will be created. Format: projects/{project_number\} Example: projects/1234567890
|
|
2398
3159
|
* parent: 'projects/my-project',
|
|
2399
3160
|
* // 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])/.
|
|
2400
3161
|
* subscriberId: 'placeholder-value',
|
|
@@ -2572,7 +3333,643 @@ export declare namespace health_v4 {
|
|
|
2572
3333
|
list(params: Params$Resource$Projects$Subscribers$List, callback: BodyResponseCallback<Schema$ListSubscribersResponse>): void;
|
|
2573
3334
|
list(callback: BodyResponseCallback<Schema$ListSubscribersResponse>): void;
|
|
2574
3335
|
/**
|
|
2575
|
-
* 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.
|
|
3336
|
+
* 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.
|
|
3337
|
+
* @example
|
|
3338
|
+
* ```js
|
|
3339
|
+
* // Before running the sample:
|
|
3340
|
+
* // - Enable the API at:
|
|
3341
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
3342
|
+
* // - Login into gcloud by running:
|
|
3343
|
+
* // ```sh
|
|
3344
|
+
* // $ gcloud auth application-default login
|
|
3345
|
+
* // ```
|
|
3346
|
+
* // - Install the npm module by running:
|
|
3347
|
+
* // ```sh
|
|
3348
|
+
* // $ npm install googleapis
|
|
3349
|
+
* // ```
|
|
3350
|
+
*
|
|
3351
|
+
* const {google} = require('googleapis');
|
|
3352
|
+
* const health = google.health('v4');
|
|
3353
|
+
*
|
|
3354
|
+
* async function main() {
|
|
3355
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3356
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3357
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3358
|
+
* });
|
|
3359
|
+
*
|
|
3360
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3361
|
+
* const authClient = await auth.getClient();
|
|
3362
|
+
* google.options({auth: authClient});
|
|
3363
|
+
*
|
|
3364
|
+
* // Do the magic
|
|
3365
|
+
* const res = await health.projects.subscribers.patch({
|
|
3366
|
+
* // 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
|
|
3367
|
+
* name: 'projects/my-project/subscribers/my-subscriber',
|
|
3368
|
+
* // 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
|
|
3369
|
+
* updateMask: 'placeholder-value',
|
|
3370
|
+
*
|
|
3371
|
+
* // Request body metadata
|
|
3372
|
+
* requestBody: {
|
|
3373
|
+
* // request body parameters
|
|
3374
|
+
* // {
|
|
3375
|
+
* // "createTime": "my_createTime",
|
|
3376
|
+
* // "endpointAuthorization": {},
|
|
3377
|
+
* // "endpointUri": "my_endpointUri",
|
|
3378
|
+
* // "name": "my_name",
|
|
3379
|
+
* // "state": "my_state",
|
|
3380
|
+
* // "subscriberConfigs": [],
|
|
3381
|
+
* // "updateTime": "my_updateTime"
|
|
3382
|
+
* // }
|
|
3383
|
+
* },
|
|
3384
|
+
* });
|
|
3385
|
+
* console.log(res.data);
|
|
3386
|
+
*
|
|
3387
|
+
* // Example response
|
|
3388
|
+
* // {
|
|
3389
|
+
* // "done": false,
|
|
3390
|
+
* // "error": {},
|
|
3391
|
+
* // "metadata": {},
|
|
3392
|
+
* // "name": "my_name",
|
|
3393
|
+
* // "response": {}
|
|
3394
|
+
* // }
|
|
3395
|
+
* }
|
|
3396
|
+
*
|
|
3397
|
+
* main().catch(e => {
|
|
3398
|
+
* console.error(e);
|
|
3399
|
+
* throw e;
|
|
3400
|
+
* });
|
|
3401
|
+
*
|
|
3402
|
+
* ```
|
|
3403
|
+
*
|
|
3404
|
+
* @param params - Parameters for request
|
|
3405
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3406
|
+
* @param callback - Optional callback that handles the response.
|
|
3407
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3408
|
+
*/
|
|
3409
|
+
patch(params: Params$Resource$Projects$Subscribers$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3410
|
+
patch(params?: Params$Resource$Projects$Subscribers$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3411
|
+
patch(params: Params$Resource$Projects$Subscribers$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3412
|
+
patch(params: Params$Resource$Projects$Subscribers$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3413
|
+
patch(params: Params$Resource$Projects$Subscribers$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3414
|
+
patch(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3415
|
+
}
|
|
3416
|
+
export interface Params$Resource$Projects$Subscribers$Create extends StandardParameters {
|
|
3417
|
+
/**
|
|
3418
|
+
* Required. The parent resource where this subscriber will be created. Format: projects/{project_number\} Example: projects/1234567890
|
|
3419
|
+
*/
|
|
3420
|
+
parent?: string;
|
|
3421
|
+
/**
|
|
3422
|
+
* 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])/.
|
|
3423
|
+
*/
|
|
3424
|
+
subscriberId?: string;
|
|
3425
|
+
/**
|
|
3426
|
+
* Request body metadata
|
|
3427
|
+
*/
|
|
3428
|
+
requestBody?: Schema$CreateSubscriberPayload;
|
|
3429
|
+
}
|
|
3430
|
+
export interface Params$Resource$Projects$Subscribers$Delete extends StandardParameters {
|
|
3431
|
+
/**
|
|
3432
|
+
* 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.
|
|
3433
|
+
*/
|
|
3434
|
+
force?: boolean;
|
|
3435
|
+
/**
|
|
3436
|
+
* 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.
|
|
3437
|
+
*/
|
|
3438
|
+
name?: string;
|
|
3439
|
+
}
|
|
3440
|
+
export interface Params$Resource$Projects$Subscribers$List extends StandardParameters {
|
|
3441
|
+
/**
|
|
3442
|
+
* 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.
|
|
3443
|
+
*/
|
|
3444
|
+
pageSize?: number;
|
|
3445
|
+
/**
|
|
3446
|
+
* 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.
|
|
3447
|
+
*/
|
|
3448
|
+
pageToken?: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* Required. The parent, which owns this collection of subscribers. Format: projects/{project\}
|
|
3451
|
+
*/
|
|
3452
|
+
parent?: string;
|
|
3453
|
+
}
|
|
3454
|
+
export interface Params$Resource$Projects$Subscribers$Patch extends StandardParameters {
|
|
3455
|
+
/**
|
|
3456
|
+
* 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
|
|
3457
|
+
*/
|
|
3458
|
+
name?: string;
|
|
3459
|
+
/**
|
|
3460
|
+
* 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
|
|
3461
|
+
*/
|
|
3462
|
+
updateMask?: string;
|
|
3463
|
+
/**
|
|
3464
|
+
* Request body metadata
|
|
3465
|
+
*/
|
|
3466
|
+
requestBody?: Schema$Subscriber;
|
|
3467
|
+
}
|
|
3468
|
+
export class Resource$Projects$Subscribers$Subscriptions {
|
|
3469
|
+
context: APIRequestContext;
|
|
3470
|
+
constructor(context: APIRequestContext);
|
|
3471
|
+
/**
|
|
3472
|
+
* 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.
|
|
3473
|
+
* @example
|
|
3474
|
+
* ```js
|
|
3475
|
+
* // Before running the sample:
|
|
3476
|
+
* // - Enable the API at:
|
|
3477
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
3478
|
+
* // - Login into gcloud by running:
|
|
3479
|
+
* // ```sh
|
|
3480
|
+
* // $ gcloud auth application-default login
|
|
3481
|
+
* // ```
|
|
3482
|
+
* // - Install the npm module by running:
|
|
3483
|
+
* // ```sh
|
|
3484
|
+
* // $ npm install googleapis
|
|
3485
|
+
* // ```
|
|
3486
|
+
*
|
|
3487
|
+
* const {google} = require('googleapis');
|
|
3488
|
+
* const health = google.health('v4');
|
|
3489
|
+
*
|
|
3490
|
+
* async function main() {
|
|
3491
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3492
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3493
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3494
|
+
* });
|
|
3495
|
+
*
|
|
3496
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3497
|
+
* const authClient = await auth.getClient();
|
|
3498
|
+
* google.options({auth: authClient});
|
|
3499
|
+
*
|
|
3500
|
+
* // Do the magic
|
|
3501
|
+
* const res = await health.projects.subscribers.subscriptions.create({
|
|
3502
|
+
* // 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.
|
|
3503
|
+
* parent: 'projects/my-project/subscribers/my-subscriber',
|
|
3504
|
+
* // 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.
|
|
3505
|
+
* subscriptionId: 'placeholder-value',
|
|
3506
|
+
*
|
|
3507
|
+
* // Request body metadata
|
|
3508
|
+
* requestBody: {
|
|
3509
|
+
* // request body parameters
|
|
3510
|
+
* // {
|
|
3511
|
+
* // "dataTypes": [],
|
|
3512
|
+
* // "user": "my_user"
|
|
3513
|
+
* // }
|
|
3514
|
+
* },
|
|
3515
|
+
* });
|
|
3516
|
+
* console.log(res.data);
|
|
3517
|
+
*
|
|
3518
|
+
* // Example response
|
|
3519
|
+
* // {
|
|
3520
|
+
* // "dataTypes": [],
|
|
3521
|
+
* // "name": "my_name",
|
|
3522
|
+
* // "user": "my_user"
|
|
3523
|
+
* // }
|
|
3524
|
+
* }
|
|
3525
|
+
*
|
|
3526
|
+
* main().catch(e => {
|
|
3527
|
+
* console.error(e);
|
|
3528
|
+
* throw e;
|
|
3529
|
+
* });
|
|
3530
|
+
*
|
|
3531
|
+
* ```
|
|
3532
|
+
*
|
|
3533
|
+
* @param params - Parameters for request
|
|
3534
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3535
|
+
* @param callback - Optional callback that handles the response.
|
|
3536
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3537
|
+
*/
|
|
3538
|
+
create(params: Params$Resource$Projects$Subscribers$Subscriptions$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3539
|
+
create(params?: Params$Resource$Projects$Subscribers$Subscriptions$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Subscription>>;
|
|
3540
|
+
create(params: Params$Resource$Projects$Subscribers$Subscriptions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3541
|
+
create(params: Params$Resource$Projects$Subscribers$Subscriptions$Create, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
|
|
3542
|
+
create(params: Params$Resource$Projects$Subscribers$Subscriptions$Create, callback: BodyResponseCallback<Schema$Subscription>): void;
|
|
3543
|
+
create(callback: BodyResponseCallback<Schema$Subscription>): void;
|
|
3544
|
+
/**
|
|
3545
|
+
* Deletes a specific user subscription, stopping notifications for this user to this subscriber.
|
|
3546
|
+
* @example
|
|
3547
|
+
* ```js
|
|
3548
|
+
* // Before running the sample:
|
|
3549
|
+
* // - Enable the API at:
|
|
3550
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
3551
|
+
* // - Login into gcloud by running:
|
|
3552
|
+
* // ```sh
|
|
3553
|
+
* // $ gcloud auth application-default login
|
|
3554
|
+
* // ```
|
|
3555
|
+
* // - Install the npm module by running:
|
|
3556
|
+
* // ```sh
|
|
3557
|
+
* // $ npm install googleapis
|
|
3558
|
+
* // ```
|
|
3559
|
+
*
|
|
3560
|
+
* const {google} = require('googleapis');
|
|
3561
|
+
* const health = google.health('v4');
|
|
3562
|
+
*
|
|
3563
|
+
* async function main() {
|
|
3564
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3565
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3566
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3567
|
+
* });
|
|
3568
|
+
*
|
|
3569
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3570
|
+
* const authClient = await auth.getClient();
|
|
3571
|
+
* google.options({auth: authClient});
|
|
3572
|
+
*
|
|
3573
|
+
* // Do the magic
|
|
3574
|
+
* const res = await health.projects.subscribers.subscriptions.delete({
|
|
3575
|
+
* // 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.
|
|
3576
|
+
* name: 'projects/my-project/subscribers/my-subscriber/subscriptions/my-subscription',
|
|
3577
|
+
* });
|
|
3578
|
+
* console.log(res.data);
|
|
3579
|
+
*
|
|
3580
|
+
* // Example response
|
|
3581
|
+
* // {}
|
|
3582
|
+
* }
|
|
3583
|
+
*
|
|
3584
|
+
* main().catch(e => {
|
|
3585
|
+
* console.error(e);
|
|
3586
|
+
* throw e;
|
|
3587
|
+
* });
|
|
3588
|
+
*
|
|
3589
|
+
* ```
|
|
3590
|
+
*
|
|
3591
|
+
* @param params - Parameters for request
|
|
3592
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3593
|
+
* @param callback - Optional callback that handles the response.
|
|
3594
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3595
|
+
*/
|
|
3596
|
+
delete(params: Params$Resource$Projects$Subscribers$Subscriptions$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3597
|
+
delete(params?: Params$Resource$Projects$Subscribers$Subscriptions$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
|
|
3598
|
+
delete(params: Params$Resource$Projects$Subscribers$Subscriptions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3599
|
+
delete(params: Params$Resource$Projects$Subscribers$Subscriptions$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3600
|
+
delete(params: Params$Resource$Projects$Subscribers$Subscriptions$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3601
|
+
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3602
|
+
/**
|
|
3603
|
+
* Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.
|
|
3604
|
+
* @example
|
|
3605
|
+
* ```js
|
|
3606
|
+
* // Before running the sample:
|
|
3607
|
+
* // - Enable the API at:
|
|
3608
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
3609
|
+
* // - Login into gcloud by running:
|
|
3610
|
+
* // ```sh
|
|
3611
|
+
* // $ gcloud auth application-default login
|
|
3612
|
+
* // ```
|
|
3613
|
+
* // - Install the npm module by running:
|
|
3614
|
+
* // ```sh
|
|
3615
|
+
* // $ npm install googleapis
|
|
3616
|
+
* // ```
|
|
3617
|
+
*
|
|
3618
|
+
* const {google} = require('googleapis');
|
|
3619
|
+
* const health = google.health('v4');
|
|
3620
|
+
*
|
|
3621
|
+
* async function main() {
|
|
3622
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3623
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3624
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3625
|
+
* });
|
|
3626
|
+
*
|
|
3627
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3628
|
+
* const authClient = await auth.getClient();
|
|
3629
|
+
* google.options({auth: authClient});
|
|
3630
|
+
*
|
|
3631
|
+
* // Do the magic
|
|
3632
|
+
* const res = await health.projects.subscribers.subscriptions.list({
|
|
3633
|
+
* // 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")
|
|
3634
|
+
* filter: 'placeholder-value',
|
|
3635
|
+
* // 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.
|
|
3636
|
+
* pageSize: 'placeholder-value',
|
|
3637
|
+
* // 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.
|
|
3638
|
+
* pageToken: 'placeholder-value',
|
|
3639
|
+
* // 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.
|
|
3640
|
+
* parent: 'projects/my-project/subscribers/my-subscriber',
|
|
3641
|
+
* });
|
|
3642
|
+
* console.log(res.data);
|
|
3643
|
+
*
|
|
3644
|
+
* // Example response
|
|
3645
|
+
* // {
|
|
3646
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
3647
|
+
* // "subscriptions": []
|
|
3648
|
+
* // }
|
|
3649
|
+
* }
|
|
3650
|
+
*
|
|
3651
|
+
* main().catch(e => {
|
|
3652
|
+
* console.error(e);
|
|
3653
|
+
* throw e;
|
|
3654
|
+
* });
|
|
3655
|
+
*
|
|
3656
|
+
* ```
|
|
3657
|
+
*
|
|
3658
|
+
* @param params - Parameters for request
|
|
3659
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3660
|
+
* @param callback - Optional callback that handles the response.
|
|
3661
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3662
|
+
*/
|
|
3663
|
+
list(params: Params$Resource$Projects$Subscribers$Subscriptions$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3664
|
+
list(params?: Params$Resource$Projects$Subscribers$Subscriptions$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListSubscriptionsResponse>>;
|
|
3665
|
+
list(params: Params$Resource$Projects$Subscribers$Subscriptions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3666
|
+
list(params: Params$Resource$Projects$Subscribers$Subscriptions$List, options: MethodOptions | BodyResponseCallback<Schema$ListSubscriptionsResponse>, callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>): void;
|
|
3667
|
+
list(params: Params$Resource$Projects$Subscribers$Subscriptions$List, callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>): void;
|
|
3668
|
+
list(callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>): void;
|
|
3669
|
+
/**
|
|
3670
|
+
* Updates the data types for an existing user subscription.
|
|
3671
|
+
* @example
|
|
3672
|
+
* ```js
|
|
3673
|
+
* // Before running the sample:
|
|
3674
|
+
* // - Enable the API at:
|
|
3675
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
3676
|
+
* // - Login into gcloud by running:
|
|
3677
|
+
* // ```sh
|
|
3678
|
+
* // $ gcloud auth application-default login
|
|
3679
|
+
* // ```
|
|
3680
|
+
* // - Install the npm module by running:
|
|
3681
|
+
* // ```sh
|
|
3682
|
+
* // $ npm install googleapis
|
|
3683
|
+
* // ```
|
|
3684
|
+
*
|
|
3685
|
+
* const {google} = require('googleapis');
|
|
3686
|
+
* const health = google.health('v4');
|
|
3687
|
+
*
|
|
3688
|
+
* async function main() {
|
|
3689
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3690
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3691
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3692
|
+
* });
|
|
3693
|
+
*
|
|
3694
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3695
|
+
* const authClient = await auth.getClient();
|
|
3696
|
+
* google.options({auth: authClient});
|
|
3697
|
+
*
|
|
3698
|
+
* // Do the magic
|
|
3699
|
+
* const res = await health.projects.subscribers.subscriptions.patch({
|
|
3700
|
+
* // 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.
|
|
3701
|
+
* name: 'projects/my-project/subscribers/my-subscriber/subscriptions/my-subscription',
|
|
3702
|
+
* // Optional. The list of fields to update.
|
|
3703
|
+
* updateMask: 'placeholder-value',
|
|
3704
|
+
*
|
|
3705
|
+
* // Request body metadata
|
|
3706
|
+
* requestBody: {
|
|
3707
|
+
* // request body parameters
|
|
3708
|
+
* // {
|
|
3709
|
+
* // "dataTypes": [],
|
|
3710
|
+
* // "name": "my_name",
|
|
3711
|
+
* // "user": "my_user"
|
|
3712
|
+
* // }
|
|
3713
|
+
* },
|
|
3714
|
+
* });
|
|
3715
|
+
* console.log(res.data);
|
|
3716
|
+
*
|
|
3717
|
+
* // Example response
|
|
3718
|
+
* // {
|
|
3719
|
+
* // "dataTypes": [],
|
|
3720
|
+
* // "name": "my_name",
|
|
3721
|
+
* // "user": "my_user"
|
|
3722
|
+
* // }
|
|
3723
|
+
* }
|
|
3724
|
+
*
|
|
3725
|
+
* main().catch(e => {
|
|
3726
|
+
* console.error(e);
|
|
3727
|
+
* throw e;
|
|
3728
|
+
* });
|
|
3729
|
+
*
|
|
3730
|
+
* ```
|
|
3731
|
+
*
|
|
3732
|
+
* @param params - Parameters for request
|
|
3733
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3734
|
+
* @param callback - Optional callback that handles the response.
|
|
3735
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3736
|
+
*/
|
|
3737
|
+
patch(params: Params$Resource$Projects$Subscribers$Subscriptions$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3738
|
+
patch(params?: Params$Resource$Projects$Subscribers$Subscriptions$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Subscription>>;
|
|
3739
|
+
patch(params: Params$Resource$Projects$Subscribers$Subscriptions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3740
|
+
patch(params: Params$Resource$Projects$Subscribers$Subscriptions$Patch, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
|
|
3741
|
+
patch(params: Params$Resource$Projects$Subscribers$Subscriptions$Patch, callback: BodyResponseCallback<Schema$Subscription>): void;
|
|
3742
|
+
patch(callback: BodyResponseCallback<Schema$Subscription>): void;
|
|
3743
|
+
}
|
|
3744
|
+
export interface Params$Resource$Projects$Subscribers$Subscriptions$Create extends StandardParameters {
|
|
3745
|
+
/**
|
|
3746
|
+
* 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.
|
|
3747
|
+
*/
|
|
3748
|
+
parent?: string;
|
|
3749
|
+
/**
|
|
3750
|
+
* 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.
|
|
3751
|
+
*/
|
|
3752
|
+
subscriptionId?: string;
|
|
3753
|
+
/**
|
|
3754
|
+
* Request body metadata
|
|
3755
|
+
*/
|
|
3756
|
+
requestBody?: Schema$CreateSubscriptionPayload;
|
|
3757
|
+
}
|
|
3758
|
+
export interface Params$Resource$Projects$Subscribers$Subscriptions$Delete extends StandardParameters {
|
|
3759
|
+
/**
|
|
3760
|
+
* 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.
|
|
3761
|
+
*/
|
|
3762
|
+
name?: string;
|
|
3763
|
+
}
|
|
3764
|
+
export interface Params$Resource$Projects$Subscribers$Subscriptions$List extends StandardParameters {
|
|
3765
|
+
/**
|
|
3766
|
+
* 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")
|
|
3767
|
+
*/
|
|
3768
|
+
filter?: string;
|
|
3769
|
+
/**
|
|
3770
|
+
* 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.
|
|
3771
|
+
*/
|
|
3772
|
+
pageSize?: number;
|
|
3773
|
+
/**
|
|
3774
|
+
* 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.
|
|
3775
|
+
*/
|
|
3776
|
+
pageToken?: string;
|
|
3777
|
+
/**
|
|
3778
|
+
* 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.
|
|
3779
|
+
*/
|
|
3780
|
+
parent?: string;
|
|
3781
|
+
}
|
|
3782
|
+
export interface Params$Resource$Projects$Subscribers$Subscriptions$Patch extends StandardParameters {
|
|
3783
|
+
/**
|
|
3784
|
+
* 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.
|
|
3785
|
+
*/
|
|
3786
|
+
name?: string;
|
|
3787
|
+
/**
|
|
3788
|
+
* Optional. The list of fields to update.
|
|
3789
|
+
*/
|
|
3790
|
+
updateMask?: string;
|
|
3791
|
+
/**
|
|
3792
|
+
* Request body metadata
|
|
3793
|
+
*/
|
|
3794
|
+
requestBody?: Schema$Subscription;
|
|
3795
|
+
}
|
|
3796
|
+
export class Resource$Shl {
|
|
3797
|
+
context: APIRequestContext;
|
|
3798
|
+
m: Resource$Shl$M;
|
|
3799
|
+
r: Resource$Shl$R;
|
|
3800
|
+
constructor(context: APIRequestContext);
|
|
3801
|
+
}
|
|
3802
|
+
export class Resource$Shl$M {
|
|
3803
|
+
context: APIRequestContext;
|
|
3804
|
+
constructor(context: APIRequestContext);
|
|
3805
|
+
/**
|
|
3806
|
+
* Forward a manifest request for a given SHL
|
|
3807
|
+
* @example
|
|
3808
|
+
* ```js
|
|
3809
|
+
* // Before running the sample:
|
|
3810
|
+
* // - Enable the API at:
|
|
3811
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
3812
|
+
* // - Login into gcloud by running:
|
|
3813
|
+
* // ```sh
|
|
3814
|
+
* // $ gcloud auth application-default login
|
|
3815
|
+
* // ```
|
|
3816
|
+
* // - Install the npm module by running:
|
|
3817
|
+
* // ```sh
|
|
3818
|
+
* // $ npm install googleapis
|
|
3819
|
+
* // ```
|
|
3820
|
+
*
|
|
3821
|
+
* const {google} = require('googleapis');
|
|
3822
|
+
* const health = google.health('v4');
|
|
3823
|
+
*
|
|
3824
|
+
* async function main() {
|
|
3825
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3826
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3827
|
+
* scopes: [],
|
|
3828
|
+
* });
|
|
3829
|
+
*
|
|
3830
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3831
|
+
* const authClient = await auth.getClient();
|
|
3832
|
+
* google.options({auth: authClient});
|
|
3833
|
+
*
|
|
3834
|
+
* // Do the magic
|
|
3835
|
+
* const res = await health.shl.m.getShlManifest({
|
|
3836
|
+
* // Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q
|
|
3837
|
+
* externalShlId: 'placeholder-value',
|
|
3838
|
+
*
|
|
3839
|
+
* // Request body metadata
|
|
3840
|
+
* requestBody: {
|
|
3841
|
+
* // request body parameters
|
|
3842
|
+
* // {
|
|
3843
|
+
* // "embeddedLengthMax": 0,
|
|
3844
|
+
* // "passcode": "my_passcode",
|
|
3845
|
+
* // "recipient": "my_recipient"
|
|
3846
|
+
* // }
|
|
3847
|
+
* },
|
|
3848
|
+
* });
|
|
3849
|
+
* console.log(res.data);
|
|
3850
|
+
*
|
|
3851
|
+
* // Example response
|
|
3852
|
+
* // {
|
|
3853
|
+
* // "contentType": "my_contentType",
|
|
3854
|
+
* // "data": "my_data",
|
|
3855
|
+
* // "extensions": []
|
|
3856
|
+
* // }
|
|
3857
|
+
* }
|
|
3858
|
+
*
|
|
3859
|
+
* main().catch(e => {
|
|
3860
|
+
* console.error(e);
|
|
3861
|
+
* throw e;
|
|
3862
|
+
* });
|
|
3863
|
+
*
|
|
3864
|
+
* ```
|
|
3865
|
+
*
|
|
3866
|
+
* @param params - Parameters for request
|
|
3867
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3868
|
+
* @param callback - Optional callback that handles the response.
|
|
3869
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3870
|
+
*/
|
|
3871
|
+
getShlManifest(params: Params$Resource$Shl$M$Getshlmanifest, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3872
|
+
getShlManifest(params?: Params$Resource$Shl$M$Getshlmanifest, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$HttpBody>>;
|
|
3873
|
+
getShlManifest(params: Params$Resource$Shl$M$Getshlmanifest, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3874
|
+
getShlManifest(params: Params$Resource$Shl$M$Getshlmanifest, options: MethodOptions | BodyResponseCallback<Schema$HttpBody>, callback: BodyResponseCallback<Schema$HttpBody>): void;
|
|
3875
|
+
getShlManifest(params: Params$Resource$Shl$M$Getshlmanifest, callback: BodyResponseCallback<Schema$HttpBody>): void;
|
|
3876
|
+
getShlManifest(callback: BodyResponseCallback<Schema$HttpBody>): void;
|
|
3877
|
+
}
|
|
3878
|
+
export interface Params$Resource$Shl$M$Getshlmanifest extends StandardParameters {
|
|
3879
|
+
/**
|
|
3880
|
+
* Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q
|
|
3881
|
+
*/
|
|
3882
|
+
externalShlId?: string;
|
|
3883
|
+
/**
|
|
3884
|
+
* Request body metadata
|
|
3885
|
+
*/
|
|
3886
|
+
requestBody?: Schema$ManifestParams;
|
|
3887
|
+
}
|
|
3888
|
+
export class Resource$Shl$R {
|
|
3889
|
+
context: APIRequestContext;
|
|
3890
|
+
constructor(context: APIRequestContext);
|
|
3891
|
+
/**
|
|
3892
|
+
* Forward a resource request for a given SHL
|
|
3893
|
+
* @example
|
|
3894
|
+
* ```js
|
|
3895
|
+
* // Before running the sample:
|
|
3896
|
+
* // - Enable the API at:
|
|
3897
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
3898
|
+
* // - Login into gcloud by running:
|
|
3899
|
+
* // ```sh
|
|
3900
|
+
* // $ gcloud auth application-default login
|
|
3901
|
+
* // ```
|
|
3902
|
+
* // - Install the npm module by running:
|
|
3903
|
+
* // ```sh
|
|
3904
|
+
* // $ npm install googleapis
|
|
3905
|
+
* // ```
|
|
3906
|
+
*
|
|
3907
|
+
* const {google} = require('googleapis');
|
|
3908
|
+
* const health = google.health('v4');
|
|
3909
|
+
*
|
|
3910
|
+
* async function main() {
|
|
3911
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3912
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3913
|
+
* scopes: [],
|
|
3914
|
+
* });
|
|
3915
|
+
*
|
|
3916
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3917
|
+
* const authClient = await auth.getClient();
|
|
3918
|
+
* google.options({auth: authClient});
|
|
3919
|
+
*
|
|
3920
|
+
* // Do the magic
|
|
3921
|
+
* const res = await health.shl.r.get({
|
|
3922
|
+
* // Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q
|
|
3923
|
+
* externalShlId: 'placeholder-value',
|
|
3924
|
+
* // Required. Encoded, encrypted message containing resource access details
|
|
3925
|
+
* resourceToken: 'placeholder-value',
|
|
3926
|
+
* });
|
|
3927
|
+
* console.log(res.data);
|
|
3928
|
+
*
|
|
3929
|
+
* // Example response
|
|
3930
|
+
* // {
|
|
3931
|
+
* // "contentType": "my_contentType",
|
|
3932
|
+
* // "data": "my_data",
|
|
3933
|
+
* // "extensions": []
|
|
3934
|
+
* // }
|
|
3935
|
+
* }
|
|
3936
|
+
*
|
|
3937
|
+
* main().catch(e => {
|
|
3938
|
+
* console.error(e);
|
|
3939
|
+
* throw e;
|
|
3940
|
+
* });
|
|
3941
|
+
*
|
|
3942
|
+
* ```
|
|
3943
|
+
*
|
|
3944
|
+
* @param params - Parameters for request
|
|
3945
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3946
|
+
* @param callback - Optional callback that handles the response.
|
|
3947
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3948
|
+
*/
|
|
3949
|
+
get(params: Params$Resource$Shl$R$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3950
|
+
get(params?: Params$Resource$Shl$R$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$HttpBody>>;
|
|
3951
|
+
get(params: Params$Resource$Shl$R$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3952
|
+
get(params: Params$Resource$Shl$R$Get, options: MethodOptions | BodyResponseCallback<Schema$HttpBody>, callback: BodyResponseCallback<Schema$HttpBody>): void;
|
|
3953
|
+
get(params: Params$Resource$Shl$R$Get, callback: BodyResponseCallback<Schema$HttpBody>): void;
|
|
3954
|
+
get(callback: BodyResponseCallback<Schema$HttpBody>): void;
|
|
3955
|
+
}
|
|
3956
|
+
export interface Params$Resource$Shl$R$Get extends StandardParameters {
|
|
3957
|
+
/**
|
|
3958
|
+
* Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q
|
|
3959
|
+
*/
|
|
3960
|
+
externalShlId?: string;
|
|
3961
|
+
/**
|
|
3962
|
+
* Required. Encoded, encrypted message containing resource access details
|
|
3963
|
+
*/
|
|
3964
|
+
resourceToken?: string;
|
|
3965
|
+
}
|
|
3966
|
+
export class Resource$Users {
|
|
3967
|
+
context: APIRequestContext;
|
|
3968
|
+
dataTypes: Resource$Users$Datatypes;
|
|
3969
|
+
pairedDevices: Resource$Users$Paireddevices;
|
|
3970
|
+
constructor(context: APIRequestContext);
|
|
3971
|
+
/**
|
|
3972
|
+
* 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.
|
|
2576
3973
|
* @example
|
|
2577
3974
|
* ```js
|
|
2578
3975
|
* // Before running the sample:
|
|
@@ -2593,7 +3990,15 @@ export declare namespace health_v4 {
|
|
|
2593
3990
|
* async function main() {
|
|
2594
3991
|
* const auth = new google.auth.GoogleAuth({
|
|
2595
3992
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2596
|
-
* scopes: [
|
|
3993
|
+
* scopes: [
|
|
3994
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly',
|
|
3995
|
+
* 'https://www.googleapis.com/auth/googlehealth.ecg.readonly',
|
|
3996
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly',
|
|
3997
|
+
* 'https://www.googleapis.com/auth/googlehealth.irn.readonly',
|
|
3998
|
+
* 'https://www.googleapis.com/auth/googlehealth.profile.readonly',
|
|
3999
|
+
* 'https://www.googleapis.com/auth/googlehealth.settings.readonly',
|
|
4000
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.readonly',
|
|
4001
|
+
* ],
|
|
2597
4002
|
* });
|
|
2598
4003
|
*
|
|
2599
4004
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -2601,35 +4006,17 @@ export declare namespace health_v4 {
|
|
|
2601
4006
|
* google.options({auth: authClient});
|
|
2602
4007
|
*
|
|
2603
4008
|
* // Do the magic
|
|
2604
|
-
* const res = await health.
|
|
2605
|
-
* //
|
|
2606
|
-
* name: '
|
|
2607
|
-
* // 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
|
|
2608
|
-
* updateMask: 'placeholder-value',
|
|
2609
|
-
*
|
|
2610
|
-
* // Request body metadata
|
|
2611
|
-
* requestBody: {
|
|
2612
|
-
* // request body parameters
|
|
2613
|
-
* // {
|
|
2614
|
-
* // "createTime": "my_createTime",
|
|
2615
|
-
* // "endpointAuthorization": {},
|
|
2616
|
-
* // "endpointUri": "my_endpointUri",
|
|
2617
|
-
* // "name": "my_name",
|
|
2618
|
-
* // "state": "my_state",
|
|
2619
|
-
* // "subscriberConfigs": [],
|
|
2620
|
-
* // "updateTime": "my_updateTime"
|
|
2621
|
-
* // }
|
|
2622
|
-
* },
|
|
4009
|
+
* const res = await health.users.getIdentity({
|
|
4010
|
+
* // Required. The resource name of the Identity. Format: `users/me/identity`
|
|
4011
|
+
* name: 'users/my-user/identity',
|
|
2623
4012
|
* });
|
|
2624
4013
|
* console.log(res.data);
|
|
2625
4014
|
*
|
|
2626
4015
|
* // Example response
|
|
2627
4016
|
* // {
|
|
2628
|
-
* // "
|
|
2629
|
-
* // "
|
|
2630
|
-
* // "
|
|
2631
|
-
* // "name": "my_name",
|
|
2632
|
-
* // "response": {}
|
|
4017
|
+
* // "healthUserId": "my_healthUserId",
|
|
4018
|
+
* // "legacyUserId": "my_legacyUserId",
|
|
4019
|
+
* // "name": "my_name"
|
|
2633
4020
|
* // }
|
|
2634
4021
|
* }
|
|
2635
4022
|
*
|
|
@@ -2645,71 +4032,14 @@ export declare namespace health_v4 {
|
|
|
2645
4032
|
* @param callback - Optional callback that handles the response.
|
|
2646
4033
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2647
4034
|
*/
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
}
|
|
2655
|
-
export interface Params$Resource$Projects$Subscribers$Create extends StandardParameters {
|
|
2656
|
-
/**
|
|
2657
|
-
* Required. The parent resource where this subscriber will be created. Format: projects/{project\} Example: projects/my-project-123
|
|
2658
|
-
*/
|
|
2659
|
-
parent?: string;
|
|
2660
|
-
/**
|
|
2661
|
-
* 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])/.
|
|
2662
|
-
*/
|
|
2663
|
-
subscriberId?: string;
|
|
2664
|
-
/**
|
|
2665
|
-
* Request body metadata
|
|
2666
|
-
*/
|
|
2667
|
-
requestBody?: Schema$CreateSubscriberPayload;
|
|
2668
|
-
}
|
|
2669
|
-
export interface Params$Resource$Projects$Subscribers$Delete extends StandardParameters {
|
|
2670
|
-
/**
|
|
2671
|
-
* 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.
|
|
2672
|
-
*/
|
|
2673
|
-
force?: boolean;
|
|
2674
|
-
/**
|
|
2675
|
-
* 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.
|
|
2676
|
-
*/
|
|
2677
|
-
name?: string;
|
|
2678
|
-
}
|
|
2679
|
-
export interface Params$Resource$Projects$Subscribers$List extends StandardParameters {
|
|
2680
|
-
/**
|
|
2681
|
-
* 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.
|
|
2682
|
-
*/
|
|
2683
|
-
pageSize?: number;
|
|
2684
|
-
/**
|
|
2685
|
-
* 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.
|
|
2686
|
-
*/
|
|
2687
|
-
pageToken?: string;
|
|
2688
|
-
/**
|
|
2689
|
-
* Required. The parent, which owns this collection of subscribers. Format: projects/{project\}
|
|
2690
|
-
*/
|
|
2691
|
-
parent?: string;
|
|
2692
|
-
}
|
|
2693
|
-
export interface Params$Resource$Projects$Subscribers$Patch extends StandardParameters {
|
|
2694
|
-
/**
|
|
2695
|
-
* 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
|
|
2696
|
-
*/
|
|
2697
|
-
name?: string;
|
|
2698
|
-
/**
|
|
2699
|
-
* 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
|
|
2700
|
-
*/
|
|
2701
|
-
updateMask?: string;
|
|
2702
|
-
/**
|
|
2703
|
-
* Request body metadata
|
|
2704
|
-
*/
|
|
2705
|
-
requestBody?: Schema$Subscriber;
|
|
2706
|
-
}
|
|
2707
|
-
export class Resource$Users {
|
|
2708
|
-
context: APIRequestContext;
|
|
2709
|
-
dataTypes: Resource$Users$Datatypes;
|
|
2710
|
-
constructor(context: APIRequestContext);
|
|
4035
|
+
getIdentity(params: Params$Resource$Users$Getidentity, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4036
|
+
getIdentity(params?: Params$Resource$Users$Getidentity, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Identity>>;
|
|
4037
|
+
getIdentity(params: Params$Resource$Users$Getidentity, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4038
|
+
getIdentity(params: Params$Resource$Users$Getidentity, options: MethodOptions | BodyResponseCallback<Schema$Identity>, callback: BodyResponseCallback<Schema$Identity>): void;
|
|
4039
|
+
getIdentity(params: Params$Resource$Users$Getidentity, callback: BodyResponseCallback<Schema$Identity>): void;
|
|
4040
|
+
getIdentity(callback: BodyResponseCallback<Schema$Identity>): void;
|
|
2711
4041
|
/**
|
|
2712
|
-
*
|
|
4042
|
+
* Returns user's IRN Profile details.
|
|
2713
4043
|
* @example
|
|
2714
4044
|
* ```js
|
|
2715
4045
|
* // Before running the sample:
|
|
@@ -2730,7 +4060,7 @@ export declare namespace health_v4 {
|
|
|
2730
4060
|
* async function main() {
|
|
2731
4061
|
* const auth = new google.auth.GoogleAuth({
|
|
2732
4062
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2733
|
-
* scopes: [],
|
|
4063
|
+
* scopes: ['https://www.googleapis.com/auth/googlehealth.irn.readonly'],
|
|
2734
4064
|
* });
|
|
2735
4065
|
*
|
|
2736
4066
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -2738,17 +4068,18 @@ export declare namespace health_v4 {
|
|
|
2738
4068
|
* google.options({auth: authClient});
|
|
2739
4069
|
*
|
|
2740
4070
|
* // Do the magic
|
|
2741
|
-
* const res = await health.users.
|
|
2742
|
-
* // Required. The resource name of the
|
|
2743
|
-
* name: 'users/my-user/
|
|
4071
|
+
* const res = await health.users.getIrnProfile({
|
|
4072
|
+
* // 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.
|
|
4073
|
+
* name: 'users/my-user/irnProfile',
|
|
2744
4074
|
* });
|
|
2745
4075
|
* console.log(res.data);
|
|
2746
4076
|
*
|
|
2747
4077
|
* // Example response
|
|
2748
4078
|
* // {
|
|
2749
|
-
* // "
|
|
2750
|
-
* // "
|
|
2751
|
-
* // "
|
|
4079
|
+
* // "enrollmentStatus": false,
|
|
4080
|
+
* // "name": "my_name",
|
|
4081
|
+
* // "onboardingStatus": false,
|
|
4082
|
+
* // "updateTime": "my_updateTime"
|
|
2752
4083
|
* // }
|
|
2753
4084
|
* }
|
|
2754
4085
|
*
|
|
@@ -2764,12 +4095,12 @@ export declare namespace health_v4 {
|
|
|
2764
4095
|
* @param callback - Optional callback that handles the response.
|
|
2765
4096
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2766
4097
|
*/
|
|
2767
|
-
|
|
2768
|
-
|
|
2769
|
-
|
|
2770
|
-
|
|
2771
|
-
|
|
2772
|
-
|
|
4098
|
+
getIrnProfile(params: Params$Resource$Users$Getirnprofile, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4099
|
+
getIrnProfile(params?: Params$Resource$Users$Getirnprofile, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$IrnProfile>>;
|
|
4100
|
+
getIrnProfile(params: Params$Resource$Users$Getirnprofile, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4101
|
+
getIrnProfile(params: Params$Resource$Users$Getirnprofile, options: MethodOptions | BodyResponseCallback<Schema$IrnProfile>, callback: BodyResponseCallback<Schema$IrnProfile>): void;
|
|
4102
|
+
getIrnProfile(params: Params$Resource$Users$Getirnprofile, callback: BodyResponseCallback<Schema$IrnProfile>): void;
|
|
4103
|
+
getIrnProfile(callback: BodyResponseCallback<Schema$IrnProfile>): void;
|
|
2773
4104
|
/**
|
|
2774
4105
|
* Returns user Profile details.
|
|
2775
4106
|
* @example
|
|
@@ -2792,7 +4123,7 @@ export declare namespace health_v4 {
|
|
|
2792
4123
|
* async function main() {
|
|
2793
4124
|
* const auth = new google.auth.GoogleAuth({
|
|
2794
4125
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2795
|
-
* scopes: [],
|
|
4126
|
+
* scopes: ['https://www.googleapis.com/auth/googlehealth.profile.readonly'],
|
|
2796
4127
|
* });
|
|
2797
4128
|
*
|
|
2798
4129
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -2858,7 +4189,7 @@ export declare namespace health_v4 {
|
|
|
2858
4189
|
* async function main() {
|
|
2859
4190
|
* const auth = new google.auth.GoogleAuth({
|
|
2860
4191
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2861
|
-
* scopes: [],
|
|
4192
|
+
* scopes: ['https://www.googleapis.com/auth/googlehealth.settings.readonly'],
|
|
2862
4193
|
* });
|
|
2863
4194
|
*
|
|
2864
4195
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -2876,6 +4207,7 @@ export declare namespace health_v4 {
|
|
|
2876
4207
|
* // {
|
|
2877
4208
|
* // "autoStrideEnabled": false,
|
|
2878
4209
|
* // "distanceUnit": "my_distanceUnit",
|
|
4210
|
+
* // "foodLanguageCode": "my_foodLanguageCode",
|
|
2879
4211
|
* // "glucoseUnit": "my_glucoseUnit",
|
|
2880
4212
|
* // "heightUnit": "my_heightUnit",
|
|
2881
4213
|
* // "languageLocale": "my_languageLocale",
|
|
@@ -2931,7 +4263,7 @@ export declare namespace health_v4 {
|
|
|
2931
4263
|
* async function main() {
|
|
2932
4264
|
* const auth = new google.auth.GoogleAuth({
|
|
2933
4265
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2934
|
-
* scopes: [],
|
|
4266
|
+
* scopes: ['https://www.googleapis.com/auth/googlehealth.profile.writeonly'],
|
|
2935
4267
|
* });
|
|
2936
4268
|
*
|
|
2937
4269
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3013,7 +4345,7 @@ export declare namespace health_v4 {
|
|
|
3013
4345
|
* async function main() {
|
|
3014
4346
|
* const auth = new google.auth.GoogleAuth({
|
|
3015
4347
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3016
|
-
* scopes: [],
|
|
4348
|
+
* scopes: ['https://www.googleapis.com/auth/googlehealth.settings.writeonly'],
|
|
3017
4349
|
* });
|
|
3018
4350
|
*
|
|
3019
4351
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3033,6 +4365,7 @@ export declare namespace health_v4 {
|
|
|
3033
4365
|
* // {
|
|
3034
4366
|
* // "autoStrideEnabled": false,
|
|
3035
4367
|
* // "distanceUnit": "my_distanceUnit",
|
|
4368
|
+
* // "foodLanguageCode": "my_foodLanguageCode",
|
|
3036
4369
|
* // "glucoseUnit": "my_glucoseUnit",
|
|
3037
4370
|
* // "heightUnit": "my_heightUnit",
|
|
3038
4371
|
* // "languageLocale": "my_languageLocale",
|
|
@@ -3054,6 +4387,7 @@ export declare namespace health_v4 {
|
|
|
3054
4387
|
* // {
|
|
3055
4388
|
* // "autoStrideEnabled": false,
|
|
3056
4389
|
* // "distanceUnit": "my_distanceUnit",
|
|
4390
|
+
* // "foodLanguageCode": "my_foodLanguageCode",
|
|
3057
4391
|
* // "glucoseUnit": "my_glucoseUnit",
|
|
3058
4392
|
* // "heightUnit": "my_heightUnit",
|
|
3059
4393
|
* // "languageLocale": "my_languageLocale",
|
|
@@ -3094,6 +4428,12 @@ export declare namespace health_v4 {
|
|
|
3094
4428
|
*/
|
|
3095
4429
|
name?: string;
|
|
3096
4430
|
}
|
|
4431
|
+
export interface Params$Resource$Users$Getirnprofile extends StandardParameters {
|
|
4432
|
+
/**
|
|
4433
|
+
* 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.
|
|
4434
|
+
*/
|
|
4435
|
+
name?: string;
|
|
4436
|
+
}
|
|
3097
4437
|
export interface Params$Resource$Users$Getprofile extends StandardParameters {
|
|
3098
4438
|
/**
|
|
3099
4439
|
* Required. The name of the Profile. Format: `users/me/profile`.
|
|
@@ -3164,7 +4504,16 @@ export declare namespace health_v4 {
|
|
|
3164
4504
|
* async function main() {
|
|
3165
4505
|
* const auth = new google.auth.GoogleAuth({
|
|
3166
4506
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3167
|
-
* scopes: [
|
|
4507
|
+
* scopes: [
|
|
4508
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly',
|
|
4509
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly',
|
|
4510
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.writeonly',
|
|
4511
|
+
* 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly',
|
|
4512
|
+
* 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly',
|
|
4513
|
+
* 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly',
|
|
4514
|
+
* 'https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly',
|
|
4515
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.writeonly',
|
|
4516
|
+
* ],
|
|
3168
4517
|
* });
|
|
3169
4518
|
*
|
|
3170
4519
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3236,7 +4585,16 @@ export declare namespace health_v4 {
|
|
|
3236
4585
|
* async function main() {
|
|
3237
4586
|
* const auth = new google.auth.GoogleAuth({
|
|
3238
4587
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3239
|
-
* scopes: [
|
|
4588
|
+
* scopes: [
|
|
4589
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly',
|
|
4590
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly',
|
|
4591
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.writeonly',
|
|
4592
|
+
* 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly',
|
|
4593
|
+
* 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly',
|
|
4594
|
+
* 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly',
|
|
4595
|
+
* 'https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly',
|
|
4596
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.writeonly',
|
|
4597
|
+
* ],
|
|
3240
4598
|
* });
|
|
3241
4599
|
*
|
|
3242
4600
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3252,12 +4610,15 @@ export declare namespace health_v4 {
|
|
|
3252
4610
|
* requestBody: {
|
|
3253
4611
|
* // request body parameters
|
|
3254
4612
|
* // {
|
|
4613
|
+
* // "activeEnergyBurned": {},
|
|
3255
4614
|
* // "activeMinutes": {},
|
|
3256
4615
|
* // "activeZoneMinutes": {},
|
|
3257
4616
|
* // "activityLevel": {},
|
|
3258
4617
|
* // "altitude": {},
|
|
3259
4618
|
* // "basalEnergyBurned": {},
|
|
4619
|
+
* // "bloodGlucose": {},
|
|
3260
4620
|
* // "bodyFat": {},
|
|
4621
|
+
* // "coreBodyTemperature": {},
|
|
3261
4622
|
* // "dailyHeartRateVariability": {},
|
|
3262
4623
|
* // "dailyHeartRateZones": {},
|
|
3263
4624
|
* // "dailyOxygenSaturation": {},
|
|
@@ -3267,13 +4628,18 @@ export declare namespace health_v4 {
|
|
|
3267
4628
|
* // "dailyVo2Max": {},
|
|
3268
4629
|
* // "dataSource": {},
|
|
3269
4630
|
* // "distance": {},
|
|
4631
|
+
* // "electrocardiogram": {},
|
|
3270
4632
|
* // "exercise": {},
|
|
3271
4633
|
* // "floors": {},
|
|
4634
|
+
* // "food": {},
|
|
4635
|
+
* // "foodMeasurementUnit": {},
|
|
3272
4636
|
* // "heartRate": {},
|
|
3273
4637
|
* // "heartRateVariability": {},
|
|
3274
4638
|
* // "height": {},
|
|
3275
4639
|
* // "hydrationLog": {},
|
|
4640
|
+
* // "irregularRhythmNotification": {},
|
|
3276
4641
|
* // "name": "my_name",
|
|
4642
|
+
* // "nutritionLog": {},
|
|
3277
4643
|
* // "oxygenSaturation": {},
|
|
3278
4644
|
* // "respiratoryRateSleepSummary": {},
|
|
3279
4645
|
* // "runVo2Max": {},
|
|
@@ -3339,7 +4705,12 @@ export declare namespace health_v4 {
|
|
|
3339
4705
|
* async function main() {
|
|
3340
4706
|
* const auth = new google.auth.GoogleAuth({
|
|
3341
4707
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3342
|
-
* scopes: [
|
|
4708
|
+
* scopes: [
|
|
4709
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly',
|
|
4710
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly',
|
|
4711
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.readonly',
|
|
4712
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.readonly',
|
|
4713
|
+
* ],
|
|
3343
4714
|
* });
|
|
3344
4715
|
*
|
|
3345
4716
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3390,7 +4761,7 @@ export declare namespace health_v4 {
|
|
|
3390
4761
|
dailyRollUp(params: Params$Resource$Users$Datatypes$Datapoints$Dailyrollup, callback: BodyResponseCallback<Schema$DailyRollUpDataPointsResponse>): void;
|
|
3391
4762
|
dailyRollUp(callback: BodyResponseCallback<Schema$DailyRollUpDataPointsResponse>): void;
|
|
3392
4763
|
/**
|
|
3393
|
-
* Exports exercise data in TCX format.
|
|
4764
|
+
* 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.
|
|
3394
4765
|
* @example
|
|
3395
4766
|
* ```js
|
|
3396
4767
|
* // Before running the sample:
|
|
@@ -3411,7 +4782,10 @@ export declare namespace health_v4 {
|
|
|
3411
4782
|
* async function main() {
|
|
3412
4783
|
* const auth = new google.auth.GoogleAuth({
|
|
3413
4784
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3414
|
-
* scopes: [
|
|
4785
|
+
* scopes: [
|
|
4786
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly',
|
|
4787
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.readonly',
|
|
4788
|
+
* ],
|
|
3415
4789
|
* });
|
|
3416
4790
|
*
|
|
3417
4791
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3473,7 +4847,12 @@ export declare namespace health_v4 {
|
|
|
3473
4847
|
* async function main() {
|
|
3474
4848
|
* const auth = new google.auth.GoogleAuth({
|
|
3475
4849
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3476
|
-
* scopes: [
|
|
4850
|
+
* scopes: [
|
|
4851
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly',
|
|
4852
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly',
|
|
4853
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.readonly',
|
|
4854
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.readonly',
|
|
4855
|
+
* ],
|
|
3477
4856
|
* });
|
|
3478
4857
|
*
|
|
3479
4858
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3489,12 +4868,15 @@ export declare namespace health_v4 {
|
|
|
3489
4868
|
*
|
|
3490
4869
|
* // Example response
|
|
3491
4870
|
* // {
|
|
4871
|
+
* // "activeEnergyBurned": {},
|
|
3492
4872
|
* // "activeMinutes": {},
|
|
3493
4873
|
* // "activeZoneMinutes": {},
|
|
3494
4874
|
* // "activityLevel": {},
|
|
3495
4875
|
* // "altitude": {},
|
|
3496
4876
|
* // "basalEnergyBurned": {},
|
|
4877
|
+
* // "bloodGlucose": {},
|
|
3497
4878
|
* // "bodyFat": {},
|
|
4879
|
+
* // "coreBodyTemperature": {},
|
|
3498
4880
|
* // "dailyHeartRateVariability": {},
|
|
3499
4881
|
* // "dailyHeartRateZones": {},
|
|
3500
4882
|
* // "dailyOxygenSaturation": {},
|
|
@@ -3504,13 +4886,18 @@ export declare namespace health_v4 {
|
|
|
3504
4886
|
* // "dailyVo2Max": {},
|
|
3505
4887
|
* // "dataSource": {},
|
|
3506
4888
|
* // "distance": {},
|
|
4889
|
+
* // "electrocardiogram": {},
|
|
3507
4890
|
* // "exercise": {},
|
|
3508
4891
|
* // "floors": {},
|
|
4892
|
+
* // "food": {},
|
|
4893
|
+
* // "foodMeasurementUnit": {},
|
|
3509
4894
|
* // "heartRate": {},
|
|
3510
4895
|
* // "heartRateVariability": {},
|
|
3511
4896
|
* // "height": {},
|
|
3512
4897
|
* // "hydrationLog": {},
|
|
4898
|
+
* // "irregularRhythmNotification": {},
|
|
3513
4899
|
* // "name": "my_name",
|
|
4900
|
+
* // "nutritionLog": {},
|
|
3514
4901
|
* // "oxygenSaturation": {},
|
|
3515
4902
|
* // "respiratoryRateSleepSummary": {},
|
|
3516
4903
|
* // "runVo2Max": {},
|
|
@@ -3564,7 +4951,12 @@ export declare namespace health_v4 {
|
|
|
3564
4951
|
* async function main() {
|
|
3565
4952
|
* const auth = new google.auth.GoogleAuth({
|
|
3566
4953
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3567
|
-
* scopes: [
|
|
4954
|
+
* scopes: [
|
|
4955
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly',
|
|
4956
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly',
|
|
4957
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.readonly',
|
|
4958
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.readonly',
|
|
4959
|
+
* ],
|
|
3568
4960
|
* });
|
|
3569
4961
|
*
|
|
3570
4962
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3573,7 +4965,7 @@ export declare namespace health_v4 {
|
|
|
3573
4965
|
*
|
|
3574
4966
|
* // Do the magic
|
|
3575
4967
|
* const res = await health.users.dataTypes.dataPoints.list({
|
|
3576
|
-
* // 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**): - 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 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.
|
|
4968
|
+
* // 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.
|
|
3577
4969
|
* filter: 'placeholder-value',
|
|
3578
4970
|
* // 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.
|
|
3579
4971
|
* pageSize: 'placeholder-value',
|
|
@@ -3631,7 +5023,16 @@ export declare namespace health_v4 {
|
|
|
3631
5023
|
* async function main() {
|
|
3632
5024
|
* const auth = new google.auth.GoogleAuth({
|
|
3633
5025
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3634
|
-
* scopes: [
|
|
5026
|
+
* scopes: [
|
|
5027
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly',
|
|
5028
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly',
|
|
5029
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.writeonly',
|
|
5030
|
+
* 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly',
|
|
5031
|
+
* 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly',
|
|
5032
|
+
* 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly',
|
|
5033
|
+
* 'https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly',
|
|
5034
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.writeonly',
|
|
5035
|
+
* ],
|
|
3635
5036
|
* });
|
|
3636
5037
|
*
|
|
3637
5038
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3640,19 +5041,22 @@ export declare namespace health_v4 {
|
|
|
3640
5041
|
*
|
|
3641
5042
|
* // Do the magic
|
|
3642
5043
|
* const res = await health.users.dataTypes.dataPoints.patch({
|
|
3643
|
-
* // 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. `
|
|
5044
|
+
* // 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.
|
|
3644
5045
|
* name: 'users/my-user/dataTypes/my-dataType/dataPoints/my-dataPoint',
|
|
3645
5046
|
*
|
|
3646
5047
|
* // Request body metadata
|
|
3647
5048
|
* requestBody: {
|
|
3648
5049
|
* // request body parameters
|
|
3649
5050
|
* // {
|
|
5051
|
+
* // "activeEnergyBurned": {},
|
|
3650
5052
|
* // "activeMinutes": {},
|
|
3651
5053
|
* // "activeZoneMinutes": {},
|
|
3652
5054
|
* // "activityLevel": {},
|
|
3653
5055
|
* // "altitude": {},
|
|
3654
5056
|
* // "basalEnergyBurned": {},
|
|
5057
|
+
* // "bloodGlucose": {},
|
|
3655
5058
|
* // "bodyFat": {},
|
|
5059
|
+
* // "coreBodyTemperature": {},
|
|
3656
5060
|
* // "dailyHeartRateVariability": {},
|
|
3657
5061
|
* // "dailyHeartRateZones": {},
|
|
3658
5062
|
* // "dailyOxygenSaturation": {},
|
|
@@ -3662,13 +5066,18 @@ export declare namespace health_v4 {
|
|
|
3662
5066
|
* // "dailyVo2Max": {},
|
|
3663
5067
|
* // "dataSource": {},
|
|
3664
5068
|
* // "distance": {},
|
|
5069
|
+
* // "electrocardiogram": {},
|
|
3665
5070
|
* // "exercise": {},
|
|
3666
5071
|
* // "floors": {},
|
|
5072
|
+
* // "food": {},
|
|
5073
|
+
* // "foodMeasurementUnit": {},
|
|
3667
5074
|
* // "heartRate": {},
|
|
3668
5075
|
* // "heartRateVariability": {},
|
|
3669
5076
|
* // "height": {},
|
|
3670
5077
|
* // "hydrationLog": {},
|
|
5078
|
+
* // "irregularRhythmNotification": {},
|
|
3671
5079
|
* // "name": "my_name",
|
|
5080
|
+
* // "nutritionLog": {},
|
|
3672
5081
|
* // "oxygenSaturation": {},
|
|
3673
5082
|
* // "respiratoryRateSleepSummary": {},
|
|
3674
5083
|
* // "runVo2Max": {},
|
|
@@ -3734,7 +5143,12 @@ export declare namespace health_v4 {
|
|
|
3734
5143
|
* async function main() {
|
|
3735
5144
|
* const auth = new google.auth.GoogleAuth({
|
|
3736
5145
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3737
|
-
* scopes: [
|
|
5146
|
+
* scopes: [
|
|
5147
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly',
|
|
5148
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly',
|
|
5149
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.readonly',
|
|
5150
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.readonly',
|
|
5151
|
+
* ],
|
|
3738
5152
|
* });
|
|
3739
5153
|
*
|
|
3740
5154
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3803,7 +5217,12 @@ export declare namespace health_v4 {
|
|
|
3803
5217
|
* async function main() {
|
|
3804
5218
|
* const auth = new google.auth.GoogleAuth({
|
|
3805
5219
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3806
|
-
* scopes: [
|
|
5220
|
+
* scopes: [
|
|
5221
|
+
* 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly',
|
|
5222
|
+
* 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly',
|
|
5223
|
+
* 'https://www.googleapis.com/auth/googlehealth.location.readonly',
|
|
5224
|
+
* 'https://www.googleapis.com/auth/googlehealth.sleep.readonly',
|
|
5225
|
+
* ],
|
|
3807
5226
|
* });
|
|
3808
5227
|
*
|
|
3809
5228
|
* // Acquire an auth client, and bind it to all future calls
|
|
@@ -3903,7 +5322,7 @@ export declare namespace health_v4 {
|
|
|
3903
5322
|
}
|
|
3904
5323
|
export interface Params$Resource$Users$Datatypes$Datapoints$List extends StandardParameters {
|
|
3905
5324
|
/**
|
|
3906
|
-
* 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**): - 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 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.
|
|
5325
|
+
* 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.
|
|
3907
5326
|
*/
|
|
3908
5327
|
filter?: string;
|
|
3909
5328
|
/**
|
|
@@ -3921,7 +5340,7 @@ export declare namespace health_v4 {
|
|
|
3921
5340
|
}
|
|
3922
5341
|
export interface Params$Resource$Users$Datatypes$Datapoints$Patch extends StandardParameters {
|
|
3923
5342
|
/**
|
|
3924
|
-
* 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. `
|
|
5343
|
+
* 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.
|
|
3925
5344
|
*/
|
|
3926
5345
|
name?: string;
|
|
3927
5346
|
/**
|
|
@@ -3961,5 +5380,161 @@ export declare namespace health_v4 {
|
|
|
3961
5380
|
*/
|
|
3962
5381
|
requestBody?: Schema$RollUpDataPointsRequest;
|
|
3963
5382
|
}
|
|
5383
|
+
export class Resource$Users$Paireddevices {
|
|
5384
|
+
context: APIRequestContext;
|
|
5385
|
+
constructor(context: APIRequestContext);
|
|
5386
|
+
/**
|
|
5387
|
+
* Returns user's Device.
|
|
5388
|
+
* @example
|
|
5389
|
+
* ```js
|
|
5390
|
+
* // Before running the sample:
|
|
5391
|
+
* // - Enable the API at:
|
|
5392
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
5393
|
+
* // - Login into gcloud by running:
|
|
5394
|
+
* // ```sh
|
|
5395
|
+
* // $ gcloud auth application-default login
|
|
5396
|
+
* // ```
|
|
5397
|
+
* // - Install the npm module by running:
|
|
5398
|
+
* // ```sh
|
|
5399
|
+
* // $ npm install googleapis
|
|
5400
|
+
* // ```
|
|
5401
|
+
*
|
|
5402
|
+
* const {google} = require('googleapis');
|
|
5403
|
+
* const health = google.health('v4');
|
|
5404
|
+
*
|
|
5405
|
+
* async function main() {
|
|
5406
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5407
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5408
|
+
* scopes: ['https://www.googleapis.com/auth/googlehealth.settings.readonly'],
|
|
5409
|
+
* });
|
|
5410
|
+
*
|
|
5411
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5412
|
+
* const authClient = await auth.getClient();
|
|
5413
|
+
* google.options({auth: authClient});
|
|
5414
|
+
*
|
|
5415
|
+
* // Do the magic
|
|
5416
|
+
* const res = await health.users.pairedDevices.get({
|
|
5417
|
+
* // Required. The name of the device to retrieve. Format: users/{user\}/devices/{device\}
|
|
5418
|
+
* name: 'users/my-user/pairedDevices/my-pairedDevice',
|
|
5419
|
+
* });
|
|
5420
|
+
* console.log(res.data);
|
|
5421
|
+
*
|
|
5422
|
+
* // Example response
|
|
5423
|
+
* // {
|
|
5424
|
+
* // "batteryLevel": 0,
|
|
5425
|
+
* // "batteryStatus": "my_batteryStatus",
|
|
5426
|
+
* // "deviceType": "my_deviceType",
|
|
5427
|
+
* // "deviceVersion": "my_deviceVersion",
|
|
5428
|
+
* // "features": [],
|
|
5429
|
+
* // "lastSyncTime": "my_lastSyncTime",
|
|
5430
|
+
* // "macAddress": "my_macAddress",
|
|
5431
|
+
* // "name": "my_name"
|
|
5432
|
+
* // }
|
|
5433
|
+
* }
|
|
5434
|
+
*
|
|
5435
|
+
* main().catch(e => {
|
|
5436
|
+
* console.error(e);
|
|
5437
|
+
* throw e;
|
|
5438
|
+
* });
|
|
5439
|
+
*
|
|
5440
|
+
* ```
|
|
5441
|
+
*
|
|
5442
|
+
* @param params - Parameters for request
|
|
5443
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5444
|
+
* @param callback - Optional callback that handles the response.
|
|
5445
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5446
|
+
*/
|
|
5447
|
+
get(params: Params$Resource$Users$Paireddevices$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5448
|
+
get(params?: Params$Resource$Users$Paireddevices$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$PairedDevice>>;
|
|
5449
|
+
get(params: Params$Resource$Users$Paireddevices$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5450
|
+
get(params: Params$Resource$Users$Paireddevices$Get, options: MethodOptions | BodyResponseCallback<Schema$PairedDevice>, callback: BodyResponseCallback<Schema$PairedDevice>): void;
|
|
5451
|
+
get(params: Params$Resource$Users$Paireddevices$Get, callback: BodyResponseCallback<Schema$PairedDevice>): void;
|
|
5452
|
+
get(callback: BodyResponseCallback<Schema$PairedDevice>): void;
|
|
5453
|
+
/**
|
|
5454
|
+
* Returns the user's list of paired 1P trackers and smartwatches.
|
|
5455
|
+
* @example
|
|
5456
|
+
* ```js
|
|
5457
|
+
* // Before running the sample:
|
|
5458
|
+
* // - Enable the API at:
|
|
5459
|
+
* // https://console.developers.google.com/apis/api/health.googleapis.com
|
|
5460
|
+
* // - Login into gcloud by running:
|
|
5461
|
+
* // ```sh
|
|
5462
|
+
* // $ gcloud auth application-default login
|
|
5463
|
+
* // ```
|
|
5464
|
+
* // - Install the npm module by running:
|
|
5465
|
+
* // ```sh
|
|
5466
|
+
* // $ npm install googleapis
|
|
5467
|
+
* // ```
|
|
5468
|
+
*
|
|
5469
|
+
* const {google} = require('googleapis');
|
|
5470
|
+
* const health = google.health('v4');
|
|
5471
|
+
*
|
|
5472
|
+
* async function main() {
|
|
5473
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5474
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5475
|
+
* scopes: ['https://www.googleapis.com/auth/googlehealth.settings.readonly'],
|
|
5476
|
+
* });
|
|
5477
|
+
*
|
|
5478
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5479
|
+
* const authClient = await auth.getClient();
|
|
5480
|
+
* google.options({auth: authClient});
|
|
5481
|
+
*
|
|
5482
|
+
* // Do the magic
|
|
5483
|
+
* const res = await health.users.pairedDevices.list({
|
|
5484
|
+
* // 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.
|
|
5485
|
+
* pageSize: 'placeholder-value',
|
|
5486
|
+
* // 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.
|
|
5487
|
+
* pageToken: 'placeholder-value',
|
|
5488
|
+
* // Required. The parent, which owns this collection of devices. Format: users/{user\}
|
|
5489
|
+
* parent: 'users/my-user',
|
|
5490
|
+
* });
|
|
5491
|
+
* console.log(res.data);
|
|
5492
|
+
*
|
|
5493
|
+
* // Example response
|
|
5494
|
+
* // {
|
|
5495
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
5496
|
+
* // "pairedDevices": []
|
|
5497
|
+
* // }
|
|
5498
|
+
* }
|
|
5499
|
+
*
|
|
5500
|
+
* main().catch(e => {
|
|
5501
|
+
* console.error(e);
|
|
5502
|
+
* throw e;
|
|
5503
|
+
* });
|
|
5504
|
+
*
|
|
5505
|
+
* ```
|
|
5506
|
+
*
|
|
5507
|
+
* @param params - Parameters for request
|
|
5508
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5509
|
+
* @param callback - Optional callback that handles the response.
|
|
5510
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5511
|
+
*/
|
|
5512
|
+
list(params: Params$Resource$Users$Paireddevices$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5513
|
+
list(params?: Params$Resource$Users$Paireddevices$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListPairedDevicesResponse>>;
|
|
5514
|
+
list(params: Params$Resource$Users$Paireddevices$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5515
|
+
list(params: Params$Resource$Users$Paireddevices$List, options: MethodOptions | BodyResponseCallback<Schema$ListPairedDevicesResponse>, callback: BodyResponseCallback<Schema$ListPairedDevicesResponse>): void;
|
|
5516
|
+
list(params: Params$Resource$Users$Paireddevices$List, callback: BodyResponseCallback<Schema$ListPairedDevicesResponse>): void;
|
|
5517
|
+
list(callback: BodyResponseCallback<Schema$ListPairedDevicesResponse>): void;
|
|
5518
|
+
}
|
|
5519
|
+
export interface Params$Resource$Users$Paireddevices$Get extends StandardParameters {
|
|
5520
|
+
/**
|
|
5521
|
+
* Required. The name of the device to retrieve. Format: users/{user\}/devices/{device\}
|
|
5522
|
+
*/
|
|
5523
|
+
name?: string;
|
|
5524
|
+
}
|
|
5525
|
+
export interface Params$Resource$Users$Paireddevices$List extends StandardParameters {
|
|
5526
|
+
/**
|
|
5527
|
+
* 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.
|
|
5528
|
+
*/
|
|
5529
|
+
pageSize?: number;
|
|
5530
|
+
/**
|
|
5531
|
+
* 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.
|
|
5532
|
+
*/
|
|
5533
|
+
pageToken?: string;
|
|
5534
|
+
/**
|
|
5535
|
+
* Required. The parent, which owns this collection of devices. Format: users/{user\}
|
|
5536
|
+
*/
|
|
5537
|
+
parent?: string;
|
|
5538
|
+
}
|
|
3964
5539
|
export {};
|
|
3965
5540
|
}
|