| <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="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.chromeosdevices.html">chromeosdevices</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#action">action(customerId, resourceId, body=None)</a></code></p> |
| <p class="firstline">Take action on Chrome OS Device</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(customerId, deviceId, projection=None)</a></code></p> |
| <p class="firstline">Retrieve Chrome OS Device</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(customerId, maxResults=None, orderBy=None, orgUnitPath=None, pageToken=None, projection=None, query=None, sortOrder=None)</a></code></p> |
| <p class="firstline">Retrieve all Chrome OS Devices of a customer (paginated)</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#moveDevicesToOu">moveDevicesToOu(customerId, orgUnitPath, body=None)</a></code></p> |
| <p class="firstline">Move or insert multiple Chrome OS Devices to organizational unit</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(customerId, deviceId, body=None, projection=None)</a></code></p> |
| <p class="firstline">Update Chrome OS Device. This method supports patch semantics.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(customerId, deviceId, body=None, projection=None)</a></code></p> |
| <p class="firstline">Update Chrome OS Device</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="action">action(customerId, resourceId, body=None)</code> |
| <pre>Take action on Chrome OS Device |
| |
| Args: |
| customerId: string, Immutable ID of the G Suite account (required) |
| resourceId: string, Immutable ID of Chrome OS Device (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON request template for firing actions on ChromeOs Device in Directory Devices API. |
| "action": "A String", # Action to be taken on the ChromeOs Device |
| "deprovisionReason": "A String", |
| } |
| |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(customerId, deviceId, projection=None)</code> |
| <pre>Retrieve Chrome OS Device |
| |
| Args: |
| customerId: string, Immutable ID of the G Suite account (required) |
| deviceId: string, Immutable ID of Chrome OS Device (required) |
| projection: string, Restrict information returned to a set of selected fields. |
| Allowed values |
| BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) |
| FULL - Includes all metadata fields |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for Chrome Os Device resource in Directory API. |
| "activeTimeRanges": [ # List of active time ranges (Read-only) |
| { |
| "activeTime": 42, # Duration in milliseconds |
| "date": "A String", # Date of usage |
| }, |
| ], |
| "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation |
| "annotatedLocation": "A String", # Address or location of the device as noted by the administrator |
| "annotatedUser": "A String", # User of the device |
| "autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support |
| "bootMode": "A String", # Chromebook boot mode (Read-only) |
| "cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only) |
| { |
| "cpuTemperatureInfo": [ # List of CPU temperature samples. |
| { |
| "label": "A String", # CPU label |
| "temperature": 42, # Temperature in Celsius degrees. |
| }, |
| ], |
| "cpuUtilizationPercentageInfo": [ |
| 42, |
| ], |
| "reportTime": "A String", # Date and time the report was received. |
| }, |
| ], |
| "deviceFiles": [ # List of device files to download (Read-only) |
| { |
| "createTime": "A String", # Date and time the file was created |
| "downloadUrl": "A String", # File download URL |
| "name": "A String", # File name |
| "type": "A String", # File type |
| }, |
| ], |
| "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only) |
| "diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes. |
| { |
| "volumeInfo": [ # Disk volumes |
| { |
| "storageFree": "A String", # Free disk space [in bytes] |
| "storageTotal": "A String", # Total disk space [in bytes] |
| "volumeId": "A String", # Volume id |
| }, |
| ], |
| }, |
| ], |
| "dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. |
| "etag": "A String", # ETag of the resource. |
| "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only) |
| "ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| "firmwareVersion": "A String", # Chromebook firmware version (Read-only) |
| "kind": "admin#directory#chromeosdevice", # Kind of resource this is. |
| "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only) |
| "lastKnownNetwork": [ # Contains last used network (Read-only) |
| { |
| "ipAddress": "A String", # The IP address |
| "wanIpAddress": "A String", # The WAN IP address |
| }, |
| ], |
| "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) |
| "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only) |
| "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. |
| "meid": "A String", # Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) |
| "model": "A String", # Chromebook Model (Read-only) |
| "notes": "A String", # Notes added by the administrator |
| "orderNumber": "A String", # Chromebook order number (Read-only) |
| "orgUnitPath": "A String", # OrgUnit of the device |
| "osVersion": "A String", # Chromebook Os Version (Read-only) |
| "platformVersion": "A String", # Chromebook platform version (Read-only) |
| "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only) |
| { |
| "email": "A String", # Email address of the user. Present only if the user type is managed |
| "type": "A String", # The type of the user |
| }, |
| ], |
| "serialNumber": "A String", # Chromebook serial number (Read-only) |
| "status": "A String", # status of the device (Read-only) |
| "supportEndDate": "A String", # Final date the device will be supported (Read-only) |
| "systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only) |
| { |
| "reportTime": "A String", # Date and time the report was received. |
| "systemRamFreeInfo": [ |
| "A String", |
| ], |
| }, |
| ], |
| "systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only) |
| "tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only) |
| "family": "A String", # TPM family. |
| "firmwareVersion": "A String", # TPM firmware version. |
| "manufacturer": "A String", # TPM manufacturer code. |
| "specLevel": "A String", # TPM specification level. |
| "tpmModel": "A String", # TPM model number. |
| "vendorSpecific": "A String", # Vendor-specific information such as Vendor ID. |
| }, |
| "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only) |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(customerId, maxResults=None, orderBy=None, orgUnitPath=None, pageToken=None, projection=None, query=None, sortOrder=None)</code> |
| <pre>Retrieve all Chrome OS Devices of a customer (paginated) |
| |
| Args: |
| customerId: string, Immutable ID of the G Suite account (required) |
| maxResults: integer, Maximum number of results to return. Max allowed value is 200. |
| orderBy: string, Column to use for sorting results |
| Allowed values |
| annotatedLocation - Chromebook location as annotated by the administrator. |
| annotatedUser - Chromebook user as annotated by administrator. |
| lastSync - Chromebook last sync. |
| notes - Chromebook notes as annotated by the administrator. |
| serialNumber - Chromebook Serial Number. |
| status - Chromebook status. |
| supportEndDate - Chromebook support end date. |
| orgUnitPath: string, Full path of the organizational unit or its ID |
| pageToken: string, Token to specify next page in the list |
| projection: string, Restrict information returned to a set of selected fields. |
| Allowed values |
| BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) |
| FULL - Includes all metadata fields |
| query: string, Search string in the format provided by this Help Center article. |
| sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used |
| Allowed values |
| ASCENDING - Ascending order. |
| DESCENDING - Descending order. |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON response template for List Chrome OS Devices operation in Directory API. |
| "chromeosdevices": [ # List of Chrome OS Device objects. |
| { # JSON template for Chrome Os Device resource in Directory API. |
| "activeTimeRanges": [ # List of active time ranges (Read-only) |
| { |
| "activeTime": 42, # Duration in milliseconds |
| "date": "A String", # Date of usage |
| }, |
| ], |
| "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation |
| "annotatedLocation": "A String", # Address or location of the device as noted by the administrator |
| "annotatedUser": "A String", # User of the device |
| "autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support |
| "bootMode": "A String", # Chromebook boot mode (Read-only) |
| "cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only) |
| { |
| "cpuTemperatureInfo": [ # List of CPU temperature samples. |
| { |
| "label": "A String", # CPU label |
| "temperature": 42, # Temperature in Celsius degrees. |
| }, |
| ], |
| "cpuUtilizationPercentageInfo": [ |
| 42, |
| ], |
| "reportTime": "A String", # Date and time the report was received. |
| }, |
| ], |
| "deviceFiles": [ # List of device files to download (Read-only) |
| { |
| "createTime": "A String", # Date and time the file was created |
| "downloadUrl": "A String", # File download URL |
| "name": "A String", # File name |
| "type": "A String", # File type |
| }, |
| ], |
| "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only) |
| "diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes. |
| { |
| "volumeInfo": [ # Disk volumes |
| { |
| "storageFree": "A String", # Free disk space [in bytes] |
| "storageTotal": "A String", # Total disk space [in bytes] |
| "volumeId": "A String", # Volume id |
| }, |
| ], |
| }, |
| ], |
| "dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. |
| "etag": "A String", # ETag of the resource. |
| "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only) |
| "ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| "firmwareVersion": "A String", # Chromebook firmware version (Read-only) |
| "kind": "admin#directory#chromeosdevice", # Kind of resource this is. |
| "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only) |
| "lastKnownNetwork": [ # Contains last used network (Read-only) |
| { |
| "ipAddress": "A String", # The IP address |
| "wanIpAddress": "A String", # The WAN IP address |
| }, |
| ], |
| "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) |
| "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only) |
| "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. |
| "meid": "A String", # Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) |
| "model": "A String", # Chromebook Model (Read-only) |
| "notes": "A String", # Notes added by the administrator |
| "orderNumber": "A String", # Chromebook order number (Read-only) |
| "orgUnitPath": "A String", # OrgUnit of the device |
| "osVersion": "A String", # Chromebook Os Version (Read-only) |
| "platformVersion": "A String", # Chromebook platform version (Read-only) |
| "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only) |
| { |
| "email": "A String", # Email address of the user. Present only if the user type is managed |
| "type": "A String", # The type of the user |
| }, |
| ], |
| "serialNumber": "A String", # Chromebook serial number (Read-only) |
| "status": "A String", # status of the device (Read-only) |
| "supportEndDate": "A String", # Final date the device will be supported (Read-only) |
| "systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only) |
| { |
| "reportTime": "A String", # Date and time the report was received. |
| "systemRamFreeInfo": [ |
| "A String", |
| ], |
| }, |
| ], |
| "systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only) |
| "tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only) |
| "family": "A String", # TPM family. |
| "firmwareVersion": "A String", # TPM firmware version. |
| "manufacturer": "A String", # TPM manufacturer code. |
| "specLevel": "A String", # TPM specification level. |
| "tpmModel": "A String", # TPM model number. |
| "vendorSpecific": "A String", # Vendor-specific information such as Vendor ID. |
| }, |
| "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only) |
| }, |
| ], |
| "etag": "A String", # ETag of the resource. |
| "kind": "admin#directory#chromeosdevices", # Kind of resource this is. |
| "nextPageToken": "A String", # Token used to access next page of this result. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</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="moveDevicesToOu">moveDevicesToOu(customerId, orgUnitPath, body=None)</code> |
| <pre>Move or insert multiple Chrome OS Devices to organizational unit |
| |
| Args: |
| customerId: string, Immutable ID of the G Suite account (required) |
| orgUnitPath: string, Full path of the target organizational unit or its ID (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON request template for moving ChromeOs Device to given OU in Directory Devices API. |
| "deviceIds": [ # ChromeOs Devices to be moved to OU |
| "A String", |
| ], |
| } |
| |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(customerId, deviceId, body=None, projection=None)</code> |
| <pre>Update Chrome OS Device. This method supports patch semantics. |
| |
| Args: |
| customerId: string, Immutable ID of the G Suite account (required) |
| deviceId: string, Immutable ID of Chrome OS Device (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for Chrome Os Device resource in Directory API. |
| "activeTimeRanges": [ # List of active time ranges (Read-only) |
| { |
| "activeTime": 42, # Duration in milliseconds |
| "date": "A String", # Date of usage |
| }, |
| ], |
| "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation |
| "annotatedLocation": "A String", # Address or location of the device as noted by the administrator |
| "annotatedUser": "A String", # User of the device |
| "autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support |
| "bootMode": "A String", # Chromebook boot mode (Read-only) |
| "cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only) |
| { |
| "cpuTemperatureInfo": [ # List of CPU temperature samples. |
| { |
| "label": "A String", # CPU label |
| "temperature": 42, # Temperature in Celsius degrees. |
| }, |
| ], |
| "cpuUtilizationPercentageInfo": [ |
| 42, |
| ], |
| "reportTime": "A String", # Date and time the report was received. |
| }, |
| ], |
| "deviceFiles": [ # List of device files to download (Read-only) |
| { |
| "createTime": "A String", # Date and time the file was created |
| "downloadUrl": "A String", # File download URL |
| "name": "A String", # File name |
| "type": "A String", # File type |
| }, |
| ], |
| "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only) |
| "diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes. |
| { |
| "volumeInfo": [ # Disk volumes |
| { |
| "storageFree": "A String", # Free disk space [in bytes] |
| "storageTotal": "A String", # Total disk space [in bytes] |
| "volumeId": "A String", # Volume id |
| }, |
| ], |
| }, |
| ], |
| "dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. |
| "etag": "A String", # ETag of the resource. |
| "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only) |
| "ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| "firmwareVersion": "A String", # Chromebook firmware version (Read-only) |
| "kind": "admin#directory#chromeosdevice", # Kind of resource this is. |
| "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only) |
| "lastKnownNetwork": [ # Contains last used network (Read-only) |
| { |
| "ipAddress": "A String", # The IP address |
| "wanIpAddress": "A String", # The WAN IP address |
| }, |
| ], |
| "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) |
| "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only) |
| "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. |
| "meid": "A String", # Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) |
| "model": "A String", # Chromebook Model (Read-only) |
| "notes": "A String", # Notes added by the administrator |
| "orderNumber": "A String", # Chromebook order number (Read-only) |
| "orgUnitPath": "A String", # OrgUnit of the device |
| "osVersion": "A String", # Chromebook Os Version (Read-only) |
| "platformVersion": "A String", # Chromebook platform version (Read-only) |
| "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only) |
| { |
| "email": "A String", # Email address of the user. Present only if the user type is managed |
| "type": "A String", # The type of the user |
| }, |
| ], |
| "serialNumber": "A String", # Chromebook serial number (Read-only) |
| "status": "A String", # status of the device (Read-only) |
| "supportEndDate": "A String", # Final date the device will be supported (Read-only) |
| "systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only) |
| { |
| "reportTime": "A String", # Date and time the report was received. |
| "systemRamFreeInfo": [ |
| "A String", |
| ], |
| }, |
| ], |
| "systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only) |
| "tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only) |
| "family": "A String", # TPM family. |
| "firmwareVersion": "A String", # TPM firmware version. |
| "manufacturer": "A String", # TPM manufacturer code. |
| "specLevel": "A String", # TPM specification level. |
| "tpmModel": "A String", # TPM model number. |
| "vendorSpecific": "A String", # Vendor-specific information such as Vendor ID. |
| }, |
| "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only) |
| } |
| |
| projection: string, Restrict information returned to a set of selected fields. |
| Allowed values |
| BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) |
| FULL - Includes all metadata fields |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for Chrome Os Device resource in Directory API. |
| "activeTimeRanges": [ # List of active time ranges (Read-only) |
| { |
| "activeTime": 42, # Duration in milliseconds |
| "date": "A String", # Date of usage |
| }, |
| ], |
| "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation |
| "annotatedLocation": "A String", # Address or location of the device as noted by the administrator |
| "annotatedUser": "A String", # User of the device |
| "autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support |
| "bootMode": "A String", # Chromebook boot mode (Read-only) |
| "cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only) |
| { |
| "cpuTemperatureInfo": [ # List of CPU temperature samples. |
| { |
| "label": "A String", # CPU label |
| "temperature": 42, # Temperature in Celsius degrees. |
| }, |
| ], |
| "cpuUtilizationPercentageInfo": [ |
| 42, |
| ], |
| "reportTime": "A String", # Date and time the report was received. |
| }, |
| ], |
| "deviceFiles": [ # List of device files to download (Read-only) |
| { |
| "createTime": "A String", # Date and time the file was created |
| "downloadUrl": "A String", # File download URL |
| "name": "A String", # File name |
| "type": "A String", # File type |
| }, |
| ], |
| "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only) |
| "diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes. |
| { |
| "volumeInfo": [ # Disk volumes |
| { |
| "storageFree": "A String", # Free disk space [in bytes] |
| "storageTotal": "A String", # Total disk space [in bytes] |
| "volumeId": "A String", # Volume id |
| }, |
| ], |
| }, |
| ], |
| "dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. |
| "etag": "A String", # ETag of the resource. |
| "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only) |
| "ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| "firmwareVersion": "A String", # Chromebook firmware version (Read-only) |
| "kind": "admin#directory#chromeosdevice", # Kind of resource this is. |
| "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only) |
| "lastKnownNetwork": [ # Contains last used network (Read-only) |
| { |
| "ipAddress": "A String", # The IP address |
| "wanIpAddress": "A String", # The WAN IP address |
| }, |
| ], |
| "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) |
| "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only) |
| "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. |
| "meid": "A String", # Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) |
| "model": "A String", # Chromebook Model (Read-only) |
| "notes": "A String", # Notes added by the administrator |
| "orderNumber": "A String", # Chromebook order number (Read-only) |
| "orgUnitPath": "A String", # OrgUnit of the device |
| "osVersion": "A String", # Chromebook Os Version (Read-only) |
| "platformVersion": "A String", # Chromebook platform version (Read-only) |
| "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only) |
| { |
| "email": "A String", # Email address of the user. Present only if the user type is managed |
| "type": "A String", # The type of the user |
| }, |
| ], |
| "serialNumber": "A String", # Chromebook serial number (Read-only) |
| "status": "A String", # status of the device (Read-only) |
| "supportEndDate": "A String", # Final date the device will be supported (Read-only) |
| "systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only) |
| { |
| "reportTime": "A String", # Date and time the report was received. |
| "systemRamFreeInfo": [ |
| "A String", |
| ], |
| }, |
| ], |
| "systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only) |
| "tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only) |
| "family": "A String", # TPM family. |
| "firmwareVersion": "A String", # TPM firmware version. |
| "manufacturer": "A String", # TPM manufacturer code. |
| "specLevel": "A String", # TPM specification level. |
| "tpmModel": "A String", # TPM model number. |
| "vendorSpecific": "A String", # Vendor-specific information such as Vendor ID. |
| }, |
| "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only) |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(customerId, deviceId, body=None, projection=None)</code> |
| <pre>Update Chrome OS Device |
| |
| Args: |
| customerId: string, Immutable ID of the G Suite account (required) |
| deviceId: string, Immutable ID of Chrome OS Device (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for Chrome Os Device resource in Directory API. |
| "activeTimeRanges": [ # List of active time ranges (Read-only) |
| { |
| "activeTime": 42, # Duration in milliseconds |
| "date": "A String", # Date of usage |
| }, |
| ], |
| "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation |
| "annotatedLocation": "A String", # Address or location of the device as noted by the administrator |
| "annotatedUser": "A String", # User of the device |
| "autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support |
| "bootMode": "A String", # Chromebook boot mode (Read-only) |
| "cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only) |
| { |
| "cpuTemperatureInfo": [ # List of CPU temperature samples. |
| { |
| "label": "A String", # CPU label |
| "temperature": 42, # Temperature in Celsius degrees. |
| }, |
| ], |
| "cpuUtilizationPercentageInfo": [ |
| 42, |
| ], |
| "reportTime": "A String", # Date and time the report was received. |
| }, |
| ], |
| "deviceFiles": [ # List of device files to download (Read-only) |
| { |
| "createTime": "A String", # Date and time the file was created |
| "downloadUrl": "A String", # File download URL |
| "name": "A String", # File name |
| "type": "A String", # File type |
| }, |
| ], |
| "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only) |
| "diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes. |
| { |
| "volumeInfo": [ # Disk volumes |
| { |
| "storageFree": "A String", # Free disk space [in bytes] |
| "storageTotal": "A String", # Total disk space [in bytes] |
| "volumeId": "A String", # Volume id |
| }, |
| ], |
| }, |
| ], |
| "dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. |
| "etag": "A String", # ETag of the resource. |
| "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only) |
| "ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| "firmwareVersion": "A String", # Chromebook firmware version (Read-only) |
| "kind": "admin#directory#chromeosdevice", # Kind of resource this is. |
| "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only) |
| "lastKnownNetwork": [ # Contains last used network (Read-only) |
| { |
| "ipAddress": "A String", # The IP address |
| "wanIpAddress": "A String", # The WAN IP address |
| }, |
| ], |
| "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) |
| "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only) |
| "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. |
| "meid": "A String", # Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) |
| "model": "A String", # Chromebook Model (Read-only) |
| "notes": "A String", # Notes added by the administrator |
| "orderNumber": "A String", # Chromebook order number (Read-only) |
| "orgUnitPath": "A String", # OrgUnit of the device |
| "osVersion": "A String", # Chromebook Os Version (Read-only) |
| "platformVersion": "A String", # Chromebook platform version (Read-only) |
| "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only) |
| { |
| "email": "A String", # Email address of the user. Present only if the user type is managed |
| "type": "A String", # The type of the user |
| }, |
| ], |
| "serialNumber": "A String", # Chromebook serial number (Read-only) |
| "status": "A String", # status of the device (Read-only) |
| "supportEndDate": "A String", # Final date the device will be supported (Read-only) |
| "systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only) |
| { |
| "reportTime": "A String", # Date and time the report was received. |
| "systemRamFreeInfo": [ |
| "A String", |
| ], |
| }, |
| ], |
| "systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only) |
| "tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only) |
| "family": "A String", # TPM family. |
| "firmwareVersion": "A String", # TPM firmware version. |
| "manufacturer": "A String", # TPM manufacturer code. |
| "specLevel": "A String", # TPM specification level. |
| "tpmModel": "A String", # TPM model number. |
| "vendorSpecific": "A String", # Vendor-specific information such as Vendor ID. |
| }, |
| "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only) |
| } |
| |
| projection: string, Restrict information returned to a set of selected fields. |
| Allowed values |
| BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) |
| FULL - Includes all metadata fields |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for Chrome Os Device resource in Directory API. |
| "activeTimeRanges": [ # List of active time ranges (Read-only) |
| { |
| "activeTime": 42, # Duration in milliseconds |
| "date": "A String", # Date of usage |
| }, |
| ], |
| "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation |
| "annotatedLocation": "A String", # Address or location of the device as noted by the administrator |
| "annotatedUser": "A String", # User of the device |
| "autoUpdateExpiration": "A String", # (Read-only) The timestamp after which the device will stop receiving Chrome updates or support |
| "bootMode": "A String", # Chromebook boot mode (Read-only) |
| "cpuStatusReports": [ # Reports of CPU utilization and temperature (Read-only) |
| { |
| "cpuTemperatureInfo": [ # List of CPU temperature samples. |
| { |
| "label": "A String", # CPU label |
| "temperature": 42, # Temperature in Celsius degrees. |
| }, |
| ], |
| "cpuUtilizationPercentageInfo": [ |
| 42, |
| ], |
| "reportTime": "A String", # Date and time the report was received. |
| }, |
| ], |
| "deviceFiles": [ # List of device files to download (Read-only) |
| { |
| "createTime": "A String", # Date and time the file was created |
| "downloadUrl": "A String", # File download URL |
| "name": "A String", # File name |
| "type": "A String", # File type |
| }, |
| ], |
| "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only) |
| "diskVolumeReports": [ # Reports of disk space and other info about mounted/connected volumes. |
| { |
| "volumeInfo": [ # Disk volumes |
| { |
| "storageFree": "A String", # Free disk space [in bytes] |
| "storageTotal": "A String", # Total disk space [in bytes] |
| "volumeId": "A String", # Volume id |
| }, |
| ], |
| }, |
| ], |
| "dockMacAddress": "A String", # (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. |
| "etag": "A String", # ETag of the resource. |
| "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only) |
| "ethernetMacAddress0": "A String", # (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| "firmwareVersion": "A String", # Chromebook firmware version (Read-only) |
| "kind": "admin#directory#chromeosdevice", # Kind of resource this is. |
| "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only) |
| "lastKnownNetwork": [ # Contains last used network (Read-only) |
| { |
| "ipAddress": "A String", # The IP address |
| "wanIpAddress": "A String", # The WAN IP address |
| }, |
| ], |
| "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) |
| "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only) |
| "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. |
| "meid": "A String", # Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) |
| "model": "A String", # Chromebook Model (Read-only) |
| "notes": "A String", # Notes added by the administrator |
| "orderNumber": "A String", # Chromebook order number (Read-only) |
| "orgUnitPath": "A String", # OrgUnit of the device |
| "osVersion": "A String", # Chromebook Os Version (Read-only) |
| "platformVersion": "A String", # Chromebook platform version (Read-only) |
| "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only) |
| { |
| "email": "A String", # Email address of the user. Present only if the user type is managed |
| "type": "A String", # The type of the user |
| }, |
| ], |
| "serialNumber": "A String", # Chromebook serial number (Read-only) |
| "status": "A String", # status of the device (Read-only) |
| "supportEndDate": "A String", # Final date the device will be supported (Read-only) |
| "systemRamFreeReports": [ # Reports of amounts of available RAM memory (Read-only) |
| { |
| "reportTime": "A String", # Date and time the report was received. |
| "systemRamFreeInfo": [ |
| "A String", |
| ], |
| }, |
| ], |
| "systemRamTotal": "A String", # Total RAM on the device [in bytes] (Read-only) |
| "tpmVersionInfo": { # Trusted Platform Module (TPM) (Read-only) |
| "family": "A String", # TPM family. |
| "firmwareVersion": "A String", # TPM firmware version. |
| "manufacturer": "A String", # TPM manufacturer code. |
| "specLevel": "A String", # TPM specification level. |
| "tpmModel": "A String", # TPM model number. |
| "vendorSpecific": "A String", # Vendor-specific information such as Vendor ID. |
| }, |
| "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only) |
| }</pre> |
| </div> |
| |
| </body></html> |
