Method: enterprises.devices.issueCommand

یک دستور به یک دستگاه صادر می‌کند. منبع Operation برگردانده شده شامل یک Command در فیلد metadata خود است. از متد get operation برای دریافت وضعیت دستور استفاده کنید.

درخواست HTTP

POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
name

string

نام دستگاه به شکل enterprises/{enterpriseId}/devices/{deviceId} .

درخواست بدنه

بدنه درخواست شامل نمونه‌ای از Command است.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Operation است.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/androidmanagement

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

فرمان

یک فرمان.

نمایش JSON 
{
  "type": enum (CommandType),
  "createTime": string,
  "duration": string,
  "userName": string,
  "errorCode": enum (CommandErrorCode),
  "newPassword": string,
  "resetPasswordFlags": [
    enum (ResetPasswordFlag)
  ],

  // Union field params can be only one of the following:
  "clearAppsDataParams": {
    object (ClearAppsDataParams)
  },
  "startLostModeParams": {
    object (StartLostModeParams)
  },
  "stopLostModeParams": {
    object (StopLostModeParams)
  },
  "addEsimParams": {
    object (AddEsimParams)
  },
  "removeEsimParams": {
    object (RemoveEsimParams)
  },
  "requestDeviceInfoParams": {
    object (RequestDeviceInfoParams)
  },
  "wipeParams": {
    object (WipeParams)
  }
  // End of list of possible types for union field params.

  // Union field status can be only one of the following:
  "clearAppsDataStatus": {
    object (ClearAppsDataStatus)
  },
  "startLostModeStatus": {
    object (StartLostModeStatus)
  },
  "stopLostModeStatus": {
    object (StopLostModeStatus)
  },
  "esimStatus": {
    object (EsimCommandStatus)
  },
  "requestDeviceInfoStatus": {
    object (RequestDeviceInfoStatus)
  }
  // End of list of possible types for union field status.
}
فیلدها
type

enum ( CommandType )

نوع دستور.

createTime

string ( Timestamp format)

مهر زمانی که دستور در آن ایجاد شده است. مهر زمانی به طور خودکار توسط سرور تولید می‌شود.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

duration

string ( Duration format)

مدت زمانی که دستور معتبر است. اگر دستور در این مدت توسط دستگاه اجرا نشود، منقضی می‌شود. مدت زمان پیش‌فرض در صورت عدم تعیین، ده دقیقه است. حداکثر مدت زمانی وجود ندارد.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

userName

string

نام منبع کاربری که مالک دستگاه است به شکل enterprises/{enterpriseId}/users/{userId} . این نام به طور خودکار توسط سرور و بر اساس دستگاهی که دستور به آن ارسال می‌شود، تولید می‌شود.

errorCode

enum ( CommandErrorCode )

اگر دستور ناموفق باشد، یک کد خطا که علت شکست را توضیح می‌دهد. این کد زمانی که دستور توسط فراخوانی‌کننده لغو می‌شود، تنظیم نمی‌شود. برای استدلال در مورد خطاهای دستور، فیلدها را به ترتیب زیر ترجیح دهید (اولویت با فیلدهای زیر است): ۱. فیلدهای مخصوص دستور مانند clearAppsDataStatus ، startLostModeStatus یا موارد مشابه، در صورت وجود. ۲. این فیلد، در صورت تنظیم. ۳. فیلد error عمومی در Operation که دستور را در بر می‌گیرد.

newPassword

string

برای دستوراتی از نوع RESET_PASSWORD ، به صورت اختیاری رمز عبور جدید را مشخص می‌کند. توجه: در دستگاه‌های اندروید ۱۴، اگر رمز عبور جدید عددی باشد، باید حداقل ۶ کاراکتر داشته باشد. در غیر این صورت، دستور با INVALID_VALUE ناموفق خواهد بود.

resetPasswordFlags[]

enum ( ResetPasswordFlag )

برای دستوراتی از نوع RESET_PASSWORD ، به صورت اختیاری پرچم‌ها را مشخص می‌کند.

params فیلد Union. پارامترهای مختص به دستور. توجه داشته باشید که برخی از دستورات از این استفاده نمی‌کنند، به ویژه LOCK ، RESET_PASSWORD ، REBOOT و RELINQUISH_OWNERSHIP . در آینده، این دستورات نیز ممکن است از این استفاده کنند.

اگر این تنظیم شده باشد، فیلدهای new_password و reset_password_flags نباید تنظیم شوند. params فقط می‌تواند یکی از موارد زیر باشد:

