物件

CompanyReference

專門用於識別公司。

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

公司

代表公司。

欄位名稱 資料類型 說明
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，以便識別製造商裝置。

Samsung 裝置的必須滿足下列其中一個欄位：

  • IMEI
  • serialNumber
  • meid

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

所有其他 Android 裝置：

  • 行動數據裝置需要 imei 和 manufacturer。
  • 僅支援 Wi-Fi 的裝置需要 serialNumber、manufacturer 和 model。
欄位名稱 資料類型 說明
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/。如果空白，state 為 FAILED。
operationType enum(operationType) 作業類型：CLAIM_DEVICES 或 UNCLAIM_DEVICES。
state enum(operationState) 作業狀態：IN_PROGRESS、COMPLETE、COMPLETE_WITH_ERRORS、FAILED。
deviceErrors object(DeviceOperationError)的清單 裝置作業錯誤清單。
vendorParams map 供應商指定鍵/值組合中的額外欄位。

DeviceOperationError

Operation 中發生的裝置錯誤。每項資源都包含 deviceId 和 deviceIdentifier 做為啟動作業的要求。

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

CommonException

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

屬性名稱 值 說明
error object(Error) 同步作業錯誤。

錯誤

包含錯誤詳情的物件。

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

ErrorCode

常見錯誤。

列舉 說明
INVALID_PARAM_DEFAULT 指定的輸入參數無效。詳情請參考供應商的訊息。
INVALID_PAGE_TOKEN 提供的 pageToken 無效。
INVALID_CUSTOMER_ID 提供的 customerId 無效。
INVALID_DEVICE_IMEI IMEI 無效。
INVALID_DEVICE_MEID MEID 無效。
INVALID_DEVICE_SERIAL 序號無效。
INVALID_OPERATION_ID 提供的 OperationId 無效。
INVALID_RESELLER_ID 提供的經銷商 ID 無效。
INVALID_MANUFACTURER 提供的製造商無效 / 不支援。
INVALID_IDENTIFIER_SET 提供的 ID 組合不足以處理要求。如要進一步瞭解允許的 ID 組合，請參閱 DeviceIdentifier。
INVALID_MODEL 提供的型號無效 / 不受支援。
INVALID_DEVICE_ID 您提供的 deviceId 無效。
INVALID_DEVICE 提供的裝置不存在。這是 Samsung 專用的錯誤代碼。
DUPLICATE_DEVICE 這部裝置先前已領取給同一位客戶。不需要修正。
DEVICE_UPLOAD_COUNT_EXCEEDED 要求包含的裝置數量超出上限 (目前為 10 萬裝置)。
AUTHORIZATION_FAIL 您無權存取特定資源 (例如裝置、客戶)，或是資源不存在。詳情請前往 vendorMsg。
INTERNAL_SERVER_ERROR 不明內部伺服器錯誤。如需更多資訊，請參閱供應商 Msg。視伺服器錯誤的性質而定，可以重試這些要求。
NOT_IMPLEMENTED 伺服器不支援該要求方法。