From 997636f288f5a1e8ec12957b094c7a5d9921ae85 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 24 May 2023 18:26:59 +0000 Subject: [PATCH] feat(chromemanagement): update the api #### chromemanagement:v1 The following keys were added: - schemas.GoogleChromeManagementV1HeartbeatStatusReport (Total Keys: 5) - schemas.GoogleChromeManagementV1KioskAppStatusReport (Total Keys: 6) - schemas.GoogleChromeManagementV1TelemetryDevice.properties.heartbeatStatusReport (Total Keys: 3) - schemas.GoogleChromeManagementV1TelemetryDevice.properties.kioskAppStatusReport (Total Keys: 3) --- ...gement_v1.customers.telemetry.devices.html | 102 +++++++++------ ...agement_v1.customers.telemetry.events.html | 10 +- ...nagement_v1.customers.telemetry.users.html | 16 +-- .../documents/chromemanagement.v1.json | 118 ++++++++++++++---- 4 files changed, 168 insertions(+), 78 deletions(-) diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html index 079a999a049..fa633e15702 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html @@ -107,9 +107,9 @@

Method Details

Returns: An object of the form: - { # Telemetry data collected from a managed device. + { # Telemetry data collected from a managed device. * Granular permission needed: TELEMETRY_API_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 + { # 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 * Granular permission needed: TELEMETRY_API_AUDIO_REPORT "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. @@ -120,7 +120,7 @@

Method Details

}, ], "batteryInfo": [ # Output only. Information on battery specs for the device. - { # Information about the battery. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 + { # Information about the battery. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 * Granular permission needed: TELEMETRY_API_BATTERY_INFO "designCapacity": "A String", # Output only. Design capacity (mAmpere-hours). "designMinVoltage": 42, # Output only. Designed minimum output voltage (mV) "manufactureDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the battery was manufactured. @@ -134,7 +134,7 @@

Method Details

}, ], "batteryStatusReport": [ # Output only. Battery reports collected periodically. - { # Status data for battery. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 + { # Status data for battery. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 * Granular permission needed: TELEMETRY_API_BATTERY_REPORT "batteryHealth": "A String", # Output only. Battery health. "cycleCount": 42, # Output only. Cycle count. "fullChargeCapacity": "A String", # Output only. Full charge capacity (mAmpere-hours). @@ -155,7 +155,7 @@

Method Details

}, ], "bootPerformanceReport": [ # Output only. Boot performance reports of the device. - { # Boot performance report of a device. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceBootMode](https://chromeenterprise.google/policies/#ReportDeviceBootMode) * Data Collection Frequency: On every boot up event * 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: Yes * Reported for affiliated users only: N/A + { # Boot performance report of a device. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceBootMode](https://chromeenterprise.google/policies/#ReportDeviceBootMode) * Data Collection Frequency: On every boot up event * 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: Yes * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_OS_REPORT "bootUpDuration": "A String", # Total time to boot up. "bootUpTime": "A String", # The timestamp when power came on. "reportTime": "A String", # Timestamp when the report was collected. @@ -165,7 +165,7 @@

Method Details

}, ], "cpuInfo": [ # Output only. Information regarding CPU specs for the device. - { # CPU specifications for the device * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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 + { # CPU specifications for the device * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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 * Granular permission needed: TELEMETRY_API_CPU_INFO "architecture": "A String", # Output only. Architecture type for the CPU. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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 "keylockerConfigured": True or False, # Output only. Whether keylocker is configured.`TRUE` = Enabled; `FALSE` = disabled. Only reported if keylockerSupported = `TRUE`. "keylockerSupported": True or False, # Output only. Whether keylocker is supported. @@ -174,7 +174,7 @@

Method Details

}, ], "cpuStatusReport": [ # Output only. CPU status reports collected periodically sorted in a decreasing order of report_time. - { # Provides information about the status of the CPU. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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 + { # Provides information about the status of the CPU. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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 * Granular permission needed: TELEMETRY_API_CPU_REPORT "cpuTemperatureInfo": [ # Output only. CPU temperature sample info per CPU core in Celsius { # CPU temperature of a device. Sampled per CPU core in Celsius. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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 "label": "A String", # Output only. CPU label. Example: Core 0 @@ -188,7 +188,7 @@

Method Details

], "customer": "A String", # Output only. Google Workspace Customer whose enterprise enrolled the device. "deviceId": "A String", # 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 - "graphicsInfo": { # Information of the graphics subsystem. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceGraphicsStatus](https://chromeenterprise.google/policies/#ReportDeviceGraphicsStatus) * 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 # Output only. Contains information regarding Graphic peripherals for the device. + "graphicsInfo": { # Information of the graphics subsystem. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceGraphicsStatus](https://chromeenterprise.google/policies/#ReportDeviceGraphicsStatus) * 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 * Granular permission needed: TELEMETRY_API_GRAPHICS_INFO # Output only. Contains information regarding Graphic peripherals for the device. "adapterInfo": { # Information of a graphics adapter (GPU). # Output only. Information about the graphics adapter (GPU). "adapter": "A String", # Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2). "deviceId": "A String", # Output only. Represents the graphics card device id. @@ -218,7 +218,7 @@

