Method: enterprises.devices.issueCommand

הפעלת פקודה למכשיר. המשאב Operation שמוחזר מכיל את Command בשדה metadata. משתמשים בשיטת get operation כדי לקבל את הסטטוס של הפקודה.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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 וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים מלבד 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)

אם הפקודה נכשלה, קוד שגיאה שמסביר את הכשל. הערך הזה לא מוגדר אם המתקשר מבטל את הפקודה. כדי להבין את השגיאות בפקודה, עדיף להשתמש בשדות לפי הסדר הבא (המועדף ביותר מופיע ראשון): 1. שדות ספציפיים לפקודה כמו clearAppsDataStatus,‏ startLostModeStatus או שדות דומים, אם הם קיימים. 2. השדה הזה, אם הוא מוגדר. 3. השדה הגנרי error ב-Operation שעוטף את הפקודה.

newPassword

string

לפקודות מסוג RESET_PASSWORD, אפשר לציין את הסיסמה החדשה. הערה: אם הסיסמה החדשה היא מספרית, היא צריכה להיות באורך 6 תווים לפחות במכשירי Android 14. אחרת, הפקודה תיכשל עם השגיאה INVALID_VALUE.

resetPasswordFlags[]

enum (ResetPasswordFlag)

לפקודות מהסוג RESET_PASSWORD, אפשר לציין דגלים.

שדה איחוד params. פרמטרים שספציפיים לפקודה. שימו לב שחלק מהפקודות לא משתמשות בזה, במיוחד הפקודות 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.

CommandType

סוגי פקודות.

טיפוסים בני מנייה (enum)
COMMAND_TYPE_UNSPECIFIED הערך הזה אסור.
LOCK לנעול את המכשיר, כאילו פג הזמן הקצוב לנעילת המסך.
RESET_PASSWORD מאפסים את הסיסמה של המשתמש.
REBOOT מפעילים מחדש את המכשיר. האפשרות נתמכת רק במכשירים בניהול מלא שמותקנת בהם גרסת Android 7.0 (רמת API‏ 24) ומעלה.
RELINQUISH_OWNERSHIP הסרת פרופיל העבודה וכללי המדיניות ממכשיר בבעלות החברה עם Android בגרסה 8.0 ואילך, כדי שהמכשיר יהיה זמין לשימוש אישי. האפליקציות והנתונים שמשויכים לפרופיל האישי נשמרים. המכשיר יימחק מהשרת אחרי שהוא יאשר את הפקודה.
CLEAR_APP_DATA מנקה את נתוני האפליקציה של אפליקציות שצוינו. התכונה הזו נתמכת ב-Android מגרסה 9 ואילך. חשוב לזכור שאפליקציה יכולה לאחסן נתונים מחוץ לנתוני האפליקציה שלה, למשל באחסון חיצוני או במילון משתמש. ראו גם clearAppsDataParams.
START_LOST_MODE העברת המכשיר למצב אבוד. האפשרות הזו נתמכת רק במכשירים מנוהלים או במכשירים בבעלות הארגון עם פרופיל מנוהל. ראו גם startLostModeParams.
STOP_LOST_MODE הוצאת המכשיר ממצב אובדן. האפשרות הזו נתמכת רק במכשירים מנוהלים או במכשירים בבעלות הארגון עם פרופיל מנוהל. ראו גם stopLostModeParams.
ADD_ESIM הוספת פרופיל eSIM למכשיר. התכונה הזו נתמכת ב-Android מגרסה 15 ואילך. ראו גם addEsimParams. כדי להסיר פרופיל eSIM, משתמשים בפקודה REMOVE_ESIM. כדי לקבוע מה קורה לפרופיל ה-eSIM כשמבצעים איפוס של המכשיר, צריך להגדיר את wipeDataFlags במדיניות. הערה: כדי להקצות כמה כרטיסי eSIM במכשיר אחד, מומלץ להוסיף השהיה של כמה דקות בין הביצועים העוקבים של הפקודה.
REMOVE_ESIM הסרת פרופיל eSIM מהמכשיר. התכונה הזו נתמכת ב-Android מגרסה 15 ואילך. ראו גם removeEsimParams.
REQUEST_DEVICE_INFO בקשה לקבלת מידע שקשור למכשיר.
WIPE מחיקת הנתונים במכשיר באמצעות איפוס להגדרות היצרן במכשיר בבעלות החברה, או באמצעות מחיקת פרופיל העבודה במכשיר בבעלות אישית עם פרופיל עבודה. המחיקה מתבצעת רק אחרי שהמכשיר מאשר את הפקודה. אפשר לבטל את הפקודה לפני כן.

