Directory API：ChromeOS 设备

检索账号的所有 ChromeOS 设备

如需返回分配给账号的所有 ChromeOS 设备的列表，请使用以下 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 值的另一种方法是使用获取用户操作。在该操作的 userKey 路径参数中，使用您的管理员电子邮件地址或管理员唯一用户 id 值。

如需了解查询字符串、请求和响应属性，请参阅 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 是 ChromeOS 设备中 3G 移动卡的移动设备标识符 (MEID)。在将设备添加到无线运营商的后付款服务计划时，通常需要 MEID。如需导出 MEID 列表，请使用以下 GET 请求和 nextPageToken 值检索完整的 MEID 列表。为了方便阅读，此代码示例使用回车断行： 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?fields=nextPageToken,chromeosdevices(meid)

检索 ChromeOS 设备

如需检索 ChromeOS 设备的属性，请使用以下 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 值的另一种方法是使用获取用户操作。在该操作的 userKey 路径参数中，使用您的管理员电子邮件地址或管理员唯一用户 id 值。
  • deviceId 是设备的唯一标识符，可在检索所有 ChromeOS 设备操作的响应中找到。

如需了解查询字符串、请求和响应属性，请参阅 API 参考文档。

JSON 请求

请求示例。为了方便阅读，此代码示例使用回车断行： 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

JSON 响应

成功的请求会返回 HTTP 200 状态代码。除了状态代码以外，响应还会返回 ChromeOS 设备属性： 

{
  "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"
}

更新 ChromeOS 设备

如需更新 ChromeOS 设备，请使用以下 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 值的另一种方法是使用获取用户操作。在该操作的 userKey 路径参数中，使用您的管理员电子邮件地址或管理员唯一用户 id 值。
  • deviceId 是设备的唯一标识符，可在检索所有 ChromeOS 设备操作的响应中找到。

如需了解查询字符串、请求和响应属性，请参阅 API 参考文档。

JSON 请求

以下 JSON 请求示例会更新 ChromeOS 设备的 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 状态代码。除了状态代码以外，响应还会返回已更新的 ChromeOS 设备的属性。

取消配置或停用 ChromeOS 设备

如需停用或停用 ChromeOS 设备，请使用以下 POST 请求，并包含为请求授权中所述的授权。为了方便阅读，此代码示例使用回车断行： 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/
devices/chromeos:batchChangeStatus

  • customerId 是客户 Google 账号的唯一标识符。
  • 作为账号管理员，您还可以使用字符串 my_customer，它可用于表示您账号的 customerId。获取 customerId 值的另一种方法是使用获取用户操作。在该操作的 userKey 路径参数中，使用您的管理员电子邮件地址或管理员唯一用户 id 值。

如需了解请求和响应属性，请参阅 API 参考文档。

JSON 请求

以下 JSON 请求显示了用于停用和停用 ChromeOS 设备的示例请求： 

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 状态代码。

将 ChromeOS 设备移至组织部门

如需将最多 50 台 ChromeOS 设备移至某个组织部门，请使用以下 POST 请求，并在其中添加授权请求中所述的授权。为了方便阅读，此代码示例使用回车断行： 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId 是客户 Google 账号的唯一标识符。
  • 作为账号管理员，您还可以使用字符串 my_customer，它可用于表示您账号的 customerId。获取 customerId 值的另一种方法是使用获取用户操作。在该操作的 userKey 路径参数中，使用您的管理员电子邮件地址或管理员唯一用户 id 值。

如需了解请求和响应属性，请参阅 API 参考文档。

JSON 请求

以下 JSON 请求显示了将 3 台 ChromeOS 设备移至名为 /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 状态代码。