オブジェクト

CompanyReference

会社を一意に識別します。

フィールド名 データ型 説明
companyId string 出力専用。サーバーによって割り当てられた会社の ID。
vendor enum Samsung または Google

会社

会社を表します。

フィールド名 データ型 説明
companyReference object(CompanyReference) 会社参照オブジェクト。
companyName string 会社の名前。（例: XYZ Corp）。ゼロタッチ登録ポータルで会社の従業員に表示されます。
vendorParams map ベンダー指定の Key-Value ペアの追加フィールド。

デバイス

登録用に登録された Android デバイス。

フィールド名 データ型 説明
deviceId string 出力専用。サーバーによって割り当てられたデバイスの ID。
deviceIdentifier object(DeviceIdentifier) 製造されたデバイスを識別するハードウェア ID。
customer object(CompanyReference) デバイスが割り当てられている会社を識別する会社 ID。
orderNumber string 注文番号。
vendorParams map ベンダー指定の Key-Value ペアの追加フィールド。

DeviceIdentifier

メーカーのデバイスを識別するために、ハードウェア ID とプロダクト 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 から返されたデバイスの組み込み値と一致します。使用可能な値のリストは manufacturers にあります。
model string デバイスのモデル名。android.os.Build.MODEL から返されたデバイスの組み込み値と一致します。使用可能な値のリストはモデルに記載されています。

オペレーション

このリソースには、非同期 API 呼び出しのステータスが含まれます。4 つの ステータスは次のとおりです。

  • IN_PROGRESS: オペレーションは進行中です。
  • COMPLETE: すべてのデバイスが正常に処理されました。
  • COMPLETE_WITH_ERRORS: オペレーションは処理されましたが、いくつかのエラーが発生しました。すべてのエラーが deviceErrors リストに表示されます。
  • FAILED: オペレーションは失敗し、operationId は返されません。
フィールド名 データ型 説明
operationId string samsung/ または google/ で始まるオペレーション ID。空の場合、state は FAILED です。
operationType enum(operationType) オペレーション タイプ: CLAIM_DEVICES または UNCLAIM_DEVICES。
state enum(operationState) オペレーションの状態: IN_PROGRESS、COMPLETE、COMPLETE_WITH_ERRORS、FAILED。
deviceErrors object(DeviceOperationError) のリスト デバイス操作エラーのリスト。
vendorParams map ベンダー指定の Key-Value ペアの追加フィールド。

DeviceOperationError

Operation のデバイス固有のエラー。各リソースには、同じ Pod 構成が 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 ベンダー指定の Key-Value ペアの追加フィールド。

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 指定された操作 ID が無効です。
INVALID_RESELLER_ID 指定された resellerId が無効です。
INVALID_MANUFACTURER 指定されたメーカーが無効であるか、サポートされていません。
INVALID_IDENTIFIER_SET 指定された ID のセットではリクエストに対応できません。許可された識別子セットの詳細については、DeviceIdentifier をご覧ください。
INVALID_MODEL 指定されたモデルは無効であるか、サポートされていません。
INVALID_DEVICE_ID 指定された deviceId は無効です。
INVALID_DEVICE 指定されたデバイスは存在しません。これは Samsung 固有のエラーコードです。
DUPLICATE_DEVICE そのデバイスが以前に同じお客様に請求されている。是正措置は不要です。
DEVICE_UPLOAD_COUNT_EXCEEDED リクエストに含まれているデバイスの数が上限（現在は 10 万）を超えています。
AUTHORIZATION_FAIL 特定のリソース（デバイス、顧客など）へのアクセス権がないか、リソースが存在しません。詳しくは、vendorMsg をご覧ください。
INTERNAL_SERVER_ERROR 不明な内部サーバーエラー。vendorMsg で詳細を確認してください。サーバーエラーの性質によっては、これらのリクエストを再試行できます。
NOT_IMPLEMENTED リクエスト メソッドはサーバーでサポートされていません。