@googleapis/chromemanagement 3.0.0 → 4.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/v1.ts CHANGED
@@ -449,6 +449,10 @@ export namespace chromemanagement_v1 {
449
449
  * Output only. The app developer has enabled support for their app. Version-specific field that will only be set when the requested app version is found.
450
450
  */
451
451
  supportEnabled?: boolean | null;
452
+ /**
453
+ * Output only. Types of an item in the Chrome Web Store
454
+ */
455
+ type?: string | null;
452
456
  }
453
457
  /**
454
458
  * Permission requested by a Chrome app or extension.
@@ -851,7 +855,7 @@ export namespace chromemanagement_v1 {
851
855
  adapterInfo?: Schema$GoogleChromeManagementV1GraphicsAdapterInfo;
852
856
  }
853
857
  /**
854
- * Information of the graphics subsystem. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceGraphicsInfo](https://chromeenterprise.google/policies/#ReportDeviceGraphicsInfo) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A
858
+ * Information of the graphics subsystem. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceGraphicsInfo](https://chromeenterprise.google/policies/#ReportDeviceGraphicsInfo) * Data Collection Frequency: 3 hours. * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A
855
859
  */
856
860
  export interface Schema$GoogleChromeManagementV1GraphicsStatusReport {
857
861
  /**
@@ -935,6 +939,32 @@ export namespace chromemanagement_v1 {
935
939
  */
936
940
  nextPageToken?: string | null;
937
941
  }
942
+ /**
943
+ * Response message for listing telemetry events for a customer.
944
+ */
945
+ export interface Schema$GoogleChromeManagementV1ListTelemetryEventsResponse {
946
+ /**
947
+ * Token to specify next page in the list.
948
+ */
949
+ nextPageToken?: string | null;
950
+ /**
951
+ * Telemetry events returned in the response.
952
+ */
953
+ telemetryEvents?: Schema$GoogleChromeManagementV1TelemetryEvent[];
954
+ }
955
+ /**
956
+ * Response message for listing telemetry users for a customer.
957
+ */
958
+ export interface Schema$GoogleChromeManagementV1ListTelemetryUsersResponse {
959
+ /**
960
+ * Token to specify next page in the list.
961
+ */
962
+ nextPageToken?: string | null;
963
+ /**
964
+ * Telemetry users returned in the response.
965
+ */
966
+ telemetryUsers?: Schema$GoogleChromeManagementV1TelemetryUser[];
967
+ }
938
968
  /**
939
969
  * Memory information of a device. * This field has both telemetry and device information: - `totalRamBytes` - Device information - `availableRamBytes` - Telemetry information - `totalMemoryEncryption` - Device information * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: - `totalRamBytes` - Only at upload - `availableRamBytes` - Every 10 minutes - `totalMemoryEncryption` - at device startup * Default Data Reporting Frequency: - `totalRamBytes` - 3 hours - `availableRamBytes` - 3 hours - `totalMemoryEncryption` - at device startup - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: only for `totalMemoryEncryption` * Reported for affiliated users only: N/A
940
970
  */
@@ -1114,6 +1144,19 @@ export namespace chromemanagement_v1 {
1114
1144
  */
1115
1145
  updateState?: string | null;
1116
1146
  }
1147
+ /**
1148
+ * Peripherals report.
1149
+ */
1150
+ export interface Schema$GoogleChromeManagementV1PeripheralsReport {
1151
+ /**
1152
+ * Output only. Timestamp of when the report was collected.
1153
+ */
1154
+ reportTime?: string | null;
1155
+ /**
1156
+ * Reports of all usb connected devices.
1157
+ */
1158
+ usbPeripheralReport?: Schema$GoogleChromeManagementV1UsbPeripheralReport[];
1159
+ }
1117
1160
  /**
1118
1161
  * Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceStorageStatus](https://chromeenterprise.google/policies/#ReportDeviceStorageStatus) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A
1119
1162
  */
@@ -1161,6 +1204,10 @@ export namespace chromemanagement_v1 {
1161
1204
  */
1162
1205
  reportTime?: string | null;
1163
1206
  }
1207
+ /**
1208
+ * `TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds.
1209
+ */
1210
+ export interface Schema$GoogleChromeManagementV1TelemetryAudioSevereUnderrunEvent {}
1164
1211
  /**
1165
1212
  * Telemetry data collected from a managed device.
1166
1213
  */
