Nesneler

CompanyReference

Bir şirketi benzersiz bir şekilde tanımlar.

Alan adı Veri türü Açıklama
companyId string Yalnızca çıkış. Sunucu tarafından atanan, şirketin kimliği.
vendor enum Samsung veya Google.

Şirket

Bir şirketi temsil eder.

Alan adı Veri türü Açıklama
companyReference object(CompanyReference) Şirket referansı nesnesi.
companyName string Şirketin adı. Örneğin, XYZ Corp. El değmeden kayıt portalında şirket çalışanlarına gösterilir.
vendorParams map Tedarikçi firma tarafından belirtilen anahtar/değer çiftlerinde fazladan alanlar.

Cihaz

Kayıt için kaydedilmiş bir Android cihaz.

Alan adı Veri türü Açıklama
deviceId string Yalnızca çıkış. Cihazın sunucu tarafından atanan kimliği.
deviceIdentifier object(DeviceIdentifier) üretilmiş bir cihazı tanımlayan donanım kimlikleri.
customer object(CompanyReference) Cihazların hangi şirkete atandığını tanımlayan şirket kimlikleri.
orderNumber string Sipariş numarası.
vendorParams map Tedarikçi firma tarafından belirtilen anahtar/değer çiftlerinde fazladan alanlar.

DeviceIdentifier

Üreticinin cihazını tanımlamak için donanım ve ürün kimliklerini içerir.

Samsung cihazlar için aşağıdaki alanlardan biri gereklidir:

  • IMEI
  • serialNumber
  • meid

Diğer tüm alanlar (ör. model) yoksayılır.

Diğer tüm Android cihazlar için:

  • Hücresel veri için imei ve manufacturer gerekir.
  • Yalnızca kablosuz bağlantı kullanan cihazlar için serialNumber, manufacturer ve model gereklidir.
Alan adı Veri türü Açıklama
imei string Cihazın IMEI numarası. Girişte doğrulandı.
serialNumber string Cihaz üreticinin seri numarası. Bu değer, farklı cihaz modellerinde benzersiz olmayabilir.
meid string Cihazın MEID numarası.
manufacturer string Cihaz üreticisinin adı. Cihazın android.os.Build.MANUFACTURER öğesinden döndürülen yerleşik değeriyle eşleşir. İzin verilen değerler üreticiler listesinde listelenmiştir.
model string Cihaz modelinin adı. Cihazın android.os.Build.MODEL öğesinden döndürülen yerleşik değeriyle eşleşir. İzin verilen değerler modeller bölümünde listelenir.

İşlem

Bu kaynak, eşzamansız bir API çağrısının durumunu içerir. Dört adet olası durumlar:

  • IN_PROGRESS: İşlem devam ediyor.
  • COMPLETE: Tüm cihazlar başarıyla işlendi.
  • COMPLETE_WITH_ERRORS: İşlem işlendi, ancak bazı hatalar oluştu. Tüm hatalar deviceErrors listesinde listelenir.
  • FAILED: İşlem başarısız oldu ve operationId döndürülmedi.
Alan adı Veri türü Açıklama
operationId string samsung/ veya google/ ön ekine sahip işlem kimliği. Boşsa state değeri FAILED olur.
operationType enum(operationType) İşlem türü: CLAIM_DEVICES veya UNCLAIM_DEVICES.
state enum(operationState) İşlem durumu: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors object(DeviceOperationError) listesi Cihaz işlem hatalarının listesi.
vendorParams map Tedarikçi firma tarafından belirtilen anahtar/değer çiftlerinde fazladan alanlar.

DeviceOperationError

Operation içinde cihaza özel hata. Her kaynak aynı İşlemi başlatan istek olarak deviceId ve deviceIdentifier.

Alan adı Veri türü Açıklama
deviceId string Yalnızca çıkış. Cihazın sunucu tarafından atanan kimliği.
deviceIdentifier object(DeviceIdentifier) üretilmiş bir cihazı tanımlayan donanım kimlikleri.
error object(Error) Cihaz işlem hatası.

CommonException

Tüm eşzamanlı API'ler tarafından atılabilecek bir istisna.

Mülk adı Değer Açıklama
error object(Error) Eşzamanlı işlem hatası.

Hata

Bir hatayla ilgili ayrıntıları içeren nesne.

Mülk adı Değer Açıklama
code enum(ErrorCode) Hata kodu. Örneğin, INVALID_REQUESET veya PERMISSION_DENIED
message string Hata mesajı.
vendorMsg string Tedarikçi firmadan alınan hatanın ayrıntılı açıklaması.
errorId string Dahili hata tanımlayıcısı.
vendorParams map Tedarikçi firma tarafından belirtilen anahtar/değer çiftlerinde fazladan alanlar.

ErrorCode

Sık karşılaşılan hatalar.

Enum Açıklama
INVALID_PARAM_DEFAULT Belirtilmemiş geçersiz giriş parametresi. Daha fazla ayrıntı için merchantMsg'ye bakın.
INVALID_PAGE_TOKEN Sağlanan pageToken geçersiz.
INVALID_CUSTOMER_ID Sağlanan customerId geçersiz.
INVALID_DEVICE_IMEI Geçersiz IMEI.
INVALID_DEVICE_MEID Geçersiz MEID.
INVALID_DEVICE_SERIAL Geçersiz seri numarası.
INVALID_OPERATION_ID Sağlanan transactionId geçersiz.
INVALID_RESELLER_ID Sağlanan bayi kimliği geçersiz.
INVALID_MANUFACTURER Sağlanan üretici geçersiz / desteklenmiyor.
INVALID_IDENTIFIER_SET Sağlanan tanımlayıcı grubu istek için yeterli değil. İzin verilen tanımlayıcı grupları hakkında daha fazla bilgi için DeviceIdentifier sayfasına bakın.
INVALID_MODEL Sağlanan model geçersiz / desteklenmiyor.
INVALID_DEVICE_ID Sağlanan deviceId geçersiz.
INVALID_DEVICE Sağlanan cihaz mevcut değil. Bu hata kodu Samsung'a özgüdür.
DUPLICATE_DEVICE Cihaz için daha önce aynı müşteri için hak talebinde bulunulmuştu. Düzeltici bir işlem yapmanız gerekmez.
DEVICE_UPLOAD_COUNT_EXCEEDED İstek, sınırın üzerinde cihaz içeriyor (şu anda 100 bin).
AUTHORIZATION_FAIL Belirli bir kaynağa (ör. cihaz, müşteri) erişiminiz yok veya söz konusu kaynak mevcut değil. Daha fazla bilgi için vendorMsg inceleyin.
INTERNAL_SERVER_ERROR Belirtilmemiş dahili sunucu hatası. Daha fazla ayrıntı için merchantMsg'ye bakın. Bu istekler, sunucu hatasının niteliğine bağlı olarak yeniden denenebilir.
NOT_IMPLEMENTED İstek yöntemi sunucu tarafından desteklenmiyor.