action(customerId, resourceId, body)
Take action on Chrome OS Device
get(customerId, deviceId, projection=None)
Retrieve Chrome OS Device
Retrieve all Chrome OS Devices of a customer (paginated)
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(customerId, deviceId, body, projection=None)
Update Chrome OS Device. This method supports patch semantics.
update(customerId, deviceId, body, projection=None)
Update Chrome OS Device
action(customerId, resourceId, body)
Take action on Chrome OS Device
Args:
customerId: string, Immutable id of the Google Apps account (required)
resourceId: string, Immutable id of Chrome OS Device (required)
body: object, The request body. (required)
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",
}
get(customerId, deviceId, projection=None)
Retrieve Chrome OS Device
Args:
customerId: string, Immutable id of the Google Apps 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.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"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)
"model": "A String", # Chromebook Model (Read-only)
}
list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)
Retrieve all Chrome OS Devices of a customer (paginated)
Args:
customerId: string, Immutable id of the Google Apps account (required)
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.
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
pageToken: string, Token to specify next page in the list
maxResults: integer, Maximum number of results to return. Default is 100
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.
query: string, Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333
Returns:
An object of the form:
{ # JSON response template for List Chrome OS Devices operation in Directory API.
"nextPageToken": "A String", # Token used to access next page of this result.
"chromeosdevices": [ # List of Chrome OS Device objects.
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"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)
"model": "A String", # Chromebook Model (Read-only)
},
],
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#chromeosdevices", # Kind of resource this is.
}
list_next(previous_request, previous_response)
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.
patch(customerId, deviceId, body, projection=None)
Update Chrome OS Device. This method supports patch semantics.
Args:
customerId: string, Immutable id of the Google Apps account (required)
deviceId: string, Immutable id of Chrome OS Device (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"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)
"model": "A String", # Chromebook Model (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.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"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)
"model": "A String", # Chromebook Model (Read-only)
}
update(customerId, deviceId, body, projection=None)
Update Chrome OS Device
Args:
customerId: string, Immutable id of the Google Apps account (required)
deviceId: string, Immutable id of Chrome OS Device (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"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)
"model": "A String", # Chromebook Model (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.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"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)
"model": "A String", # Chromebook Model (Read-only)
}