Method Details

}, }, "graphicsStatusReport": [ # Output only. Graphics reports collected periodically. - { # 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 + { # 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 * Granular permission needed: TELEMETRY_API_GRAPHICS_REPORT "displays": [ # Output only. Information about the displays for the device. { # Information for a display. "deviceId": "A String", # Output only. Represents the graphics card device id. @@ -232,7 +232,20 @@

Method Details

"reportTime": "A String", # Output only. Time at which the graphics data was reported. }, ], - "memoryInfo": { # 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 # Output only. Information regarding memory specs for the device. + "heartbeatStatusReport": [ # Output only. Heartbeat status report containing timestamps periodically sorted in decreasing order of report_time + { # Heartbeat status report of a device. * Available for Kiosks * This field provides online/offline/unknown status of a device and will only be included if the status has changed (e.g. Online -> Offline) * Data for this field is controlled via policy: [HeartbeatEnabled](https://chromeenterprise.google/policies/#HeartbeatEnabled) [More Info](https://support.google.com/chrome/a/answer/6179663#:~:text=On%20the%20Chrome,device%20status%20alerts) * Heartbeat Frequency: 2 mins * Note: If a device goes offline, it can take up to 12 minutes for the online status of the device to be updated * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: N/A * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_DEVICE_ACTIVITY_REPORT + "reportTime": "A String", # Timestamp of when status changed was detected + "state": "A String", # State the device changed to + }, + ], + "kioskAppStatusReport": [ # Output only. Kiosk app status report for the kiosk device + { # Kiosk app status report of a device. * Available for Kiosks * This field provides the app id and version number running on a kiosk device and the timestamp of when the report was last updated * Data for this field is controlled via policy: [ReportDeviceSessionStatus](https://chromeenterprise.google/policies/#ReportDeviceSessionStatus) * 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 * Granular permission needed: TELEMETRY_API_APPS_REPORT + "appId": "A String", # App id of kiosk app for example "mdmkkicfmmkgmpkmkdikhlbggogpicma" + "appVersion": "A String", # App version number of kiosk app for example "1.10.118" + "reportTime": "A String", # Timestamp of when report was collected + }, + ], + "memoryInfo": { # 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 * Granular permission needed: TELEMETRY_API_MEMORY_INFO # Output only. Information regarding memory specs for the device. "availableRamBytes": "A String", # Output only. Amount of available RAM in bytes. "totalMemoryEncryption": { # Memory encryption information of a device. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A # Output only. Total memory encryption info for the device. "encryptionAlgorithm": "A String", # Memory encryption algorithm. @@ -243,7 +256,7 @@

Method Details

"totalRamBytes": "A String", # Output only. Total RAM in bytes. }, "memoryStatusReport": [ # Output only. Memory status reports collected periodically sorted decreasing by report_time. - { # Contains samples of memory status reports. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: Only at upload, SystemRamFreeByes is collected every 10 minutes * Default Data Reporting Frequency: Every 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 + { # Contains samples of memory status reports. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: Only at upload, SystemRamFreeByes is collected every 10 minutes * Default Data Reporting Frequency: Every 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 * Granular permission needed: TELEMETRY_API_MEMORY_REPORT "pageFaults": 42, # Output only. Number of page faults during this collection "reportTime": "A String", # Output only. The timestamp in milliseconds representing time at which this report was sampled. "sampleFrequency": "A String", # Output only. Frequency the report is sampled. @@ -252,7 +265,7 @@

Method Details

], "name": "A String", # Output only. Resource name of the device. "networkDiagnosticsReport": [ # Output only. Network diagnostics collected periodically. - { # Network testing results to determine the health of the device's network connection, for example whether the HTTPS latency is high or normal. + { # Network testing results to determine the health of the device's network connection, for example whether the HTTPS latency is high or normal. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT "httpsLatencyData": { # Data that describes the result of the HTTPS latency diagnostics routine, with the HTTPS requests issued to Google websites. # Output only. HTTPS latency test data. "latency": "A String", # Output only. HTTPS latency if routine succeeded or failed because of HIGH_LATENCY or VERY_HIGH_LATENCY. "problem": "A String", # Output only. HTTPS latency routine problem if a problem occurred. @@ -260,7 +273,7 @@

Method Details

"reportTime": "A String", # Output only. Timestamp of when the diagnostics were collected. }, ], - "networkInfo": { # Network device information. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A # Output only. Network devices information. + "networkInfo": { # Network device information. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_NETWORK_INFO # Output only. Network devices information. "networkDevices": [ # Output only. List of network devices. { # Details about the network device. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A "iccid": "A String", # Output only. The integrated circuit card ID associated with the device's sim card. @@ -273,7 +286,7 @@

Method Details

], }, "networkStatusReport": [ # Output only. Network specs collected periodically. - { # State of visible/configured networks. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportNetworkStatus](https://chromeenterprise.google/policies/#ReportNetworkStatus) * Data Collection Frequency: 60 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: Yes * Reported for affiliated users only: Yes + { # State of visible/configured networks. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportNetworkStatus](https://chromeenterprise.google/policies/#ReportNetworkStatus) * Data Collection Frequency: 60 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: Yes * Reported for affiliated users only: Yes * Granular permission needed: TELEMETRY_API_NETWORK_REPORT "connectionState": "A String", # Output only. Current connection state of the network. "connectionType": "A String", # Output only. Network connection type. "encryptionOn": True or False, # Output only. Whether the wifi encryption key is turned off. @@ -292,7 +305,7 @@

Method Details

], "orgUnitId": "A String", # Output only. Organization unit ID of the device. "osUpdateStatus": [ # Output only. Contains relevant information regarding ChromeOS update status. - { # Contains information regarding the current OS update status. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceOsUpdateStatus](https://chromeenterprise.google/policies/#ReportDeviceOsUpdateStatus) * 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 + { # Contains information regarding the current OS update status. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceOsUpdateStatus](https://chromeenterprise.google/policies/#ReportDeviceOsUpdateStatus) * 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 * Granular permission needed: TELEMETRY_API_OS_REPORT "lastRebootTime": "A String", # Output only. Timestamp of the last reboot. "lastUpdateCheckTime": "A String", # Output only. Timestamp of the last update check. "lastUpdateTime": "A String", # Output only. Timestamp of the last successful update. @@ -302,7 +315,7 @@

