企業参照
会社を一意に識別します。
フィールド名 | データ型 | 説明 |
---|---|---|
companyId |
string |
出力のみ。サーバーによって割り当てられた会社の ID。 |
vendor |
enum |
Samsung または Google |
Company
会社を表します。
フィールド名 | データ型 | 説明 |
---|---|---|
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 から返されたデバイスの組み込み値と一致します。指定できる値については、メーカーのリストをご覧ください。 |
model |
string |
デバイスモデルの名前。android.os.Build.MODEL から返されたデバイスの組み込み値と一致します。使用可能な値は、モデルに記載されています。 |
オペレーション
このリソースには、非同期 API 呼び出しのステータスが含まれています。ステータスには次の 4 つがあります。
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 |
ベンダー指定の Key-Value ペアの追加フィールド。 |
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 |
内部エラー識別子。 |
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 |
指定された識別子のセットではリクエストを行うことができません。使用可能な識別子のセットについて詳しくは、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 |
リクエスト メソッドはサーバーによってサポートされていません。 |