From e4108c28f970af0a79b8e6127a9bc4d122478b54 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 31 Jan 2023 07:07:56 +0000 Subject: [PATCH] feat(chromemanagement): update the api #### chromemanagement:v1 The following keys were added: - resources.customers.resources.telemetry.resources.users.methods.get (Total Keys: 14) - resources.customers.resources.telemetry.resources.users.methods.list (Total Keys: 21) - schemas.GoogleChromeManagementV1ListTelemetryUsersResponse (Total Keys: 5) - schemas.GoogleChromeManagementV1PeripheralsReport (Total Keys: 7) - schemas.GoogleChromeManagementV1TelemetryUser (Total Keys: 18) --- ...chromemanagement_v1.customers.reports.html | 4 +- ...agement_v1.customers.telemetry.events.html | 2 +- ...romemanagement_v1.customers.telemetry.html | 5 + ...nagement_v1.customers.telemetry.users.html | 235 ++++++++++++++++++ .../documents/chromemanagement.v1.json | 191 +++++++++++++- 5 files changed, 428 insertions(+), 9 deletions(-) create mode 100644 docs/dyn/chromemanagement_v1.customers.telemetry.users.html diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index fffdbb8d75f..fdc82c9278f 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -262,8 +262,8 @@

Method Details

Args: customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) - filter: string, 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 - orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count + filter: string, 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 + orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id orgUnitId: string, The ID of the organizational unit. pageSize: integer, Maximum number of results to return. Maximum and default are 100. pageToken: string, Token to specify the page of the request to be returned. diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html index a8bc1ca6063..e7ac95891fa 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) - filter: string, 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 + filter: string, 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. pageSize: integer, Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000. pageToken: string, Optional. Token to specify next page in the list. readMask: string, Required. Read mask to specify which fields to return. diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.html b/docs/dyn/chromemanagement_v1.customers.telemetry.html index d44e3f9ecb6..e651aee43ee 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.html @@ -84,6 +84,11 @@

Instance Methods

Returns the events Resource.

+

+ users() +

+

Returns the users Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.users.html b/docs/dyn/chromemanagement_v1.customers.telemetry.users.html new file mode 100644 index 00000000000..0071c8e01a2 --- /dev/null +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.users.html @@ -0,0 +1,235 @@ + + + +

Chrome Management API . customers . telemetry . users

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, readMask=None, x__xgafv=None)

+

Get telemetry user.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