clearAppsDataParams

object ( ClearAppsDataParams )

پارامترهای دستور CLEAR_APP_DATA برای پاک کردن داده‌های برنامه‌های مشخص شده از دستگاه. به ClearAppsDataParams مراجعه کنید. اگر این تنظیم شده باشد، پیشنهاد می‌شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی CLEAR_APP_DATA تنظیم می‌کند. همچنین می‌توان type به طور صریح روی CLEAR_APP_DATA تنظیم کرد.

startLostModeParams

object ( StartLostModeParams )

پارامترهای دستور START_LOST_MODE برای قرار دادن دستگاه در حالت گمشده. به StartLostModeParams مراجعه کنید. اگر این تنظیم شده باشد، پیشنهاد می‌شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی START_LOST_MODE تنظیم می‌کند. همچنین می‌توان type به طور صریح روی START_LOST_MODE تنظیم کرد.

stopLostModeParams

object ( StopLostModeParams )

پارامترهای دستور STOP_LOST_MODE برای خارج کردن دستگاه از حالت گم‌شده. به StopLostModeParams مراجعه کنید. اگر این تنظیم شده باشد، پیشنهاد می‌شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی STOP_LOST_MODE تنظیم می‌کند. همچنین می‌توان type به طور صریح روی STOP_LOST_MODE تنظیم کرد.

addEsimParams

object ( AddEsimParams )

اختیاری. پارامترهای دستور ADD_ESIM برای افزودن پروفایل eSIM به دستگاه. اگر این تنظیم شده باشد، پیشنهاد می‌شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی ADD_ESIM تنظیم می‌کند. همچنین می‌توان type به طور صریح روی ADD_ESIM تنظیم کرد.

removeEsimParams

object ( RemoveEsimParams )

اختیاری. پارامترهای دستور REMOVE_ESIM برای حذف پروفایل eSIM از دستگاه. اگر این تنظیم شده باشد، پیشنهاد می‌شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی REMOVE_ESIM تنظیم می‌کند. همچنین می‌توان type به طور صریح روی REMOVE_ESIM تنظیم کرد.

requestDeviceInfoParams

object ( RequestDeviceInfoParams )

اختیاری. پارامترهای دستور REQUEST_DEVICE_INFO برای دریافت اطلاعات مربوط به دستگاه. اگر این تنظیم شده باشد، پیشنهاد می‌شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی REQUEST_DEVICE_INFO تنظیم می‌کند. همچنین می‌توان type به طور صریح روی REQUEST_DEVICE_INFO تنظیم کرد.

wipeParams

object ( WipeParams )

اختیاری. پارامترهای دستور WIPE برای پاک کردن دستگاه. اگر این تنظیم شده باشد، پیشنهاد می‌شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی WIPE تنظیم می‌کند. همچنین می‌توان type به طور صریح روی WIPE تنظیم کرد.

فیلد status واحد. وضعیت مختص به دستور. توجه داشته باشید که برخی از دستورات از این استفاده نمی‌کنند، به ویژه LOCK ، RESET_PASSWORD ، REBOOT و RELINQUISH_OWNERSHIP . در آینده، این دستورات نیز ممکن است از این استفاده کنند. status می‌تواند فقط یکی از موارد زیر باشد:
clearAppsDataStatus

object ( ClearAppsDataStatus )

فقط خروجی. وضعیت دستور CLEAR_APP_DATA برای پاک کردن داده‌های برنامه‌های مشخص شده از دستگاه. به ClearAppsDataStatus مراجعه کنید.

startLostModeStatus

object ( StartLostModeStatus )

فقط خروجی. وضعیت دستور START_LOST_MODE برای قرار دادن دستگاه در حالت گم‌شده. به StartLostModeStatus مراجعه کنید.

stopLostModeStatus

object ( StopLostModeStatus )

فقط خروجی. وضعیت دستور STOP_LOST_MODE برای خارج کردن دستگاه از حالت گم‌شده. به StopLostModeStatus مراجعه کنید.

esimStatus

object ( EsimCommandStatus )

فقط خروجی. وضعیت یک دستور ADD_ESIM یا REMOVE_ESIM .

requestDeviceInfoStatus

object ( RequestDeviceInfoStatus )

فقط خروجی. وضعیت دستور REQUEST_DEVICE_INFO .

نوع فرمان

انواع دستورات.

