Method: enterprises.devices.issueCommand

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

בקשת 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, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

סוגי הפקודות:

טיפוסים בני מנייה (enums)
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

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

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

ResetPasswordFlag

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

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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.

טיפוסים בני מנייה (enums)
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.

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