物件

公司參考資料

供識別公司的專屬 ID。

欄位名稱 資料類型 說明
companyId string 僅供輸出。由伺服器指派的公司 ID。
vendor enum Samsung 或 Google。

公司

代表公司。

欄位名稱 資料類型 說明
companyReference object(CompanyReference) 公司參考物件。
companyName string 公司名稱。例如「XYZ 公司」，顯示在公司員工的零接觸註冊機制入口網站上。
vendorParams map 供應商指定鍵/值組合中的額外欄位。

裝置

註冊的 Android 裝置。

欄位名稱 資料類型 說明
deviceId string 僅供輸出。由伺服器指派的裝置 ID。
deviceIdentifier object(DeviceIdentifier) 用於識別製造裝置的硬體 ID。
customer object(CompanyReference) 公司 ID，用以識別裝置的指派公司。
orderNumber string 訂單號碼。
vendorParams map 供應商指定鍵/值組合中的額外欄位。

裝置識別碼

封裝硬體和產品 ID，以識別製造商的裝置。

Samsung 裝置需要下列「一個」欄位：

  • IMEI
  • serialNumber
  • meid

系統會忽略所有其他欄位 (例如 model)。

所有其他 Android 裝置：

  • 行動數據裝置需要 imei 和 manufacturer。
  • 僅限 WiFi 裝置需要 serialNumber、manufacturer 和 model。
欄位名稱 資料類型 說明
imei string 裝置的 IMEI 號碼。輸入時已通過驗證。
serialNumber string 裝置的製造商序號。這個值可能因不同的裝置型號而異。
meid string 裝置的 MEID 號碼。
manufacturer string 裝置製造商的名稱。與 android.os.Build.MANUFACTURER 傳回的裝置內建值相符。允許的值列於製造商中。
model string 裝置型號名稱。與 android.os.Build.MODEL 傳回的裝置內建值相符。允許的值列於模型中。

Operation

這項資源包含非同步 API 呼叫的狀態。有四種可能的狀態：

  • IN_PROGRESS：作業執行中。
  • COMPLETE：已成功處理所有裝置。
  • COMPLETE_WITH_ERRORS：作業已處理完成，但發生某些錯誤。所有錯誤都會列在 deviceErrors 清單中。
  • FAILED：作業失敗，而且不會傳回 operationId。
欄位名稱 資料類型 說明
operationId string 作業 ID 加上 samsung/ 或 google/ 前置字串。如果空白，state 為 FAILED。
operationType enum(operationType) 作業類型：CLAIM_DEVICES 或 UNCLAIM_DEVICES。
state enum(operationState) 作業狀態：IN_PROGRESS、COMPLETE、COMPLETE_WITH_ERRORS、FAILED。
deviceErrors 「object(」清單DeviceOperationError) 裝置作業錯誤清單。
vendorParams map 供應商指定鍵/值組合中的額外欄位。

裝置作業錯誤

Operation 中的裝置專屬錯誤。每個資源都包含與啟動作業要求相同的 deviceId 和 deviceIdentifier。

欄位名稱 資料類型 說明
deviceId string 僅供輸出。由伺服器指派的裝置 ID。
deviceIdentifier object(DeviceIdentifier) 用於識別製造裝置的硬體 ID。
error object(Error) 裝置作業錯誤。

常見例外狀況

所有同步 API 都會擲回的例外狀況。

資源名稱 值 說明
error object(Error) 同步處理作業錯誤。

錯誤

包含錯誤詳細資料的物件。

資源名稱 值 說明
code enum(ErrorCode) 錯誤代碼。例如，INVALID_REQUESET 或 PERMISSION_DENIED
message string 錯誤訊息。
vendorMsg string 供應商錯誤的詳細說明。
errorId string 內部錯誤識別碼。
vendorParams map 供應商指定鍵/值組合中的額外欄位。

ErrorCode

常見錯誤。

列舉 說明
INVALID_PARAM_DEFAULT 未指定無效的輸入參數。詳情請查看供應商 Msg。
INVALID_PAGE_TOKEN 提供的 pageToken 無效。
INVALID_CUSTOMER_ID 您提供的客戶 ID 無效。
INVALID_DEVICE_IMEI IMEI 無效，
INVALID_DEVICE_MEID MEID 無效。
INVALID_DEVICE_SERIAL 序號無效。
INVALID_OPERATION_ID 提供的運算 ID 無效。
INVALID_RESELLER_ID 提供的 resellerId 無效。
INVALID_MANUFACTURER 提供的製造商無效 / 不支援。
INVALID_IDENTIFIER_SET 您提供的 ID 不足以處理此要求。如要進一步瞭解允許的 ID 組合，請參閱 DeviceIdentifier。
INVALID_MODEL 提供的模型無效 / 不受支援。
INVALID_DEVICE_ID 您提供的 deviceId 無效。
INVALID_DEVICE 提供的裝置不存在。這是 Samsung 專屬的錯誤代碼。
DUPLICATE_DEVICE 該裝置先前已向同一位客戶提出聲明。不需要修正。
DEVICE_UPLOAD_COUNT_EXCEEDED 要求含有的裝置超過上限 (目前為 100k)。
AUTHORIZATION_FAIL 您沒有存取特定資源 (例如裝置、客戶) 或資源不存在。詳情請查看 vendorMsg。
INTERNAL_SERVER_ERROR 未指定內部伺服器錯誤。詳情請查看 providerMsg。並根據伺服器錯誤的性質來重試這些要求。
NOT_IMPLEMENTED 伺服器不支援此要求方法。