Method: chromeosdevices.list

检索账号中的 Chrome 操作系统设备的分页列表。

HTTP 请求

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

客户的 Google Workspace 账号的唯一 ID。作为账号管理员，您还可以使用 my_customer 别名来表示您账号的 customerId。customerId 也会作为用户资源的一部分返回。

查询参数

参数
maxResults

integer

页面中结果的数量上限。值不得超过 300。
orderBy

enum (OrderBy)

用于对结果进行排序的设备属性。
orgUnitPath

string

组织部门的完整路径（不含开头的 /）或其唯一 ID。
pageToken

string

pageToken 查询参数用于请求下一页查询结果。后续请求的 pageToken 查询参数是上一个响应中的 nextPageToken。
projection

enum (Projection)

确定响应是否包含完整的属性列表，还是仅包含部分属性。
query

string

搜索字符串，格式如 chromeosdevices.list 查询运算符中所述。
sortOrder

enum (SortOrder)

是按升序还是降序返回结果。必须与 orderBy 参数搭配使用。
includeChildOrgunits

boolean

返回所有子组织部门以及指定组织部门中的设备。如果此字段设置为 true，则必须提供“orgUnitPath”。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "kind": string,
  "etag": string,
  "chromeosdevices": [
    {
      object (ChromeOsDevice)
    }
  ],
  "nextPageToken": string
}
字段
kind

string

资源的类型。
etag

string

资源的 ETag。
chromeosdevices[]

object (ChromeOsDevice)

Chrome 操作系统设备对象的列表。
nextPageToken

string

用于访问相应结果的下一页的令牌。如需访问下一页，请在此请求的 pageToken 查询字符串中使用此令牌的值。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/admin.directory.device.chromeos
  • https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly

如需了解详情，请参阅授权指南。

OrderBy

枚举
ANNOTATED_LOCATION 管理员注释的 Chrome 设备位置。
ANNOTATED_USER 管理员注释的 Chromebook 用户。
LAST_SYNC Chrome 设备上次与管理控制台中的政策设置进行同步的日期和时间。
NOTES 管理员注释的 Chrome 设备备注。
SERIAL_NUMBER 启用设备时输入的 Chrome 设备序列号。
STATUS Chrome 设备状态。如需了解详情，请参阅 <a chromeosdevices。

投影

要为设备显示的投影类型。

枚举
BASIC 仅包含基本元数据字段（例如 deviceId、serialNumber、status 和 user）
FULL 包含所有元数据字段

SortOrder

应应用于设备列表的排序顺序。

枚举
ASCENDING 升序。
DESCENDING 降序。