CommandErrorCode

קוד שגיאה של פקודה. זהו שדה לקריאה בלבד שאוכלס על ידי השרת.

טיפוסים בני מנייה (enum)
COMMAND_ERROR_CODE_UNSPECIFIED לא הייתה שגיאה.
UNKNOWN הייתה שגיאה לא ידועה.
API_LEVEL רמת ה-API של המכשיר לא תומכת בפקודה הזו.
MANAGEMENT_MODE מצב הניהול (בעל הפרופיל, בעל המכשיר וכו') לא תומך בפקודה.
INVALID_VALUE בפקודה יש ערך פרמטר לא תקין.
UNSUPPORTED המכשיר לא תומך בפקודה. עדכון של Android Device Policy לגרסה האחרונה עשוי לפתור את הבעיה.

ResetPasswordFlag

דגלים שאפשר להשתמש בהם בסוג הפקודה RESET_PASSWORD.

טיפוסים בני מנייה (enum)
RESET_PASSWORD_FLAG_UNSPECIFIED המערכת מתעלמת מהערך הזה.
REQUIRE_ENTRY לא מאפשרים לאדמינים אחרים לשנות שוב את הסיסמה עד שהמשתמש יזין אותה.
DO_NOT_ASK_CREDENTIALS_ON_BOOT לא לבקש פרטי כניסה של משתמשים בהפעלת המכשיר.
LOCK_NOW נעילת המכשיר אחרי איפוס הסיסמה.

ClearAppsDataParams

פרמטרים שמשויכים לפקודה CLEAR_APP_DATA לניקוי הנתונים של אפליקציות ספציפיות מהמכשיר.

ייצוג ב-JSON
{
  "packageNames": [
    string
  ]
}
שדות
packageNames[]

string

שמות החבילות של האפליקציות שהנתונים שלהן יימחקו כשהפקודה תופעל.

StartLostModeParams

פרמטרים שמשויכים לפקודה 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)

שם הארגון שמוצג למשתמש כשהמכשיר נמצא במצב אובדן מכשיר.

StopLostModeParams

אין שדות מסוג זה.

פרמטרים שמשויכים לפקודה STOP_LOST_MODE להוצאת המכשיר ממצב אובדן מכשיר.

AddEsimParams

פרמטרים שמשויכים לפקודה ADD_ESIM להוספת פרופיל eSIM למכשיר.

ייצוג ב-JSON
{
  "activationCode": string,
  "activationState": enum (ActivationState)
}
שדות
activationCode

string

חובה. קוד ההפעלה של פרופיל ה-eSIM.

activationState

enum (ActivationState)

חובה. מצב ההפעלה של פרופיל ה-eSIM אחרי ההורדה.

ActivationState

מצב ההפעלה של פרופיל ה-eSIM אחרי ההורדה.

טיפוסים בני מנייה (enum)
ACTIVATION_STATE_UNSPECIFIED לא צוין מצב ההפעלה של ה-eSIM. ערך ברירת המחדל הוא NOT_ACTIVATED בפרופיל ה-eSIM במכשירים בבעלות אישית ו-ACTIVATED במכשירים בבעלות החברה.
ACTIVATED ה-eSIM מופעל באופן אוטומטי אחרי ההורדה. אם תגדירו את המצב הזה כמצב ההפעלה של מכשירים בבעלות אישית, הפקודה תידחה.
NOT_ACTIVATED פרופיל ה-eSIM הורד אבל לא הופעל. במקרה כזה, המשתמש יצטרך להפעיל את ה-eSIM באופן ידני במכשיר.

RemoveEsimParams

פרמטרים שמשויכים לפקודה REMOVE_ESIM להסרת פרופיל eSIM מהמכשיר.

ייצוג ב-JSON
{
  "iccId": string
}
שדות
iccId

string

חובה. מספר ה-ICC ID של פרופיל ה-eSIM שרוצים למחוק.

RequestDeviceInfoParams