انوم‌ها
COMMAND_TYPE_UNSPECIFIED این مقدار مجاز نیست.
LOCK دستگاه را قفل کنید، انگار که زمان قفل صفحه نمایش تمام شده است. برای یک پروفایل کاری، اگر قفل پروفایل کاری جداگانه‌ای وجود داشته باشد، این فقط پروفایل کاری را قفل می‌کند، با یک استثنا: در پروفایل‌های کاری روی یک دستگاه متعلق به سازمان که اندروید ۸، ۹ یا ۱۰ را اجرا می‌کند، این کل دستگاه را قفل می‌کند.
RESET_PASSWORD رمز عبور کاربر را بازنشانی کنید.
REBOOT دستگاه را مجدداً راه اندازی کنید. فقط در دستگاه‌های کاملاً مدیریت شده با اندروید ۷.۰ (سطح API ۲۴) یا بالاتر پشتیبانی می‌شود.
RELINQUISH_OWNERSHIP نمایه کاری و تمام خط‌مشی‌ها را از یک دستگاه اندروید ۸.۰+ متعلق به شرکت حذف می‌کند و دستگاه را برای استفاده شخصی واگذار می‌کند. برنامه‌ها و داده‌های مرتبط با نمایه(های) شخصی حفظ می‌شوند. دستگاه پس از تأیید دستور، از سرور حذف خواهد شد.
CLEAR_APP_DATA داده‌های برنامه‌ی مشخص‌شده را پاک می‌کند. این قابلیت در اندروید ۹ و بالاتر پشتیبانی می‌شود. توجه داشته باشید که یک برنامه می‌تواند داده‌ها را خارج از داده‌های برنامه‌ی خود، مثلاً در حافظه‌ی خارجی یا در دیکشنری کاربر، ذخیره کند. همچنین clearAppsDataParams مراجعه کنید.
START_LOST_MODE دستگاه را در حالت گمشده قرار می‌دهد. فقط در دستگاه‌های کاملاً مدیریت‌شده یا دستگاه‌های متعلق به سازمان با نمایه مدیریت‌شده پشتیبانی می‌شود. همچنین startLostModeParams مراجعه کنید.
STOP_LOST_MODE دستگاه را از حالت گم‌شده خارج می‌کند. فقط در دستگاه‌های کاملاً مدیریت‌شده یا دستگاه‌های متعلق به سازمان با نمایه مدیریت‌شده پشتیبانی می‌شود. همچنین به stopLostModeParams مراجعه کنید.
ADD_ESIM یک پروفایل eSIM به دستگاه اضافه می‌کند. این قابلیت در اندروید ۱۵ و بالاتر پشتیبانی می‌شود. همچنین به addEsimParams مراجعه کنید. برای حذف یک پروفایل eSIM، از دستور REMOVE_ESIM استفاده کنید. برای تعیین اینکه هنگام پاک شدن اطلاعات یک دستگاه، چه اتفاقی برای پروفایل eSIM می‌افتد، wipeDataFlags در خط‌مشی تنظیم کنید. توجه: برای ارائه چندین eSIM در یک دستگاه، توصیه می‌شود بین اجرای متوالی دستور، چند دقیقه تأخیر ایجاد کنید.
REMOVE_ESIM یک پروفایل eSIM را از دستگاه حذف می‌کند. این قابلیت در اندروید ۱۵ و بالاتر پشتیبانی می‌شود. همچنین removeEsimParams مراجعه کنید.
REQUEST_DEVICE_INFO درخواست اطلاعات مربوط به دستگاه.
WIPE دستگاه را از طریق تنظیم مجدد کارخانه برای دستگاه متعلق به شرکت یا با حذف نمایه کاری برای دستگاه متعلق به شخصی با نمایه کاری، پاک می‌کند. پاک کردن فقط زمانی انجام می‌شود که دستگاه دستور را تأیید کند. دستور را می‌توان قبل از آن لغو کرد.

کد خطای فرمان

یک کد خطای دستوری. این یک فیلد فقط خواندنی است که توسط سرور پر می‌شود.

انوم‌ها
COMMAND_ERROR_CODE_UNSPECIFIED هیچ خطایی وجود نداشت.
UNKNOWN خطای ناشناخته‌ای رخ داده است.
API_LEVEL سطح API دستگاه از این دستور پشتیبانی نمی‌کند.
MANAGEMENT_MODE حالت مدیریت (مالک پروفایل، مالک دستگاه و غیره) از این دستور پشتیبانی نمی‌کند.
INVALID_VALUE این دستور دارای مقدار پارامتر نامعتبر است.
UNSUPPORTED دستگاه از این دستور پشتیبانی نمی‌کند. به‌روزرسانی خط‌مشی دستگاه اندروید به آخرین نسخه ممکن است مشکل را حل کند.

