|
检索某个账号的所有 Chrome 设备
要返回分配给某个账号的所有 Chrome 设备的列表,请使用以下代码
GET
请求中,并附上
向请求授权。为了方便阅读
此代码示例包含行返回:
GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/ devices/chromeos?projection={BASIC|FULL}&query=query &orderBy=orderBy category&sortOrder={ASCENDING|DESCENDING} &pageToken=token for next results page, if applicable &maxResults=max number of results per page
customerId
是客户的 Google 账号的唯一标识符。- 作为账号管理员,您还可以使用字符串
my_customer
, 代表您账号的customerId
。获取customerId
的其他方法 值是使用检索用户 操作。使用您的管理员电子邮件地址或管理员唯一身份用户id
userKey
path 参数中的值。
有关查询字符串、请求和响应属性的信息,请参阅 API 参考文档。
示例:按用户过滤设备
本示例使用query=user:help desk
搜索特定用户。通过
包含单个 chromeosdevice
资源,其中
annotatedUser
为 help desk
:
JSON 请求
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/ chromeos?projection=FULL&query=user:help desk&orderBy=status &sortOrder=ASCENDING&maxResults=100
JSON 响应
{ "kind": "directory#chromeosdevices", "chromeosdevices": [ { "kind": "directory#chromeosdevice", "etag": "1234567890" "deviceId": "def456", "serialNumber": "234567", "status": "ACTIVE", "lastSync": "2013-03-05T17:30:04.325Z", "supportEndDate": "2014-04-05T17:30:04.325Z", "annotatedUser": "help desk", "annotatedLocation": "Mountain View help desk Chromebook", "annotatedAssetId": "1234567890", "notes": "Loaned from support", "orderNumber": "1234", "willAutoRenew": true, "osVersion": "Browser Version 18.0", "platformVersion": "Platform Version 1415.2.0", "firmwareVersion": "Firmware Version 1.2.3.4", "bootMode": "validated", "lastEnrollmentTime": "2012-04-05T17:30:04.325Z", "orgUnitPath": "corp/engineering", "recentUsers": [ { "type": "USER_TYPE_MANAGED", "email": "user@customer.com" } ], "activeTimeRanges": [ { "date": "2012-04-05", "activeTime": "3600000" } ], } ], "nextPageToken": "abcdefghijkl123" }
示例:按序列号过滤设备
本示例使用
query=id:123456
,其中 123456
是
设备序列号下面显示的响应包含一个匹配的回复,其中
serialNumber
属性与搜索值匹配。
JSON 请求
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/ chromeos?projection=FULL&query=id:123456&orderBy=status &sortOrder=ASCENDING&maxResults=100
JSON 响应
{ "kind": "directory#chromeosdevices", "chromeosdevices": [ { "kind": "directory#chromeosdevice", "deviceId": "abc123", "serialNumber": "123456", "status": "SHIPPED", "supportEndDate": "1404457200000", "model": "model_value", "meid": "meid_value", "macAddress": "mac_address_value", "orderNumber": "1234", "willAutoRenew": true } ], "nextPageToken": "abcdefghijkl123" }
此响应示例包括 model
、meid
和
macAddress
属性。如果设备不具有这些属性,它们将不具有这些属性
。如需了解完整详情,请参阅
Chromeosdevices 资源表示法。
导出 MEID 列表
meid
是
Chrome 设备。MEID 通常用于将设备添加到无线运营商的
后付费服务计划。要导出 MEID 列表,请使用以下 GET
请求和
nextPageToken
值,以检索完整的 MEID 列表。为确保可读性,
代码示例包含行返回:
GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/ devices/chromeos?fields=nextPageToken,chromeosdevices(meid)
检索 Chrome 设备
要检索 Chrome 设备的属性,请使用以下 GET
请求和
包含
向请求授权。为了方便阅读
此代码示例包含行返回:
GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/ devices/chromeos/deviceId?projection={FULL|BASIC}
customerId
是客户的 Google 账号的唯一标识符。- 作为账号管理员,您还可以使用字符串
my_customer
, 代表您账号的customerId
。获取customerId
的其他方法 值是使用检索用户 操作。使用您的管理员电子邮件地址或管理员唯一身份用户id
userKey
path 参数中的值。 deviceId
是设备的唯一标识符,可在 检索所有 Chrome 设备操作。
有关查询字符串、请求和响应属性的信息,请参阅 API 参考文档。
JSON 请求
请求示例。为确保可读性,此代码示例使用了行返回:GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/ chromeos/deviceId?projection=full
JSON 响应
成功的请求会返回 HTTP 200 状态代码。以及 状态代码,则响应将返回 Chrome 设备属性:
{ "kind": "directory#chromeosdevice", "deviceId": "device_id_value", "serialNumber": "device_serial_number", "status": "ACTIVE", "lastSync": "2012-04-05T17:30:04.325Z", "supportEndDate": "2014-04-05T17:30:04.325Z", "annotatedUser": "help desk", "annotatedLocation": "Mountain View help desk Chromebook", "annotatedAssetId": "12345667890", "notes": "Loaned from support", "orderNumber": "123456", "willAutoRenew": true, "osVersion": "Browser Version 18.0", "platformVersion": "Platform Version 1415.2.0", "firmwareVersion": "Firmware Version 1.2.3.4", "bootMode": "validated" "lastEnrollmentTime": "2012-04-05T17:30:04.325Z", "orgUnitPath": "corp/engineering" }
更新 Chrome 设备
要更新 Chrome 设备,请使用以下 PUT
请求并在请求中包含
中描述的授权
向请求授权。为了方便阅读
此代码示例包含行返回:
PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/ devices/chromeos/deviceId?projection={FULL|BASIC}
customerId
是客户的 Google 账号的唯一标识符。- 作为账号管理员,您还可以使用字符串
my_customer
, 代表您账号的customerId
。获取customerId
的其他方法 值是使用检索用户 操作。使用您的管理员电子邮件地址或管理员唯一身份用户id
userKey
path 参数中的值。 deviceId
是设备的唯一标识符,可在 检索所有 Chrome 设备操作。
有关查询字符串、请求和响应属性的信息,请参阅 API 参考文档。
JSON 请求
以下示例 JSON 请求会更新 Chrome 设备的 annotatedUser
,
annotatedLocation
、annotatedAssetId
、notes
和
orgUnitPath
属性。为确保可读性,此代码示例使用了行返回:
PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos/deviceId?projection=full请求正文示例:
{
"deviceId": "device_id_value",
"annotatedUser": "help desk",
"annotatedLocation": "Mountain View help desk Chromebook",
"annotatedAssetId": "1234567890",
"notes": "Loaned from support",
"orgUnitPath": "/corp/sales"
}
对于更新请求,请仅在请求中包含具有更新值的属性。
成功的请求会返回 HTTP 200 状态代码。以及 状态代码,则响应会返回已更新 Chrome 设备的属性。
取消配置或停用 Chrome 设备
要取消配置或停用 Chrome 设备,请使用以下 POST
请求
并附上
向请求授权。为了方便阅读
此代码示例包含行返回:
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/ devices/chromeos:batchChangeStatus
customerId
是客户的 Google 账号的唯一标识符。- 作为账号管理员,您还可以使用字符串
my_customer
, 代表您账号的customerId
。获取customerId
的其他方法 值是使用检索用户 操作。使用您的管理员电子邮件地址或管理员唯一身份用户id
userKey
path 参数中的值。
有关请求和响应属性,请参阅 API 参考文档。
JSON 请求
以下 JSON 请求展示了一个取消配置和停用的示例请求 Chrome 设备:
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos:batchChangeStatus取消配置示例的请求正文如下:
{ "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"], "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION", "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE" }停用的请求正文为:
{ "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"], "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE", }
成功的请求会返回 HTTP 200 状态代码。
将 Chrome 设备移至组织部门
要将最多 50 台 Chrome 设备移至某个组织部门,请使用以下设置
POST
请求中,并附上
向请求授权。为了方便阅读
此代码示例包含行返回:
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
customerId
是客户的 Google 账号的唯一标识符。- 作为账号管理员,您还可以使用字符串
my_customer
, 代表您账号的customerId
。获取customerId
的其他方法 使用检索 user 操作。使用管理员电子邮件地址或管理员唯一身份用户 操作的userKey
路径参数中的id
值。
有关请求和响应属性,请参阅 API 参考文档。
JSON 请求
以下 JSON 请求显示了一个将 3 台 Chrome 设备移至
名为“/Marketing
”的组织部门:
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos/chromeos/moveDevicesToOu?orgUnitPath=/Marketing
设备移动的请求正文如下:
{ "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"] }
成功的请求会返回 HTTP 200 状态代码。