Method Details

}, ], "peripheralsReport": [ # Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time. - { # Peripherals report. + { # Peripherals report. * Granular permission needed: TELEMETRY_API_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. @@ -321,7 +334,7 @@

Method Details

}, ], "serialNumber": "A String", # Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab. - "storageInfo": { # 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 # Output only. Information of storage specs for the device. + "storageInfo": { # 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 * Granular permission needed: TELEMETRY_API_STORAGE_INFO # Output only. Information of storage specs for the device. "availableDiskBytes": "A String", # The available space for user data storage in the device in bytes. "totalDiskBytes": "A String", # The total space for user data storage in the device in bytes. "volume": [ # Information for disk volumes @@ -333,7 +346,7 @@

Method Details

], }, "storageStatusReport": [ # Output only. Storage reports collected periodically. - { # 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 + { # 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 * Granular permission needed: TELEMETRY_API_STORAGE_REPORT "disk": [ # Output only. Reports on disk. { # Status of the single storage device. "bytesReadThisSession": "A String", # Output only. Number of bytes read since last boot. @@ -357,7 +370,7 @@

Method Details

}, ], "thunderboltInfo": [ # Output only. Information on Thunderbolt bus. - { # 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 + { # 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 * Granular permission needed: TELEMETRY_API_BUS_DEVICE_INFO "securityLevel": "A String", # Security level of the Thunderbolt bus. }, ], @@ -384,9 +397,9 @@

Method Details

{ "devices": [ # Telemetry devices returned in the response. - { # Telemetry data collected from a managed device. + { # Telemetry data collected from a managed device. * Granular permission needed: TELEMETRY_API_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 + { # 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 * Granular permission needed: TELEMETRY_API_AUDIO_REPORT "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. @@ -397,7 +410,7 @@

Method Details

}, ], "batteryInfo": [ # Output only. Information on battery specs for the device. - { # Information about the battery. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 + { # Information about the battery. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 * Granular permission needed: TELEMETRY_API_BATTERY_INFO "designCapacity": "A String", # Output only. Design capacity (mAmpere-hours). "designMinVoltage": 42, # Output only. Designed minimum output voltage (mV) "manufactureDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the battery was manufactured. @@ -411,7 +424,7 @@

Method Details

}, ], "batteryStatusReport": [ # Output only. Battery reports collected periodically. - { # Status data for battery. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 + { # Status data for battery. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 * Granular permission needed: TELEMETRY_API_BATTERY_REPORT "batteryHealth": "A String", # Output only. Battery health. "cycleCount": 42, # Output only. Cycle count. "fullChargeCapacity": "A String", # Output only. Full charge capacity (mAmpere-hours). @@ -432,7 +445,7 @@

Method Details

}, ], "bootPerformanceReport": [ # Output only. Boot performance reports of the device. - { # Boot performance report of a device. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceBootMode](https://chromeenterprise.google/policies/#ReportDeviceBootMode) * Data Collection Frequency: On every boot up event * 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: Yes * Reported for affiliated users only: N/A + { # Boot performance report of a device. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceBootMode](https://chromeenterprise.google/policies/#ReportDeviceBootMode) * Data Collection Frequency: On every boot up event * 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: Yes * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_OS_REPORT "bootUpDuration": "A String", # Total time to boot up. "bootUpTime": "A String", # The timestamp when power came on. "reportTime": "A String", # Timestamp when the report was collected. @@ -442,7 +455,7 @@

Method Details

}, ], "cpuInfo": [ # Output only. Information regarding CPU specs for the device. - { # CPU specifications for the device * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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 + { # CPU specifications for the device * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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 * Granular permission needed: TELEMETRY_API_CPU_INFO "architecture": "A String", # Output only. Architecture type for the CPU. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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 "keylockerConfigured": True or False, # Output only. Whether keylocker is configured.`TRUE` = Enabled; `FALSE` = disabled. Only reported if keylockerSupported = `TRUE`. "keylockerSupported": True or False, # Output only. Whether keylocker is supported. @@ -451,7 +464,7 @@

Method Details

}, ], "cpuStatusReport": [ # Output only. CPU status reports collected periodically sorted in a decreasing order of report_time. - { # Provides information about the status of the CPU. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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 + { # Provides information about the status of the CPU. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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 * Granular permission needed: TELEMETRY_API_CPU_REPORT "cpuTemperatureInfo": [ # Output only. CPU temperature sample info per CPU core in Celsius { # CPU temperature of a device. Sampled per CPU core in Celsius. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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 "label": "A String", # Output only. CPU label. Example: Core 0 @@ -465,7 +478,7 @@

Method Details

], "customer": "A String", # Output only. Google Workspace Customer whose enterprise enrolled the device. "deviceId": "A String", # 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 - "graphicsInfo": { # Information of the graphics subsystem. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceGraphicsStatus](https://chromeenterprise.google/policies/#ReportDeviceGraphicsStatus) * 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 # Output only. Contains information regarding Graphic peripherals for the device. + "graphicsInfo": { # Information of the graphics subsystem. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceGraphicsStatus](https://chromeenterprise.google/policies/#ReportDeviceGraphicsStatus) * 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 * Granular permission needed: TELEMETRY_API_GRAPHICS_INFO # Output only. Contains information regarding Graphic peripherals for the device. "adapterInfo": { # Information of a graphics adapter (GPU). # Output only. Information about the graphics adapter (GPU). "adapter": "A String", # Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2). "deviceId": "A String", # Output only. Represents the graphics card device id. @@ -495,7 +508,7 @@

