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.

פקודה

פקודה.

ייצוג ב-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)
  }
  // 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)
  }
  // End of list of possible types for union field status.
}
שדות
type

enum (CommandType)

סוג הפקודה.
createTime

string (Timestamp format)

חותמת הזמן שבה הפקודה נוצרה. חותמת הזמן נוצרת באופן אוטומטי על ידי השרת.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. דוגמה: "3.5s".
userName

string

שם המשאב של המשתמש שבבעלותו המכשיר, בפורמט enterprises/{enterpriseId}/users/{userId}. השרת יוצר אותו באופן אוטומטי על סמך המכשיר שאליו נשלחת הפקודה.
errorCode

enum (CommandErrorCode)

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

string

בפקודות מסוג RESET_PASSWORD, אפשר לציין את הסיסמה החדשה. הערה: אם מדובר במכשירי Android 14, הסיסמה החדשה חייבת להיות באורך של 6 תווים לפחות. אחרת, הפקודה תיכשל עם 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 באופן מפורש.
שדה איחוד 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.

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.

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

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