| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="chromemanagement_v1.html">Chrome Management API</a> . <a href="chromemanagement_v1.customers.html">customers</a> . <a href="chromemanagement_v1.customers.reports.html">reports</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#countChromeBrowsersNeedingAttention">countChromeBrowsersNeedingAttention(customer, orgUnitId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Count of Chrome Browsers that have been recently enrolled, have new policy to be synced, or have no recent activity.</p> | |
| <p class="toc_element"> | |
| <code><a href="#countChromeDevicesReachingAutoExpirationDate">countChromeDevicesReachingAutoExpirationDate(customer, maxAueDate=None, minAueDate=None, orgUnitId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947).</p> | |
| <p class="toc_element"> | |
| <code><a href="#countChromeDevicesThatNeedAttention">countChromeDevicesThatNeedAttention(customer, orgUnitId=None, readMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947</p> | |
| <p class="toc_element"> | |
| <code><a href="#countChromeHardwareFleetDevices">countChromeHardwareFleetDevices(customer, orgUnitId=None, readMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947</p> | |
| <p class="toc_element"> | |
| <code><a href="#countChromeVersions">countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Generate report of installed Chrome versions.</p> | |
| <p class="toc_element"> | |
| <code><a href="#countChromeVersions_next">countChromeVersions_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#countInstalledApps">countInstalledApps(customer, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Generate report of app installations.</p> | |
| <p class="toc_element"> | |
| <code><a href="#countInstalledApps_next">countInstalledApps_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#findInstalledAppDevices">findInstalledAppDevices(customer, appId=None, appType=None, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Generate report of managed Chrome browser devices that have a specified app installed.</p> | |
| <p class="toc_element"> | |
| <code><a href="#findInstalledAppDevices_next">findInstalledAppDevices_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countChromeBrowsersNeedingAttention">countChromeBrowsersNeedingAttention(customer, orgUnitId=None, x__xgafv=None)</code> | |
| <pre>Count of Chrome Browsers that have been recently enrolled, have new policy to be synced, or have no recent activity. | |
| Args: | |
| customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required) | |
| orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response containing counts for browsers that need attention. | |
| "noRecentActivityCount": "A String", # Number of browsers that haven’t had any recent activity | |
| "pendingBrowserUpdateCount": "A String", # Number of browsers that are pending an OS update | |
| "recentlyEnrolledCount": "A String", # Number of browsers that have been recently enrolled | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countChromeDevicesReachingAutoExpirationDate">countChromeDevicesReachingAutoExpirationDate(customer, maxAueDate=None, minAueDate=None, orgUnitId=None, x__xgafv=None)</code> | |
| <pre>Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947). | |
| Args: | |
| customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required) | |
| maxAueDate: string, Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or earlier than the maximum date. | |
| minAueDate: string, Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or later than the minimum date. | |
| orgUnitId: string, Optional. The organizational unit ID, if omitted, will return data for all organizational units. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # 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. | |
| "deviceAueCountReports": [ # The list of reports sorted by auto update expiration date in ascending order. | |
| { # Report for CountChromeDevicesPerAueDateResponse, contains the count of devices of a specific model and auto update expiration range. | |
| "aueMonth": "A String", # 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. | |
| "aueYear": "A String", # 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. | |
| "count": "A String", # Count of devices of this model. | |
| "expired": True or False, # Boolean value for whether or not the device has already expired. | |
| "model": "A String", # Public model name of the devices. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countChromeDevicesThatNeedAttention">countChromeDevicesThatNeedAttention(customer, orgUnitId=None, readMask=None, x__xgafv=None)</code> | |
| <pre>Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947 | |
| Args: | |
| customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required) | |
| orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned. | |
| readMask: string, Required. Mask of the fields that should be populated in the returned report. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response containing counts for devices that need attention. | |
| "noRecentPolicySyncCount": "A String", # Number of ChromeOS devices have not synced policies in the past 28 days. | |
| "noRecentUserActivityCount": "A String", # Number of ChromeOS devices that have not seen any user activity in the past 28 days. | |
| "osVersionNotCompliantCount": "A String", # Number of devices whose OS version is not compliant. | |
| "pendingUpdate": "A String", # Number of devices that are pending an OS update. | |
| "unsupportedPolicyCount": "A String", # Number of devices that are unable to apply a policy due to an OS version mismatch. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countChromeHardwareFleetDevices">countChromeHardwareFleetDevices(customer, orgUnitId=None, readMask=None, x__xgafv=None)</code> | |
| <pre>Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947 | |
| Args: | |
| customer: string, Required. The customer ID or "my_customer". (required) | |
| orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned. | |
| readMask: string, Required. Mask of the fields that should be populated in the returned report. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response containing a list of devices with a specific type of hardware specification from the requested hardware type. | |
| "cpuReports": [ # The DeviceHardwareCountReport for device cpu type (for example Intel(R) Core(TM) i7-10610U CPU @ 1.80GHz). | |
| { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification. | |
| "bucket": "A String", # Public name of the hardware specification. | |
| "count": "A String", # Count of devices with a unique hardware specification. | |
| }, | |
| ], | |
| "memoryReports": [ # The DeviceHardwareCountReport for device memory amount in gigabytes (for example 16). | |
| { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification. | |
| "bucket": "A String", # Public name of the hardware specification. | |
| "count": "A String", # Count of devices with a unique hardware specification. | |
| }, | |
| ], | |
| "modelReports": [ # The DeviceHardwareCountReport for device model type (for example Acer C7 Chromebook). | |
| { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification. | |
| "bucket": "A String", # Public name of the hardware specification. | |
| "count": "A String", # Count of devices with a unique hardware specification. | |
| }, | |
| ], | |
| "storageReports": [ # The DeviceHardwareCountReport for device storage amount in gigabytes (for example 128). | |
| { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification. | |
| "bucket": "A String", # Public name of the hardware specification. | |
| "count": "A String", # Count of devices with a unique hardware specification. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countChromeVersions">countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Generate report of installed Chrome versions. | |
| Args: | |
| customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) | |
| filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date | |
| orgUnitId: string, The ID of the organizational unit. | |
| pageSize: integer, Maximum number of results to return. Maximum and default are 100. | |
| pageToken: string, Token to specify the page of the request to be returned. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response containing requested browser versions details and counts. | |
| "browserVersions": [ # List of all browser versions and their install counts. | |
| { # Describes a browser version and its install count. | |
| "channel": "A String", # Output only. The release channel of the installed browser. | |
| "count": "A String", # Output only. Count grouped by device_system and major version | |
| "deviceOsVersion": "A String", # Output only. Version of the system-specified operating system. | |
| "system": "A String", # Output only. The device operating system. | |
| "version": "A String", # Output only. The full version of the installed browser. | |
| }, | |
| ], | |
| "nextPageToken": "A String", # Token to specify the next page of the request. | |
| "totalSize": 42, # Total number browser versions matching request. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countChromeVersions_next">countChromeVersions_next()</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countInstalledApps">countInstalledApps(customer, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Generate report of app installations. | |
| Args: | |
| customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) | |
| filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id | |
| orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id | |
| orgUnitId: string, The ID of the organizational unit. | |
| pageSize: integer, Maximum number of results to return. Maximum and default are 100. | |
| pageToken: string, Token to specify the page of the request to be returned. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response containing details of queried installed apps. | |
| "installedApps": [ # List of installed apps matching request. | |
| { # Describes an installed app. | |
| "appId": "A String", # 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). | |
| "appInstallType": "A String", # Output only. How the app was installed. | |
| "appSource": "A String", # Output only. Source of the installed app. | |
| "appType": "A String", # Output only. Type of the app. | |
| "browserDeviceCount": "A String", # Output only. Count of browser devices with this app installed. | |
| "description": "A String", # Output only. Description of the installed app. | |
| "disabled": True or False, # Output only. Whether the app is disabled. | |
| "displayName": "A String", # Output only. Name of the installed app. | |
| "homepageUri": "A String", # Output only. Homepage uri of the installed app. | |
| "osUserCount": "A String", # Output only. Count of ChromeOS users with this app installed. | |
| "permissions": [ # Output only. Permissions of the installed app. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "nextPageToken": "A String", # Token to specify the next page of the request. | |
| "totalSize": 42, # Total number of installed apps matching request. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="countInstalledApps_next">countInstalledApps_next()</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="findInstalledAppDevices">findInstalledAppDevices(customer, appId=None, appType=None, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Generate report of managed Chrome browser devices that have a specified app installed. | |
| Args: | |
| customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) | |
| appId: string, 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). | |
| appType: string, Type of the app. | |
| Allowed values | |
| APP_TYPE_UNSPECIFIED - App type not specified. | |
| EXTENSION - Chrome extension. | |
| APP - Chrome app. | |
| THEME - Chrome theme. | |
| HOSTED_APP - Chrome hosted app. | |
| ANDROID_APP - ARC++ app. | |
| filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date | |
| orderBy: string, Field used to order results. Supported order by fields: * machine * device_id | |
| orgUnitId: string, The ID of the organizational unit. | |
| pageSize: integer, Maximum number of results to return. Maximum and default are 100. | |
| pageToken: string, Token to specify the page of the request to be returned. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response containing a list of devices with queried app installed. | |
| "devices": [ # A list of devices which have the app installed. Sorted in ascending alphabetical order on the Device.machine field. | |
| { # Describes a device reporting Chrome browser information. | |
| "deviceId": "A String", # Output only. The ID of the device that reported this Chrome browser information. | |
| "machine": "A String", # Output only. The name of the machine within its local network. | |
| }, | |
| ], | |
| "nextPageToken": "A String", # Token to specify the next page of the request. | |
| "totalSize": 42, # Total number of devices matching request. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="findInstalledAppDevices_next">findInstalledAppDevices_next()</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| </body></html> |