@@ -1237,6 +1284,10 @@ export namespace chromemanagement_v1 {
1237
1284
  * Output only. Contains relevant information regarding ChromeOS update status.
1238
1285
  */
1239
1286
  osUpdateStatus?: Schema$GoogleChromeManagementV1OsUpdateStatus[];
1287
+ /**
1288
+ * Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time.
1289
+ */
1290
+ peripheralsReport?: Schema$GoogleChromeManagementV1PeripheralsReport[];
1240
1291
  /**
1241
1292
  * Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab.
1242
1293
  */
@@ -1254,6 +1305,137 @@ export namespace chromemanagement_v1 {
1254
1305
  */
1255
1306
  thunderboltInfo?: Schema$GoogleChromeManagementV1ThunderboltInfo[];
1256
1307
  }
1308
+ /**
1309
+ * Information about a device associated with telemetry data.
1310
+ */
1311
+ export interface Schema$GoogleChromeManagementV1TelemetryDeviceInfo {
1312
+ /**
1313
+ * Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.
1314
+ */
1315
+ deviceId?: string | null;
1316
+ /**
1317
+ * Output only. Organization unit ID of the device.
1318
+ */
1319
+ orgUnitId?: string | null;
1320
+ }
1321
+ /**
1322
+ * Telemetry data reported by a managed device.
1323
+ */
1324
+ export interface Schema$GoogleChromeManagementV1TelemetryEvent {
1325
+ /**
1326
+ * Output only. Payload for audio severe underrun event. Present only when the `event_type` field is `AUDIO_SEVERE_UNDERRUN`.
1327
+ */
1328
+ audioSevereUnderrunEvent?: Schema$GoogleChromeManagementV1TelemetryAudioSevereUnderrunEvent;
1329
+ /**
1330
+ * Output only. Information about the device associated with the event.
1331
+ */
1332
+ device?: Schema$GoogleChromeManagementV1TelemetryDeviceInfo;
1333
+ /**
1334
+ * The event type of the current event.
1335
+ */
1336
+ eventType?: string | null;
1337
+ /**
1338
+ * Output only. Payload for HTTPS latency change event. Present only when `event_type` is `NETWORK_HTTPS_LATENCY_CHANGE`.
1339
+ */
1340
+ httpsLatencyChangeEvent?: Schema$GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent;
1341
+ /**
1342
+ * Output only. Resource name of the event.
1343
+ */
1344
+ name?: string | null;
1345
+ /**
1346
+ * Timestamp that represents when the event was reported.
1347
+ */
1348
+ reportTime?: string | null;
1349
+ /**
1350
+ * Output only. Payload for usb peripherals event. Present only when the `event_type` field is either `USB_ADDED` or `USB_REMOVED`.
1351
+ */
1352
+ usbPeripheralsEvent?: Schema$GoogleChromeManagementV1TelemetryUsbPeripheralsEvent;
1353
+ /**
1354
+ * Output only. Information about the user associated with the event.
1355
+ */
1356
+ user?: Schema$GoogleChromeManagementV1TelemetryUserInfo;
1357
+ }
1358
+ /**
1359
+ * Https latency routine is run periodically and `TelemetryHttpsLatencyChangeEvent` is triggered if a latency problem was detected or if the device has recovered from a latency problem..
1360
+ */
1361
+ export interface Schema$GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent {
1362
+ /**
1363
+ * HTTPS latency routine data that triggered the event.
1364
+ */
1365
+ httpsLatencyRoutineData?: Schema$GoogleChromeManagementV1HttpsLatencyRoutineData;
1366
+ /**
1367
+ * Current HTTPS latency state.
1368
+ */
1369
+ httpsLatencyState?: string | null;
1370
+ }
1371
+ /**
1372
+ * `TelemetryUsbPeripheralsEvent` is triggered USB devices are either added or removed.
1373
+ */
1374
+ export interface Schema$GoogleChromeManagementV1TelemetryUsbPeripheralsEvent {
1375
+ /**
1376
+ * List of usb devices that were either added or removed.
1377
+ */
1378
+ usbPeripheralReport?: Schema$GoogleChromeManagementV1UsbPeripheralReport[];
1379
+ }
1380
+ /**
1381
+ * Telemetry data collected from a managed user.
1382
+ */
1383
+ export interface Schema$GoogleChromeManagementV1TelemetryUser {
1384
+ /**
1385
+ * G Suite Customer whose enterprise enrolled the device.
1386
+ */
1387
+ customer?: string | null;
1388
+ /**
1389
+ * Resource name of the user.
1390
+ */
1391
+ name?: string | null;
1392
+ /**
1393
+ * Organization unit of the user.
1394
+ */
1395
+ orgUnitId?: string | null;
1396
+ /**
1397
+ * Telemetry data collected from a managed user and device.
1398
+ */
1399
+ userDevice?: Schema$GoogleChromeManagementV1TelemetryUserDevice[];
1400
+ /**
1401
+ * Email address of the user.
1402
+ */
1403
+ userEmail?: string | null;
1404
+ /**
1405
+ * Directory ID of the user.
1406
+ */
1407
+ userId?: string | null;
1408
+ }
1409
+ /**
1410
+ * Telemetry data collected for a managed user and device.
1411
+ */
1412
+ export interface Schema$GoogleChromeManagementV1TelemetryUserDevice {
1413
+ /**
1414
+ * Output only. Audio reports collected periodically sorted in a decreasing order of report_time.
1415
+ */
1416
+ audioStatusReport?: Schema$GoogleChromeManagementV1AudioStatusReport[];
1417
+ /**
1418
+ * The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.
1419
+ */
1420
+ deviceId?: string | null;
1421
+ /**
1422
+ * Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time.
1423
+ */
1424
+ peripheralsReport?: Schema$GoogleChromeManagementV1PeripheralsReport[];
1425
+ }
1426
+ /**
1427
+ * Information about a user associated with telemetry data.
1428
+ */
1429
+ export interface Schema$GoogleChromeManagementV1TelemetryUserInfo {
1430
+ /**
1431
+ * Output only. User's email.
1432
+ */
1433
+ email?: string | null;
1434
+ /**
1435
+ * Output only. Organization unit ID of the user.
1436
+ */
1437
+ orgUnitId?: string | null;
1438
+ }
1257
1439
  /**
1258
1440
  * Thunderbolt bus info. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceSecurityStatus](https://chromeenterprise.google/policies/#ReportDeviceSecurityStatus) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: At device startup - Policy Controlled: No * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: Yes * Reported for affiliated users only: N/A
1259
1441
  */
@@ -1284,6 +1466,43 @@ export namespace chromemanagement_v1 {
1284
1466
  */
1285
1467
  maxKeys?: string | null;
1286
1468
  }
1469
+ /**
1470
+ * USB connected peripheral report.
1471
+ */
1472
+ export interface Schema$GoogleChromeManagementV1UsbPeripheralReport {
1473
+ /**
1474
+ * Output only. Categories the device belongs to https://www.usb.org/defined-class-codes
1475
+ */
1476
+ categories?: string[] | null;
1477
+ /**
1478
+ * Output only. Class ID https://www.usb.org/defined-class-codes
1479
+ */
1480
+ classId?: number | null;
1481
+ /**
1482
+ * Output only. Firmware version
1483
+ */
1484
+ firmwareVersion?: string | null;
1485
+ /**
1486
+ * Output only. Device name, model name, or product name
1487
+ */
1488
+ name?: string | null;
1489
+ /**
1490
+ * Output only. Product ID
1491
+ */
1492
+ pid?: number | null;
1493
+ /**
1494
+ * Output only. Subclass ID https://www.usb.org/defined-class-codes
1495
+ */
1496
+ subclassId?: number | null;
1497
+ /**
1498
+ * Output only. Vendor name
1499
+ */
1500
+ vendor?: string | null;
1501
+ /**
1502
+ * Output only. Vendor ID
1503
+ */
1504
+ vid?: number | null;
1505
+ }
1287
1506
  /**
1288
1507
  * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
1289
1508
  */
@@ -2673,9 +2892,9 @@ export namespace chromemanagement_v1 {
2673
2892
  * const res = await chromemanagement.customers.reports.countInstalledApps({
2674
2893
  * // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
2675
2894
  * customer: 'customers/my-customer',
2676
- * // Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name
2895
+ * // Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id
2677
2896
  * filter: 'placeholder-value',
2678
- * // Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count
2897
+ * // Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id
2679
2898
  * orderBy: 'placeholder-value',
2680
2899
  * // The ID of the organizational unit.
2681
2900
  * orgUnitId: 'placeholder-value',
@@ -3031,11 +3250,11 @@ export namespace chromemanagement_v1 {
3031
3250
  */
3032
3251
  customer?: string;
3033
3252
  /**
3034
- * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name
3253
+ * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id
3035
3254
  */
3036
3255
  filter?: string;
3037
3256
  /**
3038
- * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count
3257
+ * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id
3039
3258
  */
3040
3259
  orderBy?: string;
3041
3260
  /**
@@ -3090,9 +3309,13 @@ export namespace chromemanagement_v1 {
3090
3309
  export class Resource$Customers$Telemetry {
3091
3310
  context: APIRequestContext;
3092
3311
  devices: Resource$Customers$Telemetry$Devices;
3312
+ events: Resource$Customers$Telemetry$Events;
3313
+ users: Resource$Customers$Telemetry$Users;
3093
3314
  constructor(context: APIRequestContext) {
3094
3315
  this.context = context;
3095
3316
  this.devices = new Resource$Customers$Telemetry$Devices(this.context);
3317
+ this.events = new Resource$Customers$Telemetry$Events(this.context);
3318
+ this.users = new Resource$Customers$Telemetry$Users(this.context);
3096
3319
  }
3097
3320
  }
3098
3321
 
@@ -3158,6 +3381,7 @@ export namespace chromemanagement_v1 {
3158
3381
  * // "networkStatusReport": [],
3159
3382
  * // "orgUnitId": "my_orgUnitId",
3160
3383
  * // "osUpdateStatus": [],
3384
+ * // "peripheralsReport": [],
3161
3385
  * // "serialNumber": "my_serialNumber",
3162
3386
  * // "storageInfo": {},
3163
3387
  * // "storageStatusReport": [],
@@ -3448,4 +3672,522 @@ export namespace chromemanagement_v1 {
3448
3672
  */
3449
3673
  readMask?: string;
3450
3674
  }
3675
+
3676
+ export class Resource$Customers$Telemetry$Events {
3677
+ context: APIRequestContext;
3678
+ constructor(context: APIRequestContext) {
3679
+ this.context = context;
3680
+ }
3681
+
3682
+ /**
3683
+ * List telemetry events.
3684
+ * @example
3685
+ * ```js
3686
+ * // Before running the sample:
3687
+ * // - Enable the API at:
3688
+ * // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
3689
+ * // - Login into gcloud by running:
3690
+ * // `$ gcloud auth application-default login`
3691
+ * // - Install the npm module by running:
3692
+ * // `$ npm install googleapis`
3693
+ *
3694
+ * const {google} = require('googleapis');
3695
+ * const chromemanagement = google.chromemanagement('v1');
3696
+ *
3697
+ * async function main() {
3698
+ * const auth = new google.auth.GoogleAuth({
3699
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3700
+ * scopes: [
3701
+ * 'https://www.googleapis.com/auth/chrome.management.telemetry.readonly',
3702
+ * ],
3703
+ * });
3704
+ *
3705
+ * // Acquire an auth client, and bind it to all future calls
3706
+ * const authClient = await auth.getClient();
3707
+ * google.options({auth: authClient});
3708
+ *
3709
+ * // Do the magic
3710
+ * const res = await chromemanagement.customers.telemetry.events.list({
3711
+ * // Optional. Only include resources that match the filter. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The "timestamp" filter accepts either Epoch milliseconds or RFC 3339 formatted time surrounded by simple double quotes.
3712
+ * filter: 'placeholder-value',
3713
+ * // Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000.
3714
+ * pageSize: 'placeholder-value',
3715
+ * // Optional. Token to specify next page in the list.
3716
+ * pageToken: 'placeholder-value',
3717
+ * // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
3718
+ * parent: 'customers/my-customer',
3719
+ * // Required. Read mask to specify which fields to return.
3720
+ * readMask: 'placeholder-value',
3721
+ * });
3722
+ * console.log(res.data);
3723
+ *
3724
+ * // Example response
3725
+ * // {
3726
+ * // "nextPageToken": "my_nextPageToken",
3727
+ * // "telemetryEvents": []
3728
+ * // }
3729
+ * }
3730
+ *
3731
+ * main().catch(e => {
3732
+ * console.error(e);
3733
+ * throw e;
3734
+ * });
3735
+ *
3736
+ * ```
3737
+ *
3738
+ * @param params - Parameters for request
3739
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3740
+ * @param callback - Optional callback that handles the response.
3741
+ * @returns A promise if used with async/await, or void if used with a callback.
3742
+ */
3743
+ list(
3744
+ params: Params$Resource$Customers$Telemetry$Events$List,
3745
+ options: StreamMethodOptions
3746
+ ): GaxiosPromise<Readable>;
3747
+ list(
3748
+ params?: Params$Resource$Customers$Telemetry$Events$List,
3749
+ options?: MethodOptions
3750
+ ): GaxiosPromise<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>;
3751
+ list(
3752
+ params: Params$Resource$Customers$Telemetry$Events$List,
3753
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3754
+ callback: BodyResponseCallback<Readable>
3755
+ ): void;
3756
+ list(
3757
+ params: Params$Resource$Customers$Telemetry$Events$List,
3758
+ options:
3759
+ | MethodOptions
3760
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>,
3761
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>
3762
+ ): void;
3763
+ list(
3764
+ params: Params$Resource$Customers$Telemetry$Events$List,
3765
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>
3766
+ ): void;
3767
+ list(
3768
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>
3769
+ ): void;
3770
+ list(
3771
+ paramsOrCallback?:
3772
+ | Params$Resource$Customers$Telemetry$Events$List
3773
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>
3774
+ | BodyResponseCallback<Readable>,
3775
+ optionsOrCallback?:
3776
+ | MethodOptions
3777
+ | StreamMethodOptions
3778
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>
3779
+ | BodyResponseCallback<Readable>,
3780
+ callback?:
3781
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>
3782
+ | BodyResponseCallback<Readable>
3783
+ ):
3784
+ | void
3785
+ | GaxiosPromise<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>
3786
+ | GaxiosPromise<Readable> {
3787
+ let params = (paramsOrCallback ||
3788
+ {}) as Params$Resource$Customers$Telemetry$Events$List;
3789
+ let options = (optionsOrCallback || {}) as MethodOptions;
3790
+
3791
+ if (typeof paramsOrCallback === 'function') {
3792
+ callback = paramsOrCallback;
3793
+ params = {} as Params$Resource$Customers$Telemetry$Events$List;
3794
+ options = {};
3795
+ }
3796
+
3797
+ if (typeof optionsOrCallback === 'function') {
3798
+ callback = optionsOrCallback;
3799
+ options = {};
3800
+ }
3801
+
3802
+ const rootUrl =
3803
+ options.rootUrl || 'https://chromemanagement.googleapis.com/';
3804
+ const parameters = {
3805
+ options: Object.assign(
3806
+ {
3807
+ url: (rootUrl + '/v1/{+parent}/telemetry/events').replace(
3808
+ /([^:]\/)\/+/g,
3809
+ '$1'
3810
+ ),
3811
+ method: 'GET',
3812
+ },
3813
+ options
3814
+ ),
3815
+ params,
3816
+ requiredParams: ['parent'],
3817
+ pathParams: ['parent'],
3818
+ context: this.context,
3819
+ };
3820
+ if (callback) {
3821
+ createAPIRequest<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>(
3822
+ parameters,
3823
+ callback as BodyResponseCallback<unknown>
3824
+ );
3825
+ } else {
3826
+ return createAPIRequest<Schema$GoogleChromeManagementV1ListTelemetryEventsResponse>(
3827
+ parameters
3828
+ );
3829
+ }
3830
+ }
3831
+ }
3832
+
3833
+ export interface Params$Resource$Customers$Telemetry$Events$List
3834
+ extends StandardParameters {
3835
+ /**
3836
+ * Optional. Only include resources that match the filter. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The "timestamp" filter accepts either Epoch milliseconds or RFC 3339 formatted time surrounded by simple double quotes.
3837
+ */
3838
+ filter?: string;
3839
+ /**
3840
+ * Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000.
3841
+ */
3842
+ pageSize?: number;
3843
+ /**
3844
+ * Optional. Token to specify next page in the list.
3845
+ */
3846
+ pageToken?: string;
3847
+ /**
3848
+ * Required. Customer id or "my_customer" to use the customer associated to the account making the request.
3849
+ */
3850
+ parent?: string;
3851
+ /**
3852
+ * Required. Read mask to specify which fields to return.
3853
+ */
3854
+ readMask?: string;
3855
+ }
3856
+
3857
+ export class Resource$Customers$Telemetry$Users {
3858
+ context: APIRequestContext;
3859
+ constructor(context: APIRequestContext) {
3860
+ this.context = context;
3861
+ }
3862
+
3863
+ /**
3864
+ * Get telemetry user.
3865
+ * @example
3866
+ * ```js
3867
+ * // Before running the sample:
3868
+ * // - Enable the API at:
3869
+ * // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
3870
+ * // - Login into gcloud by running:
3871
+ * // `$ gcloud auth application-default login`
3872
+ * // - Install the npm module by running:
3873
+ * // `$ npm install googleapis`
3874
+ *
3875
+ * const {google} = require('googleapis');
3876
+ * const chromemanagement = google.chromemanagement('v1');
3877
+ *
3878
+ * async function main() {
3879
+ * const auth = new google.auth.GoogleAuth({
3880
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3881
+ * scopes: [
3882
+ * 'https://www.googleapis.com/auth/chrome.management.telemetry.readonly',
3883
+ * ],
3884
+ * });
3885
+ *
3886
+ * // Acquire an auth client, and bind it to all future calls
3887
+ * const authClient = await auth.getClient();
3888
+ * google.options({auth: authClient});
3889
+ *
3890
+ * // Do the magic
3891
+ * const res = await chromemanagement.customers.telemetry.users.get({
3892
+ * // Required. Name of the `TelemetryUser` to return.
3893
+ * name: 'customers/my-customer/telemetry/users/my-user',
3894
+ * // Read mask to specify which fields to return.
3895
+ * readMask: 'placeholder-value',
3896
+ * });
3897
+ * console.log(res.data);
3898
+ *
3899
+ * // Example response
3900
+ * // {
3901
+ * // "customer": "my_customer",
3902
+ * // "name": "my_name",
3903
+ * // "orgUnitId": "my_orgUnitId",
3904
+ * // "userDevice": [],
3905
+ * // "userEmail": "my_userEmail",
3906
+ * // "userId": "my_userId"
3907
+ * // }
3908
+ * }
3909
+ *
3910
+ * main().catch(e => {
3911
+ * console.error(e);
3912
+ * throw e;
3913
+ * });
3914
+ *
3915
+ * ```
3916
+ *
3917
+ * @param params - Parameters for request
3918
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3919
+ * @param callback - Optional callback that handles the response.
3920
+ * @returns A promise if used with async/await, or void if used with a callback.
3921
+ */
3922
+ get(
3923
+ params: Params$Resource$Customers$Telemetry$Users$Get,
3924
+ options: StreamMethodOptions
3925
+ ): GaxiosPromise<Readable>;
3926
+ get(
3927
+ params?: Params$Resource$Customers$Telemetry$Users$Get,
3928
+ options?: MethodOptions
3929
+ ): GaxiosPromise<Schema$GoogleChromeManagementV1TelemetryUser>;
3930
+ get(
3931
+ params: Params$Resource$Customers$Telemetry$Users$Get,
3932
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3933
+ callback: BodyResponseCallback<Readable>
3934
+ ): void;
3935
+ get(
3936
+ params: Params$Resource$Customers$Telemetry$Users$Get,
3937
+ options:
3938
+ | MethodOptions
3939
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>,
3940
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>
3941
+ ): void;
3942
+ get(
3943
+ params: Params$Resource$Customers$Telemetry$Users$Get,
3944
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>
3945
+ ): void;
3946
+ get(
3947
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>
3948
+ ): void;
3949
+ get(
3950
+ paramsOrCallback?:
3951
+ | Params$Resource$Customers$Telemetry$Users$Get
3952
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>
3953
+ | BodyResponseCallback<Readable>,
3954
+ optionsOrCallback?:
3955
+ | MethodOptions
3956
+ | StreamMethodOptions
3957
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>
3958
+ | BodyResponseCallback<Readable>,
3959
+ callback?:
3960
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1TelemetryUser>
3961
+ | BodyResponseCallback<Readable>
3962
+ ):
3963
+ | void
3964
+ | GaxiosPromise<Schema$GoogleChromeManagementV1TelemetryUser>
3965
+ | GaxiosPromise<Readable> {
3966
+ let params = (paramsOrCallback ||
3967
+ {}) as Params$Resource$Customers$Telemetry$Users$Get;
3968
+ let options = (optionsOrCallback || {}) as MethodOptions;
3969
+
3970
+ if (typeof paramsOrCallback === 'function') {
3971
+ callback = paramsOrCallback;
3972
+ params = {} as Params$Resource$Customers$Telemetry$Users$Get;
3973
+ options = {};
3974
+ }
3975
+
3976
+ if (typeof optionsOrCallback === 'function') {
3977
+ callback = optionsOrCallback;
3978
+ options = {};
3979
+ }
3980
+
3981
+ const rootUrl =
3982
+ options.rootUrl || 'https://chromemanagement.googleapis.com/';
3983
+ const parameters = {
3984
+ options: Object.assign(
3985
+ {
3986
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
3987
+ method: 'GET',
3988
+ },
3989
+ options
3990
+ ),
3991
+ params,
3992
+ requiredParams: ['name'],
3993
+ pathParams: ['name'],
3994
+ context: this.context,
3995
+ };
3996
+ if (callback) {
3997
+ createAPIRequest<Schema$GoogleChromeManagementV1TelemetryUser>(
3998
+ parameters,
3999
+ callback as BodyResponseCallback<unknown>
4000
+ );
4001
+ } else {
4002
+ return createAPIRequest<Schema$GoogleChromeManagementV1TelemetryUser>(
4003
+ parameters
4004
+ );
4005
+ }
4006
+ }
4007
+
4008
+ /**
4009
+ * List all telemetry users.
4010
+ * @example
4011
+ * ```js
4012
+ * // Before running the sample:
4013
+ * // - Enable the API at:
4014
+ * // https://console.developers.google.com/apis/api/chromemanagement.googleapis.com
4015
+ * // - Login into gcloud by running:
4016
+ * // `$ gcloud auth application-default login`
4017
+ * // - Install the npm module by running:
4018
+ * // `$ npm install googleapis`
4019
+ *
4020
+ * const {google} = require('googleapis');
4021
+ * const chromemanagement = google.chromemanagement('v1');
4022
+ *
4023
+ * async function main() {
4024
+ * const auth = new google.auth.GoogleAuth({
4025
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4026
+ * scopes: [
4027
+ * 'https://www.googleapis.com/auth/chrome.management.telemetry.readonly',
4028
+ * ],
4029
+ * });
4030
+ *
4031
+ * // Acquire an auth client, and bind it to all future calls
4032
+ * const authClient = await auth.getClient();
4033
+ * google.options({auth: authClient});
4034
+ *
4035
+ * // Do the magic
4036
+ * const res = await chromemanagement.customers.telemetry.users.list({
4037
+ * // Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id
4038
+ * filter: 'placeholder-value',
4039
+ * // Maximum number of results to return. Default value is 100. Maximum value is 1000.
4040
+ * pageSize: 'placeholder-value',
4041
+ * // Token to specify next page in the list.
4042
+ * pageToken: 'placeholder-value',
4043
+ * // Required. Customer id or "my_customer" to use the customer associated to the account making the request.
4044
+ * parent: 'customers/my-customer',
4045
+ * // Read mask to specify which fields to return.
4046
+ * readMask: 'placeholder-value',
4047
+ * });
4048
+ * console.log(res.data);
4049
+ *
4050
+ * // Example response
4051
+ * // {
4052
+ * // "nextPageToken": "my_nextPageToken",
4053
+ * // "telemetryUsers": []
4054
+ * // }
4055
+ * }
4056
+ *
4057
+ * main().catch(e => {
4058
+ * console.error(e);
4059
+ * throw e;
4060
+ * });
4061
+ *
4062
+ * ```
4063
+ *
4064
+ * @param params - Parameters for request
4065
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4066
+ * @param callback - Optional callback that handles the response.
4067
+ * @returns A promise if used with async/await, or void if used with a callback.
4068
+ */
4069
+ list(
4070
+ params: Params$Resource$Customers$Telemetry$Users$List,
4071
+ options: StreamMethodOptions
4072
+ ): GaxiosPromise<Readable>;
4073
+ list(
4074
+ params?: Params$Resource$Customers$Telemetry$Users$List,
4075
+ options?: MethodOptions
4076
+ ): GaxiosPromise<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>;
4077
+ list(
4078
+ params: Params$Resource$Customers$Telemetry$Users$List,
4079
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
4080
+ callback: BodyResponseCallback<Readable>
4081
+ ): void;
4082
+ list(
4083
+ params: Params$Resource$Customers$Telemetry$Users$List,
4084
+ options:
4085
+ | MethodOptions
4086
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>,
4087
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>
4088
+ ): void;
4089
+ list(
4090
+ params: Params$Resource$Customers$Telemetry$Users$List,
4091
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>
4092
+ ): void;
4093
+ list(
4094
+ callback: BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>
4095
+ ): void;
4096
+ list(
4097
+ paramsOrCallback?:
4098
+ | Params$Resource$Customers$Telemetry$Users$List
4099
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>
4100
+ | BodyResponseCallback<Readable>,
4101
+ optionsOrCallback?:
4102
+ | MethodOptions
4103
+ | StreamMethodOptions
4104
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>
4105
+ | BodyResponseCallback<Readable>,
4106
+ callback?:
4107
+ | BodyResponseCallback<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>
4108
+ | BodyResponseCallback<Readable>
4109
+ ):
4110
+ | void
4111
+ | GaxiosPromise<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>
4112
+ | GaxiosPromise<Readable> {
4113
+ let params = (paramsOrCallback ||
4114
+ {}) as Params$Resource$Customers$Telemetry$Users$List;
4115
+ let options = (optionsOrCallback || {}) as MethodOptions;
4116
+
4117
+ if (typeof paramsOrCallback === 'function') {
4118
+ callback = paramsOrCallback;
4119
+ params = {} as Params$Resource$Customers$Telemetry$Users$List;
4120
+ options = {};
4121
+ }
4122
+
4123
+ if (typeof optionsOrCallback === 'function') {
4124
+ callback = optionsOrCallback;
4125
+ options = {};
4126
+ }
4127
+
4128
+ const rootUrl =
4129
+ options.rootUrl || 'https://chromemanagement.googleapis.com/';
4130
+ const parameters = {
4131
+ options: Object.assign(
4132
+ {
4133
+ url: (rootUrl + '/v1/{+parent}/telemetry/users').replace(
4134
+ /([^:]\/)\/+/g,
4135
+ '$1'
4136
+ ),
4137
+ method: 'GET',
4138
+ },
4139
+ options
4140
+ ),
4141
+ params,
4142
+ requiredParams: ['parent'],
4143
+ pathParams: ['parent'],
4144
+ context: this.context,
4145
+ };
4146
+ if (callback) {
4147
+ createAPIRequest<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>(
4148
+ parameters,
4149
+ callback as BodyResponseCallback<unknown>
4150
+ );
4151
+ } else {
4152
+ return createAPIRequest<Schema$GoogleChromeManagementV1ListTelemetryUsersResponse>(
4153
+ parameters
4154
+ );
4155
+ }
4156
+ }
4157
+ }
4158
+
4159
+ export interface Params$Resource$Customers$Telemetry$Users$Get
4160
+ extends StandardParameters {
4161
+ /**
4162
+ * Required. Name of the `TelemetryUser` to return.
4163
+ */
4164
+ name?: string;
4165
+ /**
4166
+ * Read mask to specify which fields to return.
4167
+ */
4168
+ readMask?: string;
4169
+ }
4170
+ export interface Params$Resource$Customers$Telemetry$Users$List
4171
+ extends StandardParameters {
4172
+ /**
4173
+ * Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id
4174
+ */
4175
+ filter?: string;
4176
+ /**
4177
+ * Maximum number of results to return. Default value is 100. Maximum value is 1000.
4178
+ */
4179
+ pageSize?: number;
4180
+ /**
4181
+ * Token to specify next page in the list.
4182
+ */
4183
+ pageToken?: string;
4184
+ /**
4185
+ * Required. Customer id or "my_customer" to use the customer associated to the account making the request.
4186
+ */
4187
+ parent?: string;
4188
+ /**
4189
+ * Read mask to specify which fields to return.
4190
+ */
4191
+ readMask?: string;
4192
+ }
3451
4193
  }