Method: mobiledevices.list

检索账号中用户拥有的所有移动设备的分页列表。如要检索包含公司自有设备的列表,请改用 Cloud Identity Devices API。此方法会在 60 分钟后超时。如需了解详情,请参阅对错误代码进行问题排查

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

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

查询参数

参数
maxResults

integer

返回的结果数上限。允许的最大值为 100。

orderBy

enum (OrderBy)

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

pageToken

string

用于指定列表中下一页的令牌

projection

enum (Projection)

限制返回一组所选字段的信息。

query

string

采用 https://developers.google.com/admin-sdk/directory/v1/search-operators 中所指定的格式搜索字符串

sortOrder

enum (SortOrder)

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

请求正文

请求正文必须为空。

响应正文

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

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

string

此资源的种类。

etag

string

资源的 ETag。

mobiledevices[]

object (MobileDevice)

移动设备对象的列表。

nextPageToken

string

用于访问此结果的下一页的令牌。

授权范围

需要以下 OAuth 范围之一:

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

有关详情,请参阅授权指南

OrderBy

枚举
DEVICE_ID Google Sync 移动设备的序列号。对于 Android 设备,这是软件生成的唯一标识符。
EMAIL 设备所有者的电子邮件地址。
LAST_SYNC 设备的上次政策设置同步日期时间。
MODEL 移动设备的型号。
NAME 设备所有者的用户名。
OS 设备的操作系统。
STATUS 设备状态。
TYPE 设备类型。

投影

枚举
BASIC 仅包含基本元数据字段(例如 deviceId、model、status、type 和 status)
FULL 包含所有元数据字段

SortOrder

枚举
ASCENDING 升序。
DESCENDING 降序。