پرچم رمز عبور را بازنشانی کنید

پرچم‌هایی که می‌توانند برای نوع دستور RESET_PASSWORD استفاده شوند.

انوم‌ها
RESET_PASSWORD_FLAG_UNSPECIFIED این مقدار نادیده گرفته می‌شود.
REQUIRE_ENTRY تا زمانی که کاربر رمز عبور را وارد نکرده است، به سایر مدیران اجازه تغییر مجدد رمز عبور را ندهید.
DO_NOT_ASK_CREDENTIALS_ON_BOOT هنگام بوت شدن دستگاه، اطلاعات کاربری را درخواست نکنید.
LOCK_NOW پس از تنظیم مجدد رمز عبور، دستگاه را قفل کنید.

پارامترهای ClearAppsData

پارامترهای مرتبط با دستور CLEAR_APP_DATA برای پاک کردن داده‌های برنامه‌های مشخص شده از دستگاه.

نمایش JSON 
{
  "packageNames": [
    string
  ]
}
فیلدها
packageNames[]

string

نام بسته‌های برنامه‌هایی که داده‌های آنها هنگام اجرای دستور پاک می‌شود.

پارامترهای حالت از دست رفته شروع

پارامترهای مرتبط با دستور START_LOST_MODE برای قرار دادن دستگاه در حالت گم‌شده. حداقل یکی از پارامترها، به جز نام سازمان، باید ارائه شود تا دستگاه در حالت گم‌شده قرار گیرد.

نمایش JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
فیلدها
lostMessage

object ( UserFacingMessage )

پیامی که هنگام قرار گرفتن دستگاه در حالت گم شدن به کاربر نمایش داده می‌شود.

lostPhoneNumber

object ( UserFacingMessage )

شماره تلفنی که هنگام قرار گرفتن دستگاه در حالت گم شدن و لمس دکمه تماس با مالک، با آن تماس گرفته خواهد شد.

lostEmailAddress

string

آدرس ایمیلی که هنگام قرار گرفتن دستگاه در حالت گم شدن به کاربر نمایش داده می‌شود.

lostStreetAddress

object ( UserFacingMessage )

آدرس خیابانی که وقتی دستگاه در حالت گم شدن قرار دارد به کاربر نمایش داده می‌شود.

lostOrganization

object ( UserFacingMessage )

نام سازمانی که هنگام قرار گرفتن دستگاه در حالت گم شدن به کاربر نمایش داده می‌شود.

پارامترهای StopLostMode

این نوع هیچ فیلدی ندارد.

پارامترهای مرتبط با دستور STOP_LOST_MODE برای خارج کردن دستگاه از حالت گم‌شده.

AddEsimParams

پارامترهای مرتبط با دستور ADD_ESIM برای افزودن پروفایل eSIM به دستگاه.

نمایش JSON 
{
  "activationCode": string,
  "activationState": enum (ActivationState)
}
فیلدها
activationCode

string

الزامی. کد فعال‌سازی برای پروفایل eSIM.

activationState

enum ( ActivationState )

الزامی. وضعیت فعال‌سازی پروفایل eSIM پس از دانلود آن.

حالت فعال‌سازی

وضعیت فعال‌سازی پروفایل eSIM پس از دانلود آن.

انوم‌ها
ACTIVATION_STATE_UNSPECIFIED وضعیت فعال‌سازی eSIM مشخص نشده است. این حالت پیش‌فرض، پروفایل eSIM را در دستگاه‌های شخصی NOT_ACTIVATED و در دستگاه‌های شرکتی ACTIVATED می‌گیرد.
ACTIVATED سیم‌کارت الکترونیکی (eSIM) پس از دانلود به طور خودکار فعال می‌شود. تنظیم این حالت به عنوان حالت فعال‌سازی برای دستگاه‌های شخصی منجر به رد شدن دستور خواهد شد.
NOT_ACTIVATED پروفایل eSIM دانلود شده اما فعال نشده است. در این حالت، کاربر باید eSIM را به صورت دستی روی دستگاه فعال کند.

حذف پارامترهای Esim

پارامترهای مرتبط با دستور REMOVE_ESIM برای حذف یک پروفایل eSIM از دستگاه.

