物体

CompanyReference

唯一标识公司。

字段名称 数据类型 说明
companyId string 仅限输出。公司 ID,由服务器分配。
vendor enum SamsungGoogle

公司

代表公司。

字段名称 数据类型 说明
companyReference object(CompanyReference) 公司引用对象。
companyName string 公司的名称。例如 XYZ Corp。在零触摸注册门户网站中向公司的员工显示。
vendorParams map 供应商指定的键值对中的额外字段。

设备

一台已注册注册的 Android 设备。

字段名称 数据类型 说明
deviceId string 仅限输出。设备的 ID,由服务器分配。
deviceIdentifier object(DeviceIdentifier) 用于标识制造完成的设备的硬件 ID。
customer object(CompanyReference) 公司 ID,用于标识设备分配给哪个公司。
orderNumber string 订单号。
vendorParams map 供应商指定的键值对中的额外字段。

设备标识符

封装硬件 ID 和产品 ID 以标识制造商的设备。

三星设备需要填写以下字段之一:

  • IMEI
  • serialNumber
  • meid

所有其他字段(如 model)都会被忽略。

对于所有其他 Android 设备:

  • 移动设备需要 imeimanufacturer
  • 仅支持 Wi-Fi 的设备需要具备 serialNumbermanufacturermodel 权限。
字段名称 数据类型 说明
imei string 设备的 IMEI 识别码。根据输入进行验证。
serialNumber string 设备的制造商序列号。此值在不同设备型号之间可能不是唯一的。
meid string 设备的 MEID 号。
manufacturer string 设备制造商的名称。匹配从 android.os.Build.MANUFACTURER 返回的设备内置值。制造商中列出了允许的值。
model string 设备型号的名称。匹配从 android.os.Build.MODEL 返回的设备内置值。模型中列出了允许的值。

操作

此资源包含异步 API 调用的状态。共有四种 可能的状态:

  • IN_PROGRESS:操作正在进行中。
  • COMPLETE:所有设备都已成功处理。
  • COMPLETE_WITH_ERRORS:操作已处理,但出现了一些错误。deviceErrors 列表中列出了所有错误。
  • FAILED:操作失败,未返回任何 operationId
字段名称 数据类型 说明
operationId string 操作 ID,带有 samsung/google/ 前缀。如果为空,则 stateFAILED
operationType enum(operationType) 操作类型:CLAIM_DEVICESUNCLAIM_DEVICES
state enum(operationState) 操作状态:IN_PROGRESSCOMPLETECOMPLETE_WITH_ERRORSFAILED
deviceErrors object(DeviceOperationError)的列表 设备操作错误列表。
vendorParams map 供应商指定的键值对中的额外字段。

DeviceOperationError

Operation 中出现的设备特定错误。每项资源都包含 deviceIddeviceIdentifier 作为启动操作的请求。

字段名称 数据类型 说明
deviceId string 仅限输出。设备的 ID,由服务器分配。
deviceIdentifier object(DeviceIdentifier) 用于标识制造完成的设备的硬件 ID。
error object(Error) 设备操作错误。

CommonException

可由所有同步 API 抛出的异常。

属性名称 说明
error object(Error) 同步操作错误。

错误

包含错误详细信息的对象。

属性名称 说明
code enum(ErrorCode) 错误代码。例如 INVALID_REQUESETPERMISSION_DENIED
message string 错误消息。
vendorMsg string 供应商提供的错误的详细说明。
errorId string 内部错误标识符。
vendorParams map 供应商指定的键值对中的额外字段。

ErrorCode

常见错误。

枚举 说明
INVALID_PARAM_DEFAULT 未指定的无效输入参数。请查看 vendorMsg,了解详情。
INVALID_PAGE_TOKEN 提供的 pageToken 无效。
INVALID_CUSTOMER_ID 提供的 customerId 无效。
INVALID_DEVICE_IMEI IMEI 无效。
INVALID_DEVICE_MEID MEID 无效。
INVALID_DEVICE_SERIAL 序列号无效。
INVALID_OPERATION_ID 提供的 actionId 无效。
INVALID_RESELLER_ID 提供的 resellerId 无效。
INVALID_MANUFACTURER 提供的制造商无效 / 不受支持。
INVALID_IDENTIFIER_SET 所提供的这组标识符不足以满足相应请求。如需详细了解允许的标识符集,请参阅 DeviceIdentifier
INVALID_MODEL 提供的模型无效 / 不受支持。
INVALID_DEVICE_ID 提供的 deviceId 无效。
INVALID_DEVICE 所提供的设备不存在。这是三星特定错误代码。
DUPLICATE_DEVICE 设备先前已声明给同一客户。无需采取纠正措施。
DEVICE_UPLOAD_COUNT_EXCEEDED 请求包含的设备数量已超过上限(目前为 100k)。
AUTHORIZATION_FAIL 您无权访问指定资源(例如设备、客户),或该资源不存在。如需了解详情,请查看 vendorMsg
INTERNAL_SERVER_ERROR 未指定的内部服务器错误。请查看 vendorMsg,了解更多详情。您可以根据服务器错误的性质来重试这些请求。
NOT_IMPLEMENTED 服务器不支持该请求方法。