Method Details

}, }, "graphicsStatusReport": [ # Output only. Graphics reports collected periodically. - { # 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 + { # 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 * Granular permission needed: TELEMETRY_API_GRAPHICS_REPORT "displays": [ # Output only. Information about the displays for the device. { # Information for a display. "deviceId": "A String", # Output only. Represents the graphics card device id. @@ -509,7 +522,20 @@

Method Details

"reportTime": "A String", # Output only. Time at which the graphics data was reported. }, ], - "memoryInfo": { # 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 # Output only. Information regarding memory specs for the device. + "heartbeatStatusReport": [ # Output only. Heartbeat status report containing timestamps periodically sorted in decreasing order of report_time + { # Heartbeat status report of a device. * Available for Kiosks * This field provides online/offline/unknown status of a device and will only be included if the status has changed (e.g. Online -> Offline) * Data for this field is controlled via policy: [HeartbeatEnabled](https://chromeenterprise.google/policies/#HeartbeatEnabled) [More Info](https://support.google.com/chrome/a/answer/6179663#:~:text=On%20the%20Chrome,device%20status%20alerts) * Heartbeat Frequency: 2 mins * Note: If a device goes offline, it can take up to 12 minutes for the online status of the device to be updated * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: N/A * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_DEVICE_ACTIVITY_REPORT + "reportTime": "A String", # Timestamp of when status changed was detected + "state": "A String", # State the device changed to + }, + ], + "kioskAppStatusReport": [ # Output only. Kiosk app status report for the kiosk device + { # Kiosk app status report of a device. * Available for Kiosks * This field provides the app id and version number running on a kiosk device and the timestamp of when the report was last updated * Data for this field is controlled via policy: [ReportDeviceSessionStatus](https://chromeenterprise.google/policies/#ReportDeviceSessionStatus) * 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 * Granular permission needed: TELEMETRY_API_APPS_REPORT + "appId": "A String", # App id of kiosk app for example "mdmkkicfmmkgmpkmkdikhlbggogpicma" + "appVersion": "A String", # App version number of kiosk app for example "1.10.118" + "reportTime": "A String", # Timestamp of when report was collected + }, + ], + "memoryInfo": { # 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 * Granular permission needed: TELEMETRY_API_MEMORY_INFO # Output only. Information regarding memory specs for the device. "availableRamBytes": "A String", # Output only. Amount of available RAM in bytes. "totalMemoryEncryption": { # Memory encryption information of a device. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A # Output only. Total memory encryption info for the device. "encryptionAlgorithm": "A String", # Memory encryption algorithm. @@ -520,7 +546,7 @@

Method Details

"totalRamBytes": "A String", # Output only. Total RAM in bytes. }, "memoryStatusReport": [ # Output only. Memory status reports collected periodically sorted decreasing by report_time. - { # Contains samples of memory status reports. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: Only at upload, SystemRamFreeByes is collected every 10 minutes * Default Data Reporting Frequency: Every 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 + { # Contains samples of memory status reports. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: Only at upload, SystemRamFreeByes is collected every 10 minutes * Default Data Reporting Frequency: Every 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 * Granular permission needed: TELEMETRY_API_MEMORY_REPORT "pageFaults": 42, # Output only. Number of page faults during this collection "reportTime": "A String", # Output only. The timestamp in milliseconds representing time at which this report was sampled. "sampleFrequency": "A String", # Output only. Frequency the report is sampled. @@ -529,7 +555,7 @@

Method Details

], "name": "A String", # Output only. Resource name of the device. "networkDiagnosticsReport": [ # Output only. Network diagnostics collected periodically. - { # Network testing results to determine the health of the device's network connection, for example whether the HTTPS latency is high or normal. + { # Network testing results to determine the health of the device's network connection, for example whether the HTTPS latency is high or normal. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT "httpsLatencyData": { # Data that describes the result of the HTTPS latency diagnostics routine, with the HTTPS requests issued to Google websites. # Output only. HTTPS latency test data. "latency": "A String", # Output only. HTTPS latency if routine succeeded or failed because of HIGH_LATENCY or VERY_HIGH_LATENCY. "problem": "A String", # Output only. HTTPS latency routine problem if a problem occurred. @@ -537,7 +563,7 @@

Method Details

"reportTime": "A String", # Output only. Timestamp of when the diagnostics were collected. }, ], - "networkInfo": { # Network device information. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A # Output only. Network devices information. + "networkInfo": { # Network device information. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_NETWORK_INFO # Output only. Network devices information. "networkDevices": [ # Output only. List of network devices. { # Details about the network device. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A "iccid": "A String", # Output only. The integrated circuit card ID associated with the device's sim card. @@ -550,7 +576,7 @@