نمایش JSON 
{
  "iccId": string
}
فیلدها
iccId

string

الزامی. شناسه ICC مربوط به پروفایل eSIM که باید حذف شود.

پارامترهای درخواستاطلاعات دستگاه

پارامترهای مرتبط با دستور REQUEST_DEVICE_INFO برای دریافت اطلاعات مربوط به دستگاه.

نمایش JSON 
{
  "deviceInfo": enum (DeviceInfo)
}
فیلدها
deviceInfo

enum ( DeviceInfo )

الزامی. نوع اطلاعات دستگاه مورد درخواست.

اطلاعات دستگاه

نوع اطلاعات دستگاه مورد درخواست.

انوم‌ها
DEVICE_INFO_UNSPECIFIED این مقدار مجاز نیست.
EID درخواست شناسه برای eSIM. قبل از اینکه نتیجه برگردانده شود، از کاربر خواسته می‌شود تا افشای اطلاعات را تأیید کند. اگر کاربر افشای اطلاعات را تأیید نکند، USER_DECLINED برگردانده می‌شود. این فقط برای دستگاه‌های شخصی با پروفایل‌های کاری و نسخه‌های اندروید ۱۳ و بالاتر پشتیبانی می‌شود.

وایپ‌پارامز

پارامترهای مرتبط با دستور WIPE برای پاک کردن دستگاه.

نمایش JSON 
{
  "wipeDataFlags": [
    enum (WipeDataFlag)
  ],
  "wipeReason": {
    object (UserFacingMessage)
  }
}
فیلدها
wipeDataFlags[]

enum ( WipeDataFlag )

اختیاری. پرچم‌هایی برای تعیین اینکه چه داده‌هایی باید پاک شوند.

wipeReason

object ( UserFacingMessage )

اختیاری. یک پیام کوتاه قبل از پاک کردن پروفایل کاری در دستگاه‌های شخصی به کاربر نمایش داده می‌شود. این موضوع در دستگاه‌های متعلق به شرکت تأثیری ندارد. حداکثر طول پیام ۲۰۰ کاراکتر است.

وضعیت پاک‌سازی برنامه‌ها

وضعیت دستور CLEAR_APP_DATA برای پاک کردن داده‌های برنامه‌های مشخص شده از دستگاه.

نمایش JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
فیلدها
results

map (key: string, value: object ( PerAppResult ))

نتایج هر برنامه، نگاشتی از نام بسته‌ها به نتیجه پاکسازی مربوطه.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

نتیجه هر برنامه

نتیجه تلاش برای پاک کردن داده‌های یک برنامه واحد.

نمایش JSON 
{
  "clearingResult": enum (ClearingResult)
}
فیلدها
clearingResult

enum ( ClearingResult )

نتیجه تلاش برای پاک کردن داده‌های یک برنامه واحد.

نتیجه پاکسازی

نتیجه تلاش برای پاک کردن داده‌های یک برنامه واحد.

انوم‌ها
CLEARING_RESULT_UNSPECIFIED نتیجه نامشخص.
SUCCESS اطلاعات این برنامه با موفقیت پاک شد.
APP_NOT_FOUND داده‌های این برنامه پاک نشد زیرا برنامه پیدا نشد.
APP_PROTECTED داده‌های این برنامه قابل پاک شدن نیستند زیرا برنامه محافظت شده است. برای مثال، این ممکن است در مورد برنامه‌هایی که برای عملکرد دستگاه حیاتی هستند، مانند فروشگاه Google Play، صدق کند.
API_LEVEL داده‌های این برنامه پاک نشد زیرا سطح API دستگاه از این دستور پشتیبانی نمی‌کند.

شروعوضعیت از دست رفته

وضعیت دستور START_LOST_MODE برای قرار دادن دستگاه در حالت گم‌شده.

نمایش JSON 
{
  "status": enum (Status)
}
فیلدها
status

enum ( Status )

وضعیت. به StartLostModeStatus مراجعه کنید.

وضعیت

وضعیت. به StartLostModeStatus مراجعه کنید.

انوم‌ها
STATUS_UNSPECIFIED نامشخص. این مقدار استفاده نمی‌شود.
SUCCESS دستگاه در حالت گم شدن قرار گرفت.
RESET_PASSWORD_RECENTLY دستگاه را نمی‌توان در حالت گم‌شده قرار داد زیرا مدیر اخیراً رمز عبور دستگاه را بازنشانی کرده است.
USER_EXIT_LOST_MODE_RECENTLY دستگاه را نمی‌توان در حالت گم‌شده قرار داد زیرا کاربر اخیراً از حالت گم‌شده خارج شده است.
ALREADY_IN_LOST_MODE دستگاه از قبل در حالت گم شدن (lost mode) قرار دارد.

