googleapis
Version:
Google APIs Client Library for Node.js
1,145 lines • 111 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace chromemanagement_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Chrome Management API
*
* The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser devices.
*
* @example
* ```js
* const {google} = require('googleapis');
* const chromemanagement = google.chromemanagement('v1');
* ```
*/
export class Chromemanagement {
context: APIRequestContext;
customers: Resource$Customers;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Android app information.
*/
export interface Schema$GoogleChromeManagementV1AndroidAppInfo {
/**
* Output only. Permissions requested by an Android app.
*/
permissions?: Schema$GoogleChromeManagementV1AndroidAppPermission[];
}
/**
* Permission requested by an Android app.
*/
export interface Schema$GoogleChromeManagementV1AndroidAppPermission {
/**
* Output only. The type of the permission.
*/
type?: string | null;
}
/**
* Resource representing app details.
*/
export interface Schema$GoogleChromeManagementV1AppDetails {
/**
* Output only. Android app information.
*/
androidAppInfo?: Schema$GoogleChromeManagementV1AndroidAppInfo;
/**
* Output only. Unique store identifier for the item. Examples: "gmbmikajjgmnabiglmofipeabaddhgne" for the Save to Google Drive Chrome extension, "com.google.android.apps.docs" for the Google Drive Android app.
*/
appId?: string | null;
/**
* Output only. Chrome Web Store app information.
*/
chromeAppInfo?: Schema$GoogleChromeManagementV1ChromeAppInfo;
/**
* Output only. App's description.
*/
description?: string | null;
/**
* Output only. The uri for the detail page of the item.
*/
detailUri?: string | null;
/**
* Output only. App's display name.
*/
displayName?: string | null;
/**
* Output only. First published time.
*/
firstPublishTime?: string | null;
/**
* Output only. Home page or Website uri.
*/
homepageUri?: string | null;
/**
* Output only. A link to an image that can be used as an icon for the product.
*/
iconUri?: string | null;
/**
* Output only. Indicates if the app has to be paid for OR has paid content.
*/
isPaidApp?: boolean | null;
/**
* Output only. Latest published time.
*/
latestPublishTime?: string | null;
/**
* Output only. Format: name=customers/{customer_id\}/apps/{chrome|android|web\}/{app_id\}@{version\}
*/
name?: string | null;
/**
* Output only. The URI pointing to the privacy policy of the app, if it was provided by the developer. Version-specific field that will only be set when the requested app version is found.
*/
privacyPolicyUri?: string | null;
/**
* Output only. The publisher of the item.
*/
publisher?: string | null;
/**
* Output only. Number of reviews received. Chrome Web Store review information will always be for the latest version of an app.
*/
reviewNumber?: string | null;
/**
* Output only. The rating of the app (on 5 stars). Chrome Web Store review information will always be for the latest version of an app.
*/
reviewRating?: number | null;
/**
* Output only. App version. A new revision is committed whenever a new version of the app is published.
*/
revisionId?: string | null;
/**
* Output only. Information about a partial service error if applicable.
*/
serviceError?: Schema$GoogleRpcStatus;
/**
* Output only. App type.
*/
type?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1AudioStatusReport {
/**
* Output only. Active input device's name.
*/
inputDevice?: string | null;
/**
* Output only. Active input device's gain in [0, 100].
*/
inputGain?: number | null;
/**
* Output only. Is active input device mute or not.
*/
inputMute?: boolean | null;
/**
* Output only. Active output device's name.
*/
outputDevice?: string | null;
/**
* Output only. Is active output device mute or not.
*/
outputMute?: boolean | null;
/**
* Output only. Active output device's volume in [0, 100].
*/
outputVolume?: number | null;
/**
* Output only. Timestamp of when the sample was collected on device.
*/
reportTime?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1BatteryInfo {
/**
* Output only. Design capacity (mAmpere-hours).
*/
designCapacity?: string | null;
/**
* Output only. Designed minimum output voltage (mV)
*/
designMinVoltage?: number | null;
/**
* Output only. The date the battery was manufactured.
*/
manufactureDate?: Schema$GoogleTypeDate;
/**
* Output only. Battery manufacturer.
*/
manufacturer?: string | null;
/**
* Output only. Battery serial number.
*/
serialNumber?: string | null;
/**
* Output only. Technology of the battery. Example: Li-ion
*/
technology?: string | null;
}
/**
* Sampling 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
*/
export interface Schema$GoogleChromeManagementV1BatterySampleReport {
/**
* Output only. Battery charge percentage.
*/
chargeRate?: number | null;
/**
* Output only. Battery current (mA).
*/
current?: string | null;
/**
* Output only. The battery discharge rate measured in mW. Positive if the battery is being discharged, negative if it's being charged.
*/
dischargeRate?: number | null;
/**
* Output only. Battery remaining capacity (mAmpere-hours).
*/
remainingCapacity?: string | null;
/**
* Output only. Timestamp of when the sample was collected on device
*/
reportTime?: string | null;
/**
* Output only. Battery status read from sysfs. Example: Discharging
*/
status?: string | null;
/**
* Output only. Temperature in Celsius degrees.
*/
temperature?: number | null;
/**
* Output only. Battery voltage (millivolt).
*/
voltage?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1BatteryStatusReport {
/**
* Output only. Battery health.
*/
batteryHealth?: string | null;
/**
* Output only. Cycle count.
*/
cycleCount?: number | null;
/**
* Output only. Full charge capacity (mAmpere-hours).
*/
fullChargeCapacity?: string | null;
/**
* Output only. Timestamp of when the sample was collected on device
*/
reportTime?: string | null;
/**
* Output only. Sampling data for the battery sorted in a decreasing order of report_time.
*/
sample?: Schema$GoogleChromeManagementV1BatterySampleReport[];
/**
* Output only. Battery serial number.
*/
serialNumber?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1BootPerformanceReport {
/**
* Total time to boot up.
*/
bootUpDuration?: string | null;
/**
* The timestamp when power came on.
*/
bootUpTime?: string | null;
/**
* Timestamp when the report was collected.
*/
reportTime?: string | null;
/**
* Total time since shutdown start to power off.
*/
shutdownDuration?: string | null;
/**
* The shutdown reason.
*/
shutdownReason?: string | null;
/**
* The timestamp when shutdown.
*/
shutdownTime?: string | null;
}
/**
* Describes a browser version and its install count.
*/
export interface Schema$GoogleChromeManagementV1BrowserVersion {
/**
* Output only. The release channel of the installed browser.
*/
channel?: string | null;
/**
* Output only. Count grouped by device_system and major version
*/
count?: string | null;
/**
* Output only. Version of the system-specified operating system.
*/
deviceOsVersion?: string | null;
/**
* Output only. The device operating system.
*/
system?: string | null;
/**
* Output only. The full version of the installed browser.
*/
version?: string | null;
}
/**
* Chrome Web Store app information.
*/
export interface Schema$GoogleChromeManagementV1ChromeAppInfo {
/**
* Output only. Whether the app or extension is built and maintained by Google. Version-specific field that will only be set when the requested app version is found.
*/
googleOwned?: boolean | null;
/**
* Output only. Whether the app or extension is in a published state in the Chrome Web Store.
*/
isCwsHosted?: boolean | null;
/**
* Output only. Whether an app supports policy for extensions.
*/
isExtensionPolicySupported?: boolean | null;
/**
* Output only. Whether the app is only for Kiosk mode on ChromeOS devices
*/
isKioskOnly?: boolean | null;
/**
* Output only. Whether the app or extension is a theme.
*/
isTheme?: boolean | null;
/**
* Output only. Whether this app is enabled for Kiosk mode on ChromeOS devices
*/
kioskEnabled?: boolean | null;
/**
* Output only. The minimum number of users using this app.
*/
minUserCount?: number | null;
/**
* Output only. Every custom permission requested by the app. Version-specific field that will only be set when the requested app version is found.
*/
permissions?: Schema$GoogleChromeManagementV1ChromeAppPermission[];
/**
* Output only. Every permission giving access to domains or broad host patterns. ( e.g. www.google.com). This includes the matches from content scripts as well as hosts in the permissions node of the manifest. Version-specific field that will only be set when the requested app version is found.
*/
siteAccess?: Schema$GoogleChromeManagementV1ChromeAppSiteAccess[];
/**
* Output only. The app developer has enabled support for their app. Version-specific field that will only be set when the requested app version is found.
*/
supportEnabled?: boolean | null;
/**
* Output only. Types of an item in the Chrome Web Store
*/
type?: string | null;
}
/**
* Permission requested by a Chrome app or extension.
*/
export interface Schema$GoogleChromeManagementV1ChromeAppPermission {
/**
* Output only. If available, whether this permissions grants the app/extension access to user data.
*/
accessUserData?: boolean | null;
/**
* Output only. If available, a URI to a page that has documentation for the current permission.
*/
documentationUri?: string | null;
/**
* Output only. The type of the permission.
*/
type?: string | null;
}
/**
* Details of an app installation request.
*/
export interface Schema$GoogleChromeManagementV1ChromeAppRequest {
/**
* Output only. Format: app_details=customers/{customer_id\}/apps/chrome/{app_id\}
*/
appDetails?: string | null;
/**
* Output only. Unique store identifier for the app. Example: "gmbmikajjgmnabiglmofipeabaddhgne" for the Save to Google Drive Chrome extension.
*/
appId?: string | null;
/**
* Output only. The uri for the detail page of the item.
*/
detailUri?: string | null;
/**
* Output only. App's display name.
*/
displayName?: string | null;
/**
* Output only. A link to an image that can be used as an icon for the product.
*/
iconUri?: string | null;
/**
* Output only. The timestamp of the most recently made request for this app.
*/
latestRequestTime?: string | null;
/**
* Output only. Total count of requests for this app.
*/
requestCount?: string | null;
}
/**
* Represent one host permission.
*/
export interface Schema$GoogleChromeManagementV1ChromeAppSiteAccess {
/**
* Output only. This can contain very specific hosts, or patterns like "*.com" for instance.
*/
hostMatch?: string | null;
}
/**
* Response containing summary of requested app installations.
*/
export interface Schema$GoogleChromeManagementV1CountChromeAppRequestsResponse {
/**
* Token to specify the next page in the list.
*/
nextPageToken?: string | null;
/**
* Count of requested apps matching request.
*/
requestedApps?: Schema$GoogleChromeManagementV1ChromeAppRequest[];
/**
* Total number of matching app requests.
*/
totalSize?: number | null;
}
/**
* Response containing counts for browsers that need attention.
*/
export interface Schema$GoogleChromeManagementV1CountChromeBrowsersNeedingAttentionResponse {
/**
* Number of browsers that haven’t had any recent activity
*/
noRecentActivityCount?: string | null;
/**
* Number of browsers that are pending an OS update
*/
pendingBrowserUpdateCount?: string | null;
/**
* Number of browsers that have been recently enrolled
*/
recentlyEnrolledCount?: string | null;
}
/**
* Response containing a list of devices expiring in each month of a selected time frame. Counts are grouped by model and Auto Update Expiration date.
*/
export interface Schema$GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse {
/**
* The list of reports sorted by auto update expiration date in ascending order.
*/
deviceAueCountReports?: Schema$GoogleChromeManagementV1DeviceAueCountReport[];
}
/**
* Response containing counts for devices that need attention.
*/
export interface Schema$GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse {
/**
* Number of ChromeOS devices have not synced policies in the past 28 days.
*/
noRecentPolicySyncCount?: string | null;
/**
* Number of ChromeOS devices that have not seen any user activity in the past 28 days.
*/
noRecentUserActivityCount?: string | null;
/**
* Number of devices whose OS version is not compliant.
*/
osVersionNotCompliantCount?: string | null;
/**
* Number of devices that are pending an OS update.
*/
pendingUpdate?: string | null;
/**
* Number of devices that are unable to apply a policy due to an OS version mismatch.
*/
unsupportedPolicyCount?: string | null;
}
/**
* Response containing a list of devices with a specific type of hardware specification from the requested hardware type.
*/
export interface Schema$GoogleChromeManagementV1CountChromeHardwareFleetDevicesResponse {
/**
* The DeviceHardwareCountReport for device cpu type (for example Intel(R) Core(TM) i7-10610U CPU @ 1.80GHz).
*/
cpuReports?: Schema$GoogleChromeManagementV1DeviceHardwareCountReport[];
/**
* The DeviceHardwareCountReport for device memory amount in gigabytes (for example 16).
*/
memoryReports?: Schema$GoogleChromeManagementV1DeviceHardwareCountReport[];
/**
* The DeviceHardwareCountReport for device model type (for example Acer C7 Chromebook).
*/
modelReports?: Schema$GoogleChromeManagementV1DeviceHardwareCountReport[];
/**
* The DeviceHardwareCountReport for device storage amount in gigabytes (for example 128).
*/
storageReports?: Schema$GoogleChromeManagementV1DeviceHardwareCountReport[];
}
/**
* Response containing requested browser versions details and counts.
*/
export interface Schema$GoogleChromeManagementV1CountChromeVersionsResponse {
/**
* List of all browser versions and their install counts.
*/
browserVersions?: Schema$GoogleChromeManagementV1BrowserVersion[];
/**
* Token to specify the next page of the request.
*/
nextPageToken?: string | null;
/**
* Total number browser versions matching request.
*/
totalSize?: number | null;
}
/**
* Response containing details of queried installed apps.
*/
export interface Schema$GoogleChromeManagementV1CountInstalledAppsResponse {
/**
* List of installed apps matching request.
*/
installedApps?: Schema$GoogleChromeManagementV1InstalledApp[];
/**
* Token to specify the next page of the request.
*/
nextPageToken?: string | null;
/**
* Total number of installed apps matching request.
*/
totalSize?: number | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1CpuInfo {
/**
* 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
*/
architecture?: string | null;
/**
* Output only. Whether keylocker is configured.`TRUE` = Enabled; `FALSE` = disabled. Only reported if keylockerSupported = `TRUE`.
*/
keylockerConfigured?: boolean | null;
/**
* Output only. Whether keylocker is supported.
*/
keylockerSupported?: boolean | null;
/**
* Output only. The max CPU clock speed in kHz.
*/
maxClockSpeed?: number | null;
/**
* Output only. The CPU model name. Example: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz
*/
model?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1CpuStatusReport {
/**
* Output only. CPU temperature sample info per CPU core in Celsius
*/
cpuTemperatureInfo?: Schema$GoogleChromeManagementV1CpuTemperatureInfo[];
/**
* Output only. Sample of CPU utilization (0-100 percent).
*/
cpuUtilizationPct?: number | null;
/**
* Output only. The timestamp in milliseconds representing time at which this report was sampled.
*/
reportTime?: string | null;
/**
* Output only. Frequency the report is sampled.
*/
sampleFrequency?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1CpuTemperatureInfo {
/**
* Output only. CPU label. Example: Core 0
*/
label?: string | null;
/**
* Output only. CPU temperature in Celsius.
*/
temperatureCelsius?: number | null;
}
/**
* Describes a device reporting Chrome browser information.
*/
export interface Schema$GoogleChromeManagementV1Device {
/**
* Output only. The ID of the device that reported this Chrome browser information.
*/
deviceId?: string | null;
/**
* Output only. The name of the machine within its local network.
*/
machine?: string | null;
}
/**
* Report for CountChromeDevicesPerAueDateResponse, contains the count of devices of a specific model and auto update expiration range.
*/
export interface Schema$GoogleChromeManagementV1DeviceAueCountReport {
/**
* Enum value of month corresponding to the auto update expiration date in UTC time zone. If the device is already expired, this field is empty.
*/
aueMonth?: string | null;
/**
* Int value of year corresponding to the Auto Update Expiration date in UTC time zone. If the device is already expired, this field is empty.
*/
aueYear?: string | null;
/**
* Count of devices of this model.
*/
count?: string | null;
/**
* Boolean value for whether or not the device has already expired.
*/
expired?: boolean | null;
/**
* Public model name of the devices.
*/
model?: string | null;
}
/**
* Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
*/
export interface Schema$GoogleChromeManagementV1DeviceHardwareCountReport {
/**
* Public name of the hardware specification.
*/
bucket?: string | null;
/**
* Count of devices with a unique hardware specification.
*/
count?: string | null;
}
/**
* Status of the single storage device.
*/
export interface Schema$GoogleChromeManagementV1DiskInfo {
/**
* Output only. Number of bytes read since last boot.
*/
bytesReadThisSession?: string | null;
/**
* Output only. Number of bytes written since last boot.
*/
bytesWrittenThisSession?: string | null;
/**
* Output only. Time spent discarding since last boot. Discarding is writing to clear blocks which are no longer in use. Supported on kernels 4.18+.
*/
discardTimeThisSession?: string | null;
/**
* Output only. Disk health.
*/
health?: string | null;
/**
* Output only. Counts the time the disk and queue were busy, so unlike the fields above, parallel requests are not counted multiple times.
*/
ioTimeThisSession?: string | null;
/**
* Output only. Disk manufacturer.
*/
manufacturer?: string | null;
/**
* Output only. Disk model.
*/
model?: string | null;
/**
* Output only. Time spent reading from disk since last boot.
*/
readTimeThisSession?: string | null;
/**
* Output only. Disk serial number.
*/
serialNumber?: string | null;
/**
* Output only. Disk size.
*/
sizeBytes?: string | null;
/**
* Output only. Disk type: eMMC / NVMe / ATA / SCSI.
*/
type?: string | null;
/**
* Output only. Disk volumes.
*/
volumeIds?: string[] | null;
/**
* Output only. Time spent writing to disk since last boot.
*/
writeTimeThisSession?: string | null;
}
/**
* Information of a display device.
*/
export interface Schema$GoogleChromeManagementV1DisplayDevice {
/**
* Output only. Display height in millimeters.
*/
displayHeightMm?: number | null;
/**
* Output only. Display device name.
*/
displayName?: string | null;
/**
* Output only. Display width in millimeters.
*/
displayWidthMm?: number | null;
/**
* Output only. Is display internal or not.
*/
internal?: boolean | null;
/**
* Output only. Three letter manufacturer ID.
*/
manufacturerId?: string | null;
/**
* Output only. Year of manufacture.
*/
manufactureYear?: number | null;
/**
* Output only. Manufacturer product code.
*/
modelId?: number | null;
}
/**
* Information for a display.
*/
export interface Schema$GoogleChromeManagementV1DisplayInfo {
/**
* Output only. Represents the graphics card device id.
*/
deviceId?: string | null;
/**
* Output only. Display device name.
*/
displayName?: string | null;
/**
* Output only. Indicates if display is internal or not.
*/
isInternal?: boolean | null;
/**
* Output only. Refresh rate in Hz.
*/
refreshRate?: number | null;
/**
* Output only. Resolution height in pixels.
*/
resolutionHeight?: number | null;
/**
* Output only. Resolution width in pixels.
*/
resolutionWidth?: number | null;
}
/**
* Response containing a list of devices with queried app installed.
*/
export interface Schema$GoogleChromeManagementV1FindInstalledAppDevicesResponse {
/**
* A list of devices which have the app installed. Sorted in ascending alphabetical order on the Device.machine field.
*/
devices?: Schema$GoogleChromeManagementV1Device[];
/**
* Token to specify the next page of the request.
*/
nextPageToken?: string | null;
/**
* Total number of devices matching request.
*/
totalSize?: number | null;
}
/**
* Information of a graphics adapter (GPU).
*/
export interface Schema$GoogleChromeManagementV1GraphicsAdapterInfo {
/**
* Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2).
*/
adapter?: string | null;
/**
* Output only. Represents the graphics card device id.
*/
deviceId?: string | null;
/**
* Output only. Version of the GPU driver.
*/
driverVersion?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1GraphicsInfo {
/**
* Output only. Information about the graphics adapter (GPU).
*/
adapterInfo?: Schema$GoogleChromeManagementV1GraphicsAdapterInfo;
/**
* Output only. Information about the display(s) of the device.
*/
displayDevices?: Schema$GoogleChromeManagementV1DisplayDevice[];
/**
* Output only. Is ePrivacy screen supported or not.
*/
eprivacySupported?: boolean | null;
/**
* Output only. Information about the internal touch screen(s) of the device.
*/
touchScreenInfo?: Schema$GoogleChromeManagementV1TouchScreenInfo;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1GraphicsStatusReport {
/**
* Output only. Information about the displays for the device.
*/
displays?: Schema$GoogleChromeManagementV1DisplayInfo[];
/**
* Output only. Time at which the graphics data was reported.
*/
reportTime?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1HeartbeatStatusReport {
/**
* Timestamp of when status changed was detected
*/
reportTime?: string | null;
/**
* State the device changed to
*/
state?: string | null;
}
/**
* Data that describes the result of the HTTPS latency diagnostics routine, with the HTTPS requests issued to Google websites.
*/
export interface Schema$GoogleChromeManagementV1HttpsLatencyRoutineData {
/**
* Output only. HTTPS latency if routine succeeded or failed because of HIGH_LATENCY or VERY_HIGH_LATENCY.
*/
latency?: string | null;
/**
* Output only. HTTPS latency routine problem if a problem occurred.
*/
problem?: string | null;
}
/**
* Describes an installed app.
*/
export interface Schema$GoogleChromeManagementV1InstalledApp {
/**
* Output only. Unique identifier of the app. For Chrome apps and extensions, the 32-character id (e.g. ehoadneljpdggcbbknedodolkkjodefl). For Android apps, the package name (e.g. com.evernote).
*/
appId?: string | null;
/**
* Output only. How the app was installed.
*/
appInstallType?: string | null;
/**
* Output only. Source of the installed app.
*/
appSource?: string | null;
/**
* Output only. Type of the app.
*/
appType?: string | null;
/**
* Output only. Count of browser devices with this app installed.
*/
browserDeviceCount?: string | null;
/**
* Output only. Description of the installed app.
*/
description?: string | null;
/**
* Output only. Whether the app is disabled.
*/
disabled?: boolean | null;
/**
* Output only. Name of the installed app.
*/
displayName?: string | null;
/**
* Output only. Homepage uri of the installed app.
*/
homepageUri?: string | null;
/**
* Output only. Count of ChromeOS users with this app installed.
*/
osUserCount?: string | null;
/**
* Output only. Permissions of the installed app.
*/
permissions?: string[] | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1KioskAppStatusReport {
/**
* App id of kiosk app for example "mdmkkicfmmkgmpkmkdikhlbggogpicma"
*/
appId?: string | null;
/**
* App version number of kiosk app for example "1.10.118"
*/
appVersion?: string | null;
/**
* Timestamp of when report was collected
*/
reportTime?: string | null;
}
export interface Schema$GoogleChromeManagementV1ListTelemetryDevicesResponse {
/**
* Telemetry devices returned in the response.
*/
devices?: Schema$GoogleChromeManagementV1TelemetryDevice[];
/**
* Token to specify next page in the list.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing telemetry events for a customer.
*/
export interface Schema$GoogleChromeManagementV1ListTelemetryEventsResponse {
/**
* Token to specify next page in the list.
*/
nextPageToken?: string | null;
/**
* Telemetry events returned in the response.
*/
telemetryEvents?: Schema$GoogleChromeManagementV1TelemetryEvent[];
}
/**
* Response message for listing telemetry users for a customer.
*/
export interface Schema$GoogleChromeManagementV1ListTelemetryUsersResponse {
/**
* Token to specify next page in the list.
*/
nextPageToken?: string | null;
/**
* Telemetry users returned in the response.
*/
telemetryUsers?: Schema$GoogleChromeManagementV1TelemetryUser[];
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1MemoryInfo {
/**
* Output only. Amount of available RAM in bytes.
*/
availableRamBytes?: string | null;
/**
* Output only. Total memory encryption info for the device.
*/
totalMemoryEncryption?: Schema$GoogleChromeManagementV1TotalMemoryEncryptionInfo;
/**
* Output only. Total RAM in bytes.
*/
totalRamBytes?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1MemoryStatusReport {
/**
* Output only. Number of page faults during this collection
*/
pageFaults?: number | null;
/**
* Output only. The timestamp in milliseconds representing time at which this report was sampled.
*/
reportTime?: string | null;
/**
* Output only. Frequency the report is sampled.
*/
sampleFrequency?: string | null;
/**
* Output only. Amount of free RAM in bytes (unreliable due to Garbage Collection).
*/
systemRamFreeBytes?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1NetworkDevice {
/**
* Output only. The integrated circuit card ID associated with the device's sim card.
*/
iccid?: string | null;
/**
* Output only. IMEI (if applicable) of the corresponding network device.
*/
imei?: string | null;
/**
* Output only. MAC address (if applicable) of the corresponding network device.
*/
macAddress?: string | null;
/**
* Output only. The mobile directory number associated with the device's sim card.
*/
mdn?: string | null;
/**
* Output only. MEID (if applicable) of the corresponding network device.
*/
meid?: string | null;
/**
* Output only. Network device type.
*/
type?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1NetworkDiagnosticsReport {
/**
* Output only. HTTPS latency test data.
*/
httpsLatencyData?: Schema$GoogleChromeManagementV1HttpsLatencyRoutineData;
/**
* Output only. Timestamp of when the diagnostics were collected.
*/
reportTime?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1NetworkInfo {
/**
* Output only. List of network devices.
*/
networkDevices?: Schema$GoogleChromeManagementV1NetworkDevice[];
}
/**
* 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
*/
export interface Schema$GoogleChromeManagementV1NetworkStatusReport {
/**
* Output only. Current connection state of the network.
*/
connectionState?: string | null;
/**
* Output only. Network connection type.
*/
connectionType?: string | null;
/**
* Output only. Whether the wifi encryption key is turned off.
*/
encryptionOn?: boolean | null;
/**
* Output only. Gateway IP address.
*/
gatewayIpAddress?: string | null;
/**
* Output only. Network connection guid.
*/
guid?: string | null;
/**
* Output only. LAN IP address.
*/
lanIpAddress?: string | null;
/**
* Output only. Receiving bit rate measured in Megabits per second.
*/
receivingBitRateMbps?: string | null;
/**
* Output only. Time at which the network state was reported.
*/
reportTime?: string | null;
/**
* Output only. Frequency the report is sampled.
*/
sampleFrequency?: string | null;
/**
* Output only. Signal strength for wireless networks measured in decibels.
*/
signalStrengthDbm?: number | null;
/**
* Output only. Transmission bit rate meas