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)
  },
  "requestDeviceInfoParams": {
    object (RequestDeviceInfoParams)
  }
  // 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)
  },
  "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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
duration

string (Duration format)

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

משך זמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'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 באופן מפורש.
requestDeviceInfoParams

object (RequestDeviceInfoParams)

אופציונלי. פרמטרים לפקודה REQUEST_DEVICE_INFO לקבלת מידע שקשור למכשיר. אם ההגדרה הזו מוגדרת, מומלץ לא להגדיר את type. במקרה כזה, השרת מגדיר אותו באופן אוטומטי ל-REQUEST_DEVICE_INFO . אפשר גם להגדיר את type ל-REQUEST_DEVICE_INFO באופן מפורש.
שדה האיחוד 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.
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.
REQUEST_DEVICE_INFO מבקשים מידע שקשור למכשיר.

CommandErrorCode

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

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

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 כדי להוציא את המכשיר ממצב אובדן.

RequestDeviceInfoParams

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

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

enum (DeviceInfo)

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

DeviceInfo

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

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

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 המכשיר לא במצב אובדן.

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