وضعیت StopLostMode

وضعیت دستور STOP_LOST_MODE برای خارج کردن دستگاه از حالت گم‌شده.

نمایش JSON 
{
  "status": enum (Status)
}
فیلدها
status

enum ( Status )

وضعیت. به StopLostModeStatus مراجعه کنید.

وضعیت

وضعیت. به StopLostModeStatus مراجعه کنید.

انوم‌ها
STATUS_UNSPECIFIED نامشخص. این مقدار استفاده نمی‌شود.
SUCCESS دستگاه از حالت گم شدن خارج شد.
NOT_IN_LOST_MODE دستگاه در حالت گم شدن (Lost Mode) نیست.

وضعیت فرمان Esim

جزئیات وضعیت و خطای (در صورت وجود) یک دستور ADD_ESIM یا REMOVE_ESIM .

نمایش JSON 
{
  "status": enum (Status),
  "esimInfo": {
    object (EsimInfo)
  },

  // Union field status_details can be only one of the following:
  "internalErrorDetails": {
    object (InternalErrorDetails)
  }
  // End of list of possible types for union field status_details.
}
فیلدها
status

enum ( Status )

فقط خروجی. وضعیت یک دستور ADD_ESIM یا REMOVE_ESIM .

esimInfo

object ( EsimInfo )

فقط خروجی. اطلاعات مربوط به eSIM اضافه یا حذف شده. این اطلاعات فقط زمانی نمایش داده می‌شود که status عملکرد eSIM SUCCESS باشد.

فیلد union status_details . جزئیات وضعیت یک دستور ADD_ESIM یا REMOVE_ESIM . status_details فقط می‌تواند یکی از موارد زیر باشد:
internalErrorDetails

object ( InternalErrorDetails )

فقط خروجی. جزئیات خطا در صورتی که status روی INTERNAL_ERROR تنظیم شده باشد.

وضعیت

وضعیت یک دستور ADD_ESIM یا REMOVE_ESIM .

انوم‌ها
STATUS_UNSPECIFIED نامشخص. این مقدار استفاده نمی‌شود.
SUCCESS عملیات eSIM با موفقیت روی دستگاه انجام شد.
IN_PROGRESS عملیات eSIM در حال انجام است.
PENDING_USER_ACTION برای ادامه‌ی عملیات eSIM، کاربر باید اقدامی انجام دهد.
ERROR_SETUP_IN_PROGRESS عملیات eSIM هنگام انجام تنظیمات قابل اجرا نیست.
ERROR_USER_DENIED کاربر عملیات eSIM را رد کرده است.
INTERNAL_ERROR هنگام تلاش برای اضافه کردن یا حذف eSIM روی دستگاه، خطایی روی داده است، به internalErrorDetails مراجعه کنید.
ERROR_ICC_ID_NOT_FOUND برای دستور REMOVE_ESIM ، iccId مربوط به eSIM که قرار است حذف شود، روی دستگاه یافت نشد. این می‌تواند به این معنی باشد که eSIM متعلق به شرکت نیست یا eSIM مربوط به iccId روی دستگاه وجود ندارد.
ERROR_MULTIPLE_ACTIVE_ESIMS_NO_AVAILABLE_SLOT دستور ADD_ESIM هنگام تلاش برای افزودن یک eSIM جدید با وضعیت فعال‌سازی روی ACTIVATED ناموفق بود، زیرا چندین اسلات eSIM روی دستگاه حاوی پروفایل‌های eSIM فعال هستند و هیچ اسلات eSIM خالی در دسترس نیست. برای حل این مشکل، می‌توان eSIM جدید را با وضعیت فعال‌سازی NOT_ACTIVATED برای فعال‌سازی دستی بعدی اضافه کرد، یا کاربر ابتدا باید یک eSIM فعال موجود را غیرفعال کند تا عملیات ادامه یابد.

جزئیات خطای داخلی

جزئیات خطای داخلی در صورت وجود برای دستور ADD_ESIM یا REMOVE_ESIM .

نمایش JSON 
{
  "operationCode": string,
  "errorCode": string,
  "operationCodeDetail": enum (OperationCodeDetail),
  "errorCodeDetail": enum (ErrorCodeDetail)
}
فیلدها
operationCode