פרמטרים שמשויכים לפקודה REQUEST_DEVICE_INFO לקבלת מידע שקשור למכשיר.

ייצוג ב-JSON
{
  "deviceInfo": enum (DeviceInfo)
}
שדות
deviceInfo

enum (DeviceInfo)

חובה. סוג המידע מהמכשיר שרוצים לבקש.

DeviceInfo

סוג המידע מהמכשיר שרוצים לבקש.

טיפוסים בני מנייה (enum)
DEVICE_INFO_UNSPECIFIED הערך הזה אסור.
EID מבקשים את המזהה של ה-eSIM. המשתמש יתבקש לאשר את חשיפת המידע לפני שהתוצאה תוחזר. אם המשתמש לא יאשר את הגילוי, יוחזר הערך USER_DECLINED. התכונה הזו נתמכת רק במכשירים בבעלות אישית עם פרופילי עבודה וב-Android מגרסה 13 ואילך.

WipeParams

פרמטרים שמשויכים לפקודה WIPE למחיקת המכשיר.

ייצוג ב-JSON
{
  "wipeDataFlags": [
    enum (WipeDataFlag)
  ],
  "wipeReason": {
    object (UserFacingMessage)
  }
}
שדות
wipeDataFlags[]

enum (WipeDataFlag)

אופציונלי. דגלים לקביעת הנתונים שיימחקו.

wipeReason

object (UserFacingMessage)

אופציונלי. הודעה קצרה שמוצגת למשתמש לפני איפוס פרופיל העבודה במכשירים אישיים. אין לזה השפעה על מכשירים בבעלות החברה. אורך ההודעה המקסימלי הוא 200 תווים.

ClearAppsDataStatus

הסטטוס של הפקודה CLEAR_APP_DATA למחיקת הנתונים של אפליקציות ספציפיות מהמכשיר.

ייצוג ב-JSON
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
שדות
results

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

התוצאות לכל אפליקציה, מיפוי משמות חבילות לתוצאות הניקוי המתאימות.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }

PerAppResult

התוצאה של ניסיון למחוק את הנתונים של אפליקציה אחת.

ייצוג ב-JSON
{
  "clearingResult": enum (ClearingResult)
}
שדות
clearingResult

enum (ClearingResult)

התוצאה של ניסיון למחוק את הנתונים של אפליקציה אחת.

ClearingResult

התוצאה של ניסיון למחוק את הנתונים של אפליקציה אחת.

טיפוסים בני מנייה (enum)
CLEARING_RESULT_UNSPECIFIED תוצאה לא מזוהה.
SUCCESS הנתונים של האפליקציה הזו נמחקו בהצלחה.
APP_NOT_FOUND לא הייתה אפשרות לנקות את הנתונים של האפליקציה הזו כי האפליקציה לא נמצאה.
APP_PROTECTED לא ניתן לנקות את הנתונים של האפליקציה הזו כי היא מוגנת. לדוגמה, זה יכול לחול על אפליקציות שחיוניות לתפקוד המכשיר, כמו חנות Google Play.
API_LEVEL לא ניתן לנקות את הנתונים של האפליקציה הזו כי רמת ה-API של המכשיר לא תומכת בפקודה הזו.

StartLostModeStatus

הסטטוס של הפקודה START_LOST_MODE להעברת המכשיר למצב אבוד.

ייצוג ב-JSON
{
  "status": enum (Status)
}
שדות
status

enum (Status)

הסטטוס. StartLostModeStatus.

סטטוס

הסטטוס. StartLostModeStatus.

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED לא צוין. הערך הזה לא נמצא בשימוש.
SUCCESS המכשיר הועבר למצב אובדן מכשיר.
RESET_PASSWORD_RECENTLY לא ניתן להעביר את המכשיר למצב אובדן מכשיר כי האדמין איפס לאחרונה את הסיסמה של המכשיר.
USER_EXIT_LOST_MODE_RECENTLY לא ניתן להעביר את המכשיר למצב אובדן מכשיר כי המשתמש יצא ממצב אובדן מכשיר לאחרונה.
ALREADY_IN_LOST_MODE המכשיר כבר במצב אובדן מכשיר.

StopLostModeStatus

הסטטוס של הפקודה STOP_LOST_MODE להוצאת המכשיר ממצב אובדן.

