如何通过Google Admin SDK API获取Chromebook设备自定义属性？

自定义字段确实包含在Google Admin SDK Directory API的ChromeOS设备返回资源中，你未查到相关字段的核心原因是API默认返回的基础投影过滤了非标准字段，按以下步骤操作即可获取：

• 调用chromeosdevices.list（批量拉取设备）或chromeosdevices.get（查询单台设备）接口时，必须在请求参数中指定 projection=FULL，默认的BASIC投影不会返回自定义相关内容
• 自定义字段会封装在返回结构的customFields对象中，层级为customFields.[你在Admin控制台创建的自定义字段分组名].[字段Key]

请求示例 #

GET https://admin.googleapis.com/admin/directory/v1/customer/{你的客户ID}/devices/chromeos?projection=FULL

返回结构示例 #

假设你在Admin控制台创建了名为asset_info的自定义字段分组，分组下配置了asset_code、warranty_expire两个字段，返回内容参考如下：

{
  "chromeosdevices": [
    {
      "deviceId": "xxxxxx",
      "serialNumber": "XXXXXX",
      "status": "ACTIVE",
      "customFields": {
        "asset_info": {
          "asset_code": "AST-2024-0012",
          "warranty_expire": "2026-05-20"
        }
      }
    }
  ]
}

注意事项 #

• 调用账号需要拥有ChromeOS设备的读取权限，建议授权https://www.googleapis.com/auth/admin.directory.device.chromeos.readonlyScope
• 确认自定义字段在Admin控制台的配置范围覆盖了你要查询的设备所属OU

内容的提问来源于stack exchange，提问作者Systems Development