string ( int64 format)

فقط خروجی. نمایش عدد صحیح کد عملیات همانطور که در اینجا مشخص شده است. برای جزئیات بیشتر به operationCodeDetail مراجعه کنید.

errorCode

string ( int64 format)

فقط خروجی. نمایش عدد صحیح کد خطا همانطور که در اینجا مشخص شده است. همچنین به OPERATION_SMDX_SUBJECT_REASON_CODE مراجعه کنید. برای جزئیات بیشتر به errorCodeDetail مراجعه کنید.

operationCodeDetail

enum ( OperationCodeDetail )

فقط خروجی. جزئیات کد عملیات مربوط به operationCode .

errorCodeDetail

enum ( ErrorCodeDetail )

فقط خروجی. جزئیات کد خطا مربوط به errorCode .

جزئیات کد عملیات

جزئیات کد عملیات مربوط به operationCode .

انوم‌ها
OPERATION_CODE_DETAIL_UNSPECIFIED جزئیات کد عملیات مشخص نشده است. operationCode توسط API مدیریت اندروید شناسایی نمی‌شود. با این حال، به operationCode مراجعه کنید.
OPERATION_SYSTEM برای جزئیات بیشتر به EuiccManager.OPERATION_SYSTEM مراجعه کنید.
OPERATION_SIM_SLOT برای جزئیات بیشتر به EuiccManager.OPERATION_SIM_SLOT مراجعه کنید.
OPERATION_EUICC_CARD برای جزئیات بیشتر به EuiccManager.OPERATION_EUICC_CARD مراجعه کنید.
OPERATION_SMDX برای جزئیات بیشتر به EuiccManager.OPERATION_SMDX مراجعه کنید.
OPERATION_SWITCH برای جزئیات بیشتر به EuiccManager.OPERATION_SWITCH مراجعه کنید.
OPERATION_DOWNLOAD برای جزئیات بیشتر به EuiccManager.OPERATION_DOWNLOAD مراجعه کنید.
OPERATION_METADATA برای جزئیات بیشتر به EuiccManager.OPERATION_METADATA مراجعه کنید.
OPERATION_EUICC_GSMA برای جزئیات بیشتر به EuiccManager.OPERATION_EUICC_GSMA مراجعه کنید.
OPERATION_APDU برای جزئیات بیشتر به EuiccManager.OPERATION_APDU مراجعه کنید.
OPERATION_SMDX_SUBJECT_REASON_CODE برای جزئیات بیشتر به EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE مراجعه کنید. توجه داشته باشید که در این حالت، errorCode کم‌ارزش‌ترین ۳ بایت از EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE است که کد موضوع و کد دلیل را همانطور که در اینجا نشان داده شده است، مشخص می‌کند. بایت باارزش عدد صحیح صفر می‌شود. برای مثال، کد موضوع ۸.۱۱.۱ و کد دلیل ۵.۱ در errorCode به صورت ۰۰۰۰ ۰۰۰۰ ۱۰۰۰ ۱۰۰۰ ۱۰۱۱ ۰۰۰۱ ۰۰۰۰ ۰۱۰۱ ۰۰۰۱ در حالت دودویی نمایش داده می‌شوند که در حالت اعشاری برابر با ۹۱۱۳۶۸۱ است.
OPERATION_HTTP برای جزئیات بیشتر به EuiccManager.OPERATION_HTTP مراجعه کنید.

جزئیات کد خطا

جزئیات کد خطا مربوط به errorCode .

