Method: enterprises.devices.issueCommand

יוצר פקודה למכשיר. המשאב Operation שהוחזר מכיל Command בשדה metadata שלו. צריך להשתמש בשיטת get Action כדי לקבל את הסטטוס של הפקודה.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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)

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

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

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'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 המכשיר לא תומך בפקודה. עדכון של Device Policy ל-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 המכשיר לא במצב אובדן.