ייצוג ב-JSON
{
  "status": enum (Status)
}
שדות
status

enum (Status)

הסטטוס. StopLostModeStatus.

סטטוס

הסטטוס. StopLostModeStatus.

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED לא צוין. הערך הזה לא נמצא בשימוש.
SUCCESS המכשיר הוצא ממצב אובדן.
NOT_IN_LOST_MODE המכשיר לא במצב אובדן.

EsimCommandStatus

פרטי הסטטוס והשגיאה (אם יש) של פקודה מסוג 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 שהוסף או הוסר. השדה הזה מאוכלס רק אם פעולת ה-eSIM‏ status היא SUCCESS.

שדה איחוד status_details. פרטים על הסטטוס של פקודה מסוג ADD_ESIM או REMOVE_ESIM. הערך status_details יכול להיות רק אחד מהבאים:
internalErrorDetails

object (InternalErrorDetails)

פלט בלבד. פרטי השגיאה אם הערך של status הוא INTERNAL_ERROR.

סטטוס

הסטטוס של פקודה מסוג ADD_ESIM או REMOVE_ESIM.

טיפוסים בני מנייה (enum)
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 פעיל קיים כדי שהפעולה תתבצע.

InternalErrorDetails

פרטי שגיאה פנימית אם קיימים עבור הפקודה 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.

OperationCodeDetail

פרטי קוד הפעולה שמתאימים ל-operationCode.

טיפוסים בני מנייה (enum)
OPERATION_CODE_DETAIL_UNSPECIFIED לא צוינו פרטים של קוד הפעולה. ‫operationCode לא מזוהה על ידי Android Management 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 הם 3 הבייטים הכי פחות משמעותיים של EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE שמציינים את קוד הנושא ואת קוד הסיבה, כפי שמצוין כאן. הבייט הכי משמעותי של המספר השלם מאופס. לדוגמה, קוד הנושא 8.11.1 וקוד הסיבה 5.1 מיוצגים ב-errorCode כ-0000 0000 1000 1011 0001 0000 0101 0001 בפורמט בינארי, ששווה ל-9113681 בפורמט עשרוני.
OPERATION_HTTP פרטים נוספים זמינים במאמר EuiccManager.OPERATION_HTTP.

ErrorCodeDetail

פרטי קוד השגיאה שמתאימים ל-errorCode.

טיפוסים בני מנייה (enum)
ERROR_CODE_DETAIL_UNSPECIFIED פרטי קוד השגיאה לא צוינו. ‫errorCode לא מזוהה על ידי Android Management 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.

EsimInfo

פרטים של כרטיס ה-eSIM שנוסף או הוסר.

ייצוג ב-JSON
{
  "iccId": string
}
שדות
iccId

string

פלט בלבד. מזהה ה-ICC של ה-eSIM.

RequestDeviceInfoStatus

הסטטוס של הפקודה 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.

שדה איחוד device_info. פרטים של מידע המכשיר שהאדמין ביקש. השדה הזה מאוכלס רק כשהערך של status הוא SUCCEEDED. הערך device_info יכול להיות רק אחד מהבאים:
eidInfo

object (EidInfo)

מידע שקשור למספרי ה-EID של המכשיר.

סטטוס

הסטטוס של פקודה REQUEST_DEVICE_INFO.

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED לא צוין. הערך הזה לא נמצא בשימוש.
SUCCEEDED פרטי המכשיר נמסרו בהצלחה.
PENDING_USER_ACTION המשתמש לא השלים את הפעולות הנדרשות לשיתוף פרטי המכשיר.
USER_DECLINED המשתמש סירב לשתף מידע מהמכשיר.
UNSUPPORTED המכשיר לא תומך בפרטי המכשיר המבוקשים, למשל, המכשיר לא תומך ב-eSIM.

EidInfo

מידע שקשור למספרי ה-EID של המכשיר.

ייצוג ב-JSON
{
  "eids": [
    {
      object (Eid)
    }
  ]
}
שדות
eids[]

object (Eid)

פלט בלבד. פרטי EID לכל שבב eUICC.

אייד

פרטי EID לכל שבב eUICC.

ייצוג ב-JSON
{
  "eid": string
}
שדות
eid

string

פלט בלבד. מספר ה-EID