Method Details

], }, "networkStatusReport": [ # Output only. Network specs collected periodically. - { # State of visible/configured networks. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportNetworkStatus](https://chromeenterprise.google/policies/#ReportNetworkStatus) * Data Collection Frequency: 60 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: Yes * Reported for affiliated users only: Yes + { # State of visible/configured networks. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportNetworkStatus](https://chromeenterprise.google/policies/#ReportNetworkStatus) * Data Collection Frequency: 60 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: Yes * Reported for affiliated users only: Yes * Granular permission needed: TELEMETRY_API_NETWORK_REPORT "connectionState": "A String", # Output only. Current connection state of the network. "connectionType": "A String", # Output only. Network connection type. "encryptionOn": True or False, # Output only. Whether the wifi encryption key is turned off. @@ -569,7 +595,7 @@

Method Details

], "orgUnitId": "A String", # Output only. Organization unit ID of the device. "osUpdateStatus": [ # Output only. Contains relevant information regarding ChromeOS update status. - { # Contains information regarding the current OS update status. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceOsUpdateStatus](https://chromeenterprise.google/policies/#ReportDeviceOsUpdateStatus) * 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 + { # Contains information regarding the current OS update status. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceOsUpdateStatus](https://chromeenterprise.google/policies/#ReportDeviceOsUpdateStatus) * 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 * Granular permission needed: TELEMETRY_API_OS_REPORT "lastRebootTime": "A String", # Output only. Timestamp of the last reboot. "lastUpdateCheckTime": "A String", # Output only. Timestamp of the last update check. "lastUpdateTime": "A String", # Output only. Timestamp of the last successful update. @@ -579,7 +605,7 @@

Method Details

}, ], "peripheralsReport": [ # Output only. Peripherals reports collected periodically sorted in a decreasing order of report_time. - { # Peripherals report. + { # Peripherals report. * Granular permission needed: TELEMETRY_API_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. @@ -598,7 +624,7 @@

Method Details

}, ], "serialNumber": "A String", # Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab. - "storageInfo": { # 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 # Output only. Information of storage specs for the device. + "storageInfo": { # 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 * Granular permission needed: TELEMETRY_API_STORAGE_INFO # Output only. Information of storage specs for the device. "availableDiskBytes": "A String", # The available space for user data storage in the device in bytes. "totalDiskBytes": "A String", # The total space for user data storage in the device in bytes. "volume": [ # Information for disk volumes @@ -610,7 +636,7 @@

Method Details

], }, "storageStatusReport": [ # Output only. Storage reports collected periodically. - { # 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 + { # 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 * Granular permission needed: TELEMETRY_API_STORAGE_REPORT "disk": [ # Output only. Reports on disk. { # Status of the single storage device. "bytesReadThisSession": "A String", # Output only. Number of bytes read since last boot. @@ -634,7 +660,7 @@

Method Details

}, ], "thunderboltInfo": [ # Output only. Information on Thunderbolt bus. - { # 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 + { # 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 * Granular permission needed: TELEMETRY_API_BUS_DEVICE_INFO "securityLevel": "A String", # Security level of the Thunderbolt bus. }, ], diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html index e72cdeb4657..20771a3c8a6 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html @@ -111,14 +111,14 @@

Method Details

"nextPageToken": "A String", # Token to specify next page in the list. "telemetryEvents": [ # Telemetry events returned in the response. { # Telemetry data reported by a managed device. - "audioSevereUnderrunEvent": { # `TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds. # Output only. Payload for audio severe underrun event. Present only when the `event_type` field is `AUDIO_SEVERE_UNDERRUN`. + "audioSevereUnderrunEvent": { # `TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds. * Granular permission needed: TELEMETRY_API_AUDIO_REPORT # Output only. Payload for audio severe underrun event. Present only when the `event_type` field is `AUDIO_SEVERE_UNDERRUN`. }, - "device": { # Information about a device associated with telemetry data. # Output only. Information about the device associated with the event. + "device": { # Information about a device associated with telemetry data. * Granular Permission needed: TELEMETRY_API_DEVICE # Output only. Information about the device associated with the event. "deviceId": "A String", # 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. "orgUnitId": "A String", # Output only. Organization unit ID of the device. }, "eventType": "A String", # The event type of the current event. - "httpsLatencyChangeEvent": { # 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.. # Output only. Payload for HTTPS latency change event. Present only when `event_type` is `NETWORK_HTTPS_LATENCY_CHANGE`. + "httpsLatencyChangeEvent": { # 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. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT # Output only. Payload for HTTPS latency change event. Present only when `event_type` is `NETWORK_HTTPS_LATENCY_CHANGE`. "httpsLatencyRoutineData": { # Data that describes the result of the HTTPS latency diagnostics routine, with the HTTPS requests issued to Google websites. # HTTPS latency routine data that triggered the event. "latency": "A String", # Output only. HTTPS latency if routine succeeded or failed because of HIGH_LATENCY or VERY_HIGH_LATENCY. "problem": "A String", # Output only. HTTPS latency routine problem if a problem occurred. @@ -127,7 +127,7 @@

Method Details

}, "name": "A String", # Output only. Resource name of the event. "reportTime": "A String", # Timestamp that represents when the event was reported. - "usbPeripheralsEvent": { # `TelemetryUsbPeripheralsEvent` is triggered USB devices are either added or removed. # Output only. Payload for usb peripherals event. Present only when the `event_type` field is either `USB_ADDED` or `USB_REMOVED`. + "usbPeripheralsEvent": { # `TelemetryUsbPeripheralsEvent` is triggered USB devices are either added or removed. * Granular permission needed: TELEMETRY_API_PERIPHERALS_REPORT # Output only. Payload for usb peripherals event. Present only when the `event_type` field is either `USB_ADDED` or `USB_REMOVED`. "usbPeripheralReport": [ # List of usb devices that were either added or removed. { # USB connected peripheral report. "categories": [ # Output only. Categories the device belongs to https://www.usb.org/defined-class-codes @@ -143,7 +143,7 @@