انوم‌ها
ERROR_CODE_DETAIL_UNSPECIFIED جزئیات کد خطا مشخص نشده است. errorCode توسط API مدیریت اندروید شناسایی نمی‌شود. با این حال، به errorCode مراجعه کنید.
ERROR_TIME_OUT برای جزئیات بیشتر به EuiccManager.ERROR_TIME_OUT مراجعه کنید.
ERROR_EUICC_MISSING برای جزئیات بیشتر به EuiccManager.ERROR_EUICC_MISSING مراجعه کنید.
ERROR_UNSUPPORTED_VERSION برای جزئیات بیشتر به EuiccManager.ERROR_UNSUPPORTED_VERSION مراجعه کنید.
ERROR_ADDRESS_MISSING برای جزئیات بیشتر به EuiccManager.ERROR_ADDRESS_MISSING مراجعه کنید.
ERROR_INVALID_CONFIRMATION_CODE برای جزئیات بیشتر به EuiccManager.ERROR_INVALID_CONFIRMATION_CODE مراجعه کنید.
ERROR_CERTIFICATE_ERROR برای جزئیات بیشتر به EuiccManager.ERROR_CERTIFICATE_ERROR مراجعه کنید.
ERROR_NO_PROFILES_AVAILABLE برای جزئیات بیشتر به EuiccManager.ERROR_NO_PROFILES_AVAILABLE مراجعه کنید.
ERROR_CONNECTION_ERROR برای جزئیات بیشتر به EuiccManager.ERROR_CONNECTION_ERROR مراجعه کنید.
ERROR_INVALID_RESPONSE برای جزئیات بیشتر به EuiccManager.ERROR_INVALID_RESPONSE مراجعه کنید.
ERROR_CARRIER_LOCKED برای جزئیات بیشتر به EuiccManager.ERROR_CARRIER_LOCKED مراجعه کنید.
ERROR_DISALLOWED_BY_PPR برای جزئیات بیشتر به EuiccManager.ERROR_DISALLOWED_BY_PPR مراجعه کنید.
ERROR_INVALID_ACTIVATION_CODE برای جزئیات بیشتر به EuiccManager.ERROR_INVALID_ACTIVATION_CODE مراجعه کنید.
ERROR_INCOMPATIBLE_CARRIER برای جزئیات بیشتر به EuiccManager.ERROR_INCOMPATIBLE_CARRIER مراجعه کنید.
ERROR_OPERATION_BUSY برای جزئیات بیشتر به EuiccManager.ERROR_OPERATION_BUSY مراجعه کنید.
ERROR_INSTALL_PROFILE برای جزئیات بیشتر به EuiccManager.ERROR_INSTALL_PROFILE مراجعه کنید.
ERROR_EUICC_INSUFFICIENT_MEMORY برای جزئیات بیشتر به EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY مراجعه کنید.
ERROR_INVALID_PORT برای جزئیات بیشتر به EuiccManager.ERROR_INVALID_PORT مراجعه کنید.
ERROR_SIM_MISSING برای جزئیات بیشتر به EuiccManager.ERROR_SIM_MISSING مراجعه کنید.

ایسیم اینفو

جزئیات eSIM اضافه یا حذف شده است.

نمایش JSON 
{
  "iccId": string
}
فیلدها
iccId

string

فقط خروجی. شناسه ICC سیم‌کارت الکترونیکی.

درخواستاطلاعات دستگاهوضعیت

وضعیت دستور REQUEST_DEVICE_INFO .

نمایش JSON 
{
  "status": enum (Status),

  // Union field device_info can be only one of the following:
  "eidInfo": {
    object (EidInfo)
  }
  // End of list of possible types for union field device_info.
}
فیلدها
status

enum ( Status )

فقط خروجی. وضعیت دستور REQUEST_DEVICE_INFO .

فیلد unit device_info . جزئیات اطلاعات دستگاه درخواست شده توسط مدیر. این فیلد فقط زمانی پر می‌شود که status SUCCEEDED باشد. device_info فقط می‌تواند یکی از موارد زیر باشد:
eidInfo

object ( EidInfo )

اطلاعات مربوط به EID های دستگاه.

وضعیت

وضعیت دستور REQUEST_DEVICE_INFO .

انوم‌ها
STATUS_UNSPECIFIED نامشخص. این مقدار استفاده نمی‌شود.
SUCCEEDED اطلاعات دستگاه با موفقیت ثبت شد.
PENDING_USER_ACTION کاربر اقدامات لازم برای اشتراک‌گذاری اطلاعات دستگاه را انجام نداده است.
USER_DECLINED کاربر از به اشتراک گذاشتن اطلاعات دستگاه خودداری کرد.
UNSUPPORTED اطلاعات دستگاه درخواستی در این دستگاه پشتیبانی نمی‌شود، مثلاً eSIM در دستگاه پشتیبانی نمی‌شود.

اطلاعات عید

اطلاعات مربوط به EID های دستگاه.

نمایش JSON 
{
  "eids": [
    {
      object (Eid)
    }
  ]
}
فیلدها
eids[]

object ( Eid )

فقط خروجی. اطلاعات EID برای هر تراشه eUICC.

عید

اطلاعات EID برای هر تراشه eUICC.

نمایش JSON 
{
  "eid": string
}
فیلدها
eid

string

فقط خروجی. EID