List all telemetry users.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, readMask=None, x__xgafv=None) + 
Get telemetry user.
+
+Args:
+  name: string, Required. Name of the `TelemetryUser` to return. (required)
+  readMask: string, Read mask to specify which fields to return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Telemetry data collected from a managed user.
+  "customer": "A String", # G Suite Customer whose enterprise enrolled the device.
+  "name": "A String", # Resource name of the user.
+  "orgUnitId": "A String", # Organization unit of the user.
+  "userDevice": [ # Telemetry data collected from a managed user and device.
+    { # Telemetry data collected for a managed user and device.
+      "audioStatusReport": [ # Output only. Audio reports collected periodically sorted in a decreasing order of report_time.
+        { # 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: [ReportDeviceAudioStatus](https://chromeenterprise.google/policies/#ReportDeviceAudioStatus) * Data Collection Frequency: 10 minutes * 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
+          "inputDevice": "A String", # Output only. Active input device's name.
+          "inputGain": 42, # Output only. Active input device's gain in [0, 100].
+          "inputMute": True or False, # Output only. Is active input device mute or not.
+          "outputDevice": "A String", # Output only. Active output device's name.
+          "outputMute": True or False, # Output only. Is active output device mute or not.
+          "outputVolume": 42, # Output only. Active output device's volume in [0, 100].
+          "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device.
+        },
+      ],
+      "deviceId": "A String", # 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.
+      "peripheralsReport": [ # Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time.
+        { # Peripherals report.
+          "reportTime": "A String", # Output only. Timestamp of when the report was collected.
+          "usbPeripheralReport": [ # Reports of all usb connected devices.
+            { # USB connected peripheral report.
+              "categories": [ # Output only. Categories the device belongs to https://www.usb.org/defined-class-codes
+                "A String",
+              ],
+              "classId": 42, # Output only. Class ID https://www.usb.org/defined-class-codes
+              "firmwareVersion": "A String", # Output only. Firmware version
+              "name": "A String", # Output only. Device name, model name, or product name
+              "pid": 42, # Output only. Product ID
+              "subclassId": 42, # Output only. Subclass ID https://www.usb.org/defined-class-codes
+              "vendor": "A String", # Output only. Vendor name
+              "vid": 42, # Output only. Vendor ID
+            },
+          ],
+        },
+      ],
+    },
+  ],
+  "userEmail": "A String", # Email address of the user.
+  "userId": "A String", # Directory ID of the user.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) + 
List all telemetry users.
+
+Args:
+  parent: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required)
+  filter: string, Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id 
+  pageSize: integer, Maximum number of results to return. Default value is 100. Maximum value is 1000.
+  pageToken: string, Token to specify next page in the list.
+  readMask: string, Read mask to specify which fields to return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for listing telemetry users for a customer.
+  "nextPageToken": "A String", # Token to specify next page in the list.
+  "telemetryUsers": [ # Telemetry users returned in the response.
+    { # Telemetry data collected from a managed user.
+      "customer": "A String", # G Suite Customer whose enterprise enrolled the device.
+      "name": "A String", # Resource name of the user.
+      "orgUnitId": "A String", # Organization unit of the user.
+      "userDevice": [ # Telemetry data collected from a managed user and device.
+        { # Telemetry data collected for a managed user and device.
+          "audioStatusReport": [ # Output only. Audio reports collected periodically sorted in a decreasing order of report_time.
+            { # 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: [ReportDeviceAudioStatus](https://chromeenterprise.google/policies/#ReportDeviceAudioStatus) * Data Collection Frequency: 10 minutes * 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
+              "inputDevice": "A String", # Output only. Active input device's name.
+              "inputGain": 42, # Output only. Active input device's gain in [0, 100].
+              "inputMute": True or False, # Output only. Is active input device mute or not.
+              "outputDevice": "A String", # Output only. Active output device's name.
+              "outputMute": True or False, # Output only. Is active output device mute or not.
+              "outputVolume": 42, # Output only. Active output device's volume in [0, 100].
+              "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device.
+            },
+          ],
+          "deviceId": "A String", # 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.
+          "peripheralsReport": [ # Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time.
+            { # Peripherals report.
+              "reportTime": "A String", # Output only. Timestamp of when the report was collected.
+              "usbPeripheralReport": [ # Reports of all usb connected devices.
+                { # USB connected peripheral report.
+                  "categories": [ # Output only. Categories the device belongs to https://www.usb.org/defined-class-codes
+                    "A String",
+                  ],
+                  "classId": 42, # Output only. Class ID https://www.usb.org/defined-class-codes
+                  "firmwareVersion": "A String", # Output only. Firmware version
+                  "name": "A String", # Output only. Device name, model name, or product name
+                  "pid": 42, # Output only. Product ID
+                  "subclassId": 42, # Output only. Subclass ID https://www.usb.org/defined-class-codes
+                  "vendor": "A String", # Output only. Vendor name
+                  "vid": 42, # Output only. Vendor ID
+                },
+              ],
+            },
+          ],
+        },
+      ],
+      "userEmail": "A String", # Email address of the user.
+      "userId": "A String", # Directory ID of the user.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 847a5f243a8..a0c6d2fe1c7 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -429,12 +429,12 @@ "type": "string" }, "filter": { - "description": "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", + "description": "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", "location": "query", "type": "string" }, "orderBy": { - "description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count", + "description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id", "location": "query", "type": "string" }, @@ -638,7 +638,7 @@ ], "parameters": { "filter": { - "description": "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", + "description": "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.", "location": "query", "type": "string" }, @@ -676,13 +676,95 @@ ] } } + }, + "users": { + "methods": { + "get": { + "description": "Get telemetry user.", + "flatPath": "v1/customers/{customersId}/telemetry/users/{usersId}", + "httpMethod": "GET", + "id": "chromemanagement.customers.telemetry.users.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the `TelemetryUser` to return.", + "location": "path", + "pattern": "^customers/[^/]+/telemetry/users/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Read mask to specify which fields to return.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleChromeManagementV1TelemetryUser" + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.telemetry.readonly" + ] + }, + "list": { + "description": "List all telemetry users.", + "flatPath": "v1/customers/{customersId}/telemetry/users", + "httpMethod": "GET", + "id": "chromemanagement.customers.telemetry.users.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id ", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of results to return. Default value is 100. Maximum value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to specify next page in the list.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Customer id or \"my_customer\" to use the customer associated to the account making the request.", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Read mask to specify which fields to return.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/telemetry/users", + "response": { + "$ref": "GoogleChromeManagementV1ListTelemetryUsersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.telemetry.readonly" + ] + } + } } } } } } }, - "revision": "20230122", + "revision": "20230129", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -2006,6 +2088,24 @@ }, "type": "object" }, + "GoogleChromeManagementV1ListTelemetryUsersResponse": { + "description": "Response message for listing telemetry users for a customer.", + "id": "GoogleChromeManagementV1ListTelemetryUsersResponse", + "properties": { + "nextPageToken": { + "description": "Token to specify next page in the list.", + "type": "string" + }, + "telemetryUsers": { + "description": "Telemetry users returned in the response.", + "items": { + "$ref": "GoogleChromeManagementV1TelemetryUser" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleChromeManagementV1MemoryInfo": { "description": "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", "id": "GoogleChromeManagementV1MemoryInfo", @@ -2311,6 +2411,26 @@ }, "type": "object" }, + "GoogleChromeManagementV1PeripheralsReport": { + "description": "Peripherals report.", + "id": "GoogleChromeManagementV1PeripheralsReport", + "properties": { + "reportTime": { + "description": "Output only. Timestamp of when the report was collected.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "usbPeripheralReport": { + "description": "Reports of all usb connected devices.", + "items": { + "$ref": "GoogleChromeManagementV1UsbPeripheralReport" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleChromeManagementV1StorageInfo": { "description": "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", "id": "GoogleChromeManagementV1StorageInfo", @@ -2575,7 +2695,6 @@ "enum": [ "EVENT_TYPE_UNSPECIFIED", "AUDIO_SEVERE_UNDERRUN", - "NETWORK_CONNECTION_STATE_CHANGE", "USB_ADDED", "USB_REMOVED", "NETWORK_HTTPS_LATENCY_CHANGE" @@ -2583,7 +2702,6 @@ "enumDescriptions": [ "Event type unknown.", "Triggered when a audio devices run out of buffer data for more than 5 seconds.", - "Triggered immediately on any changes to a network connection.", "Triggered when USB devices are added.", "Triggered when USB devices are removed.", "Triggered when a new HTTPS latency problem was detected or the device has recovered form an existing HTTPS latency problem." @@ -2657,6 +2775,67 @@ }, "type": "object" }, + "GoogleChromeManagementV1TelemetryUser": { + "description": "Telemetry data collected from a managed user.", + "id": "GoogleChromeManagementV1TelemetryUser", + "properties": { + "customer": { + "description": "G Suite Customer whose enterprise enrolled the device.", + "type": "string" + }, + "name": { + "description": "Resource name of the user.", + "type": "string" + }, + "orgUnitId": { + "description": "Organization unit of the user.", + "type": "string" + }, + "userDevice": { + "description": "Telemetry data collected from a managed user and device.", + "items": { + "$ref": "GoogleChromeManagementV1TelemetryUserDevice" + }, + "type": "array" + }, + "userEmail": { + "description": "Email address of the user.", + "type": "string" + }, + "userId": { + "description": "Directory ID of the user.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleChromeManagementV1TelemetryUserDevice": { + "description": "Telemetry data collected for a managed user and device.", + "id": "GoogleChromeManagementV1TelemetryUserDevice", + "properties": { + "audioStatusReport": { + "description": "Output only. Audio reports collected periodically sorted in a decreasing order of report_time.", + "items": { + "$ref": "GoogleChromeManagementV1AudioStatusReport" + }, + "readOnly": true, + "type": "array" + }, + "deviceId": { + "description": "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.", + "type": "string" + }, + "peripheralsReport": { + "description": "Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time.", + "items": { + "$ref": "GoogleChromeManagementV1PeripheralsReport" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleChromeManagementV1TelemetryUserInfo": { "description": "Information about a user associated with telemetry data.", "id": "GoogleChromeManagementV1TelemetryUserInfo",