Method Details

}, ], }, - "user": { # Information about a user associated with telemetry data. # Output only. Information about the user associated with the event. + "user": { # Information about a user associated with telemetry data. * Granular permission needed: TELEMETRY_API_USER # Output only. Information about the user associated with the event. "email": "A String", # Output only. User's email. "orgUnitId": "A String", # Output only. Organization unit ID of the user. }, diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.users.html b/docs/dyn/chromemanagement_v1.customers.telemetry.users.html index 0071c8e01a2..f264502de90 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.users.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.users.html @@ -107,14 +107,14 @@

Method Details

Returns: An object of the form: - { # Telemetry data collected from a managed user. + { # Telemetry data collected from a managed user. * Granular permission needed: TELEMETRY_API_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. + { # Telemetry data collected for a managed user and device. * Granular permission needed: TELEMETRY_API_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 + { # 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 * Granular permission needed: TELEMETRY_API_AUDIO_REPORT "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. @@ -126,7 +126,7 @@

Method Details

], "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. + { # Peripherals report. * Granular permission needed: TELEMETRY_API_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. @@ -172,14 +172,14 @@

Method Details

{ # 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. + { # Telemetry data collected from a managed user. * Granular permission needed: TELEMETRY_API_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. + { # Telemetry data collected for a managed user and device. * Granular permission needed: TELEMETRY_API_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 + { # 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 * Granular permission needed: TELEMETRY_API_AUDIO_REPORT "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. @@ -191,7 +191,7 @@

Method Details

], "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. + { # Peripherals report. * Granular permission needed: TELEMETRY_API_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. diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 5195079a349..79f6bd05e7c 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -794,7 +794,7 @@ } } }, - "revision": "20230416", + "revision": "20230522", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -943,7 +943,7 @@ "type": "object" }, "GoogleChromeManagementV1AudioStatusReport": { - "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: [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", + "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: [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 * Granular permission needed: TELEMETRY_API_AUDIO_REPORT", "id": "GoogleChromeManagementV1AudioStatusReport", "properties": { "inputDevice": { @@ -988,7 +988,7 @@ "type": "object" }, "GoogleChromeManagementV1BatteryInfo": { - "description": "Information about the battery. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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", + "description": "Information about the battery. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 * Granular permission needed: TELEMETRY_API_BATTERY_INFO", "id": "GoogleChromeManagementV1BatteryInfo", "properties": { "designCapacity": { @@ -1081,7 +1081,7 @@ "type": "object" }, "GoogleChromeManagementV1BatteryStatusReport": { - "description": "Status data for battery. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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", + "description": "Status data for battery. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDevicePowerStatus](https://chromeenterprise.google/policies/#ReportDevicePowerStatus) * 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 * Granular permission needed: TELEMETRY_API_BATTERY_REPORT", "id": "GoogleChromeManagementV1BatteryStatusReport", "properties": { "batteryHealth": { @@ -1136,7 +1136,7 @@ "type": "object" }, "GoogleChromeManagementV1BootPerformanceReport": { - "description": "Boot performance report of a device. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceBootMode](https://chromeenterprise.google/policies/#ReportDeviceBootMode) * Data Collection Frequency: On every boot up event * 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: Yes * Reported for affiliated users only: N/A", + "description": "Boot performance report of a device. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceBootMode](https://chromeenterprise.google/policies/#ReportDeviceBootMode) * Data Collection Frequency: On every boot up event * 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: Yes * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_OS_REPORT", "id": "GoogleChromeManagementV1BootPerformanceReport", "properties": { "bootUpDuration": { @@ -1582,7 +1582,7 @@ "type": "object" }, "GoogleChromeManagementV1CpuInfo": { - "description": "CPU specifications for the device * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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", + "description": "CPU specifications for the device * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * 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 * Granular permission needed: TELEMETRY_API_CPU_INFO", "id": "GoogleChromeManagementV1CpuInfo", "properties": { "architecture": { @@ -1623,7 +1623,7 @@ "type": "object" }, "GoogleChromeManagementV1CpuStatusReport": { - "description": "Provides information about the status of the CPU. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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", + "description": "Provides information about the status of the CPU. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceCpuInfo](https://chromeenterprise.google/policies/#ReportDeviceCpuInfo) * Data Collection Frequency: Every 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 * Granular permission needed: TELEMETRY_API_CPU_REPORT", "id": "GoogleChromeManagementV1CpuStatusReport", "properties": { "cpuTemperatureInfo": { @@ -1981,7 +1981,7 @@ "type": "object" }, "GoogleChromeManagementV1GraphicsInfo": { - "description": "Information of the graphics subsystem. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceGraphicsStatus](https://chromeenterprise.google/policies/#ReportDeviceGraphicsStatus) * 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", + "description": "Information of the graphics subsystem. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportDeviceGraphicsStatus](https://chromeenterprise.google/policies/#ReportDeviceGraphicsStatus) * 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 * Granular permission needed: TELEMETRY_API_GRAPHICS_INFO", "id": "GoogleChromeManagementV1GraphicsInfo", "properties": { "adapterInfo": { @@ -2011,7 +2011,7 @@ "type": "object" }, "GoogleChromeManagementV1GraphicsStatusReport": { - "description": "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", + "description": "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 * Granular permission needed: TELEMETRY_API_GRAPHICS_REPORT", "id": "GoogleChromeManagementV1GraphicsStatusReport", "properties": { "displays": { @@ -2031,6 +2031,34 @@ }, "type": "object" }, + "GoogleChromeManagementV1HeartbeatStatusReport": { + "description": "Heartbeat status report of a device. * Available for Kiosks * This field provides online/offline/unknown status of a device and will only be included if the status has changed (e.g. Online -> Offline) * Data for this field is controlled via policy: [HeartbeatEnabled](https://chromeenterprise.google/policies/#HeartbeatEnabled) [More Info](https://support.google.com/chrome/a/answer/6179663#:~:text=On%20the%20Chrome,device%20status%20alerts) * Heartbeat Frequency: 2 mins * Note: If a device goes offline, it can take up to 12 minutes for the online status of the device to be updated * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: N/A * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_DEVICE_ACTIVITY_REPORT", + "id": "GoogleChromeManagementV1HeartbeatStatusReport", + "properties": { + "reportTime": { + "description": "Timestamp of when status changed was detected", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "State the device changed to", + "enum": [ + "STATE_UNSPECIFIED", + "UNKNOWN", + "ONLINE", + "OFFLINE" + ], + "enumDescriptions": [ + "State not specified", + "Device is not eligible for heartbeat monitoring", + "Device is online", + "Device is offline" + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleChromeManagementV1HttpsLatencyRoutineData": { "description": "Data that describes the result of the HTTPS latency diagnostics routine, with the HTTPS requests issued to Google websites.", "id": "GoogleChromeManagementV1HttpsLatencyRoutineData", @@ -2174,6 +2202,26 @@ }, "type": "object" }, + "GoogleChromeManagementV1KioskAppStatusReport": { + "description": "Kiosk app status report of a device. * Available for Kiosks * This field provides the app id and version number running on a kiosk device and the timestamp of when the report was last updated * Data for this field is controlled via policy: [ReportDeviceSessionStatus](https://chromeenterprise.google/policies/#ReportDeviceSessionStatus) * 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 * Granular permission needed: TELEMETRY_API_APPS_REPORT", + "id": "GoogleChromeManagementV1KioskAppStatusReport", + "properties": { + "appId": { + "description": "App id of kiosk app for example \"mdmkkicfmmkgmpkmkdikhlbggogpicma\"", + "type": "string" + }, + "appVersion": { + "description": "App version number of kiosk app for example \"1.10.118\"", + "type": "string" + }, + "reportTime": { + "description": "Timestamp of when report was collected", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleChromeManagementV1ListTelemetryDevicesResponse": { "id": "GoogleChromeManagementV1ListTelemetryDevicesResponse", "properties": { @@ -2228,7 +2276,7 @@ "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", + "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 * Granular permission needed: TELEMETRY_API_MEMORY_INFO", "id": "GoogleChromeManagementV1MemoryInfo", "properties": { "availableRamBytes": { @@ -2252,7 +2300,7 @@ "type": "object" }, "GoogleChromeManagementV1MemoryStatusReport": { - "description": "Contains samples of memory status reports. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: Only at upload, SystemRamFreeByes is collected every 10 minutes * Default Data Reporting Frequency: Every 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", + "description": "Contains samples of memory status reports. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceMemoryInfo](https://chromeenterprise.google/policies/#ReportDeviceMemoryInfo) * Data Collection Frequency: Only at upload, SystemRamFreeByes is collected every 10 minutes * Default Data Reporting Frequency: Every 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 * Granular permission needed: TELEMETRY_API_MEMORY_REPORT", "id": "GoogleChromeManagementV1MemoryStatusReport", "properties": { "pageFaults": { @@ -2332,7 +2380,7 @@ "type": "object" }, "GoogleChromeManagementV1NetworkDiagnosticsReport": { - "description": "Network testing results to determine the health of the device's network connection, for example whether the HTTPS latency is high or normal.", + "description": "Network testing results to determine the health of the device's network connection, for example whether the HTTPS latency is high or normal. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT", "id": "GoogleChromeManagementV1NetworkDiagnosticsReport", "properties": { "httpsLatencyData": { @@ -2350,7 +2398,7 @@ "type": "object" }, "GoogleChromeManagementV1NetworkInfo": { - "description": "Network device information. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A", + "description": "Network device information. * This field provides device information, which is static and will not change over time. * Data for this field is controlled via policy: [ReportNetworkDeviceConfiguration](https://chromeenterprise.google/policies/#ReportNetworkDeviceConfiguration) * Data Collection Frequency: At device startup * Default Data Reporting Frequency: 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: Yes * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_NETWORK_INFO", "id": "GoogleChromeManagementV1NetworkInfo", "properties": { "networkDevices": { @@ -2365,7 +2413,7 @@ "type": "object" }, "GoogleChromeManagementV1NetworkStatusReport": { - "description": "State of visible/configured networks. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportNetworkStatus](https://chromeenterprise.google/policies/#ReportNetworkStatus) * Data Collection Frequency: 60 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: Yes * Reported for affiliated users only: Yes", + "description": "State of visible/configured networks. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportNetworkStatus](https://chromeenterprise.google/policies/#ReportNetworkStatus) * Data Collection Frequency: 60 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: Yes * Reported for affiliated users only: Yes * Granular permission needed: TELEMETRY_API_NETWORK_REPORT", "id": "GoogleChromeManagementV1NetworkStatusReport", "properties": { "connectionState": { @@ -2481,7 +2529,7 @@ "type": "object" }, "GoogleChromeManagementV1OsUpdateStatus": { - "description": "Contains information regarding the current OS update status. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceOsUpdateStatus](https://chromeenterprise.google/policies/#ReportDeviceOsUpdateStatus) * 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", + "description": "Contains information regarding the current OS update status. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceOsUpdateStatus](https://chromeenterprise.google/policies/#ReportDeviceOsUpdateStatus) * 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 * Granular permission needed: TELEMETRY_API_OS_REPORT", "id": "GoogleChromeManagementV1OsUpdateStatus", "properties": { "lastRebootTime": { @@ -2533,7 +2581,7 @@ "type": "object" }, "GoogleChromeManagementV1PeripheralsReport": { - "description": "Peripherals report.", + "description": "Peripherals report. * Granular permission needed: TELEMETRY_API_PERIPHERALS_REPORT", "id": "GoogleChromeManagementV1PeripheralsReport", "properties": { "reportTime": { @@ -2553,7 +2601,7 @@ "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", + "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 * Granular permission needed: TELEMETRY_API_STORAGE_INFO", "id": "GoogleChromeManagementV1StorageInfo", "properties": { "availableDiskBytes": { @@ -2598,7 +2646,7 @@ "type": "object" }, "GoogleChromeManagementV1StorageStatusReport": { - "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", + "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 * Granular permission needed: TELEMETRY_API_STORAGE_REPORT", "id": "GoogleChromeManagementV1StorageStatusReport", "properties": { "disk": { @@ -2619,13 +2667,13 @@ "type": "object" }, "GoogleChromeManagementV1TelemetryAudioSevereUnderrunEvent": { - "description": "`TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds.", + "description": "`TelemetryAudioSevereUnderrunEvent` is triggered when a audio devices run out of buffer data for more than 5 seconds. * Granular permission needed: TELEMETRY_API_AUDIO_REPORT", "id": "GoogleChromeManagementV1TelemetryAudioSevereUnderrunEvent", "properties": {}, "type": "object" }, "GoogleChromeManagementV1TelemetryDevice": { - "description": "Telemetry data collected from a managed device.", + "description": "Telemetry data collected from a managed device. * Granular permission needed: TELEMETRY_API_DEVICE", "id": "GoogleChromeManagementV1TelemetryDevice", "properties": { "audioStatusReport": { @@ -2699,6 +2747,22 @@ "readOnly": true, "type": "array" }, + "heartbeatStatusReport": { + "description": "Output only. Heartbeat status report containing timestamps periodically sorted in decreasing order of report_time", + "items": { + "$ref": "GoogleChromeManagementV1HeartbeatStatusReport" + }, + "readOnly": true, + "type": "array" + }, + "kioskAppStatusReport": { + "description": "Output only. Kiosk app status report for the kiosk device", + "items": { + "$ref": "GoogleChromeManagementV1KioskAppStatusReport" + }, + "readOnly": true, + "type": "array" + }, "memoryInfo": { "$ref": "GoogleChromeManagementV1MemoryInfo", "description": "Output only. Information regarding memory specs for the device.", @@ -2789,7 +2853,7 @@ "type": "object" }, "GoogleChromeManagementV1TelemetryDeviceInfo": { - "description": "Information about a device associated with telemetry data.", + "description": "Information about a device associated with telemetry data. * Granular Permission needed: TELEMETRY_API_DEVICE", "id": "GoogleChromeManagementV1TelemetryDeviceInfo", "properties": { "deviceId": { @@ -2866,7 +2930,7 @@ "type": "object" }, "GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent": { - "description": "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..", + "description": "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. * Granular permission needed: TELEMETRY_API_NETWORK_REPORT", "id": "GoogleChromeManagementV1TelemetryHttpsLatencyChangeEvent", "properties": { "httpsLatencyRoutineData": { @@ -2891,7 +2955,7 @@ "type": "object" }, "GoogleChromeManagementV1TelemetryUsbPeripheralsEvent": { - "description": "`TelemetryUsbPeripheralsEvent` is triggered USB devices are either added or removed.", + "description": "`TelemetryUsbPeripheralsEvent` is triggered USB devices are either added or removed. * Granular permission needed: TELEMETRY_API_PERIPHERALS_REPORT", "id": "GoogleChromeManagementV1TelemetryUsbPeripheralsEvent", "properties": { "usbPeripheralReport": { @@ -2905,7 +2969,7 @@ "type": "object" }, "GoogleChromeManagementV1TelemetryUser": { - "description": "Telemetry data collected from a managed user.", + "description": "Telemetry data collected from a managed user. * Granular permission needed: TELEMETRY_API_USER", "id": "GoogleChromeManagementV1TelemetryUser", "properties": { "customer": { @@ -2939,7 +3003,7 @@ "type": "object" }, "GoogleChromeManagementV1TelemetryUserDevice": { - "description": "Telemetry data collected for a managed user and device.", + "description": "Telemetry data collected for a managed user and device. * Granular permission needed: TELEMETRY_API_DEVICE", "id": "GoogleChromeManagementV1TelemetryUserDevice", "properties": { "audioStatusReport": { @@ -2966,7 +3030,7 @@ "type": "object" }, "GoogleChromeManagementV1TelemetryUserInfo": { - "description": "Information about a user associated with telemetry data.", + "description": "Information about a user associated with telemetry data. * Granular permission needed: TELEMETRY_API_USER", "id": "GoogleChromeManagementV1TelemetryUserInfo", "properties": { "email": { @@ -2983,7 +3047,7 @@ "type": "object" }, "GoogleChromeManagementV1ThunderboltInfo": { - "description": "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", + "description": "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 * Granular permission needed: TELEMETRY_API_BUS_DEVICE_INFO", "id": "GoogleChromeManagementV1ThunderboltInfo", "properties": { "securityLevel": {