- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- הפקודה
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- סטטוס
- StopLostModeStatus
- סטטוס
- רוצים לנסות?
שולחים פקודה למכשיר. המשאב Operation
שהוחזר מכיל Command
בשדה metadata
שלו. משתמשים בשיטת הפעולה get כדי לקבל את הסטטוס של הפקודה.
בקשת HTTP
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
שם המכשיר בפורמט |
גוף הבקשה
גוף הבקשה מכיל מופע של Command
.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Operation
.
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/androidmanagement
למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.
פקודה
פקודה.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
סוג הפקודה. |
createTime |
חותמת הזמן שבה הפקודה נוצרה. חותמת הזמן נוצרת באופן אוטומטי על ידי השרת. חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
duration |
משך הזמן שבו הפקודה תקפה. התוקף של הפקודה יפוג אם המכשיר לא יבצע אותה בפרק הזמן הזה. אם לא צוין משך זמן, ברירת המחדל שלו היא עשר דקות. אין משך זמן מקסימלי. משך זמן בשניות עם עד תשע ספרות עשרוניות, המסתיים ב-' |
userName |
שם המשאב של המשתמש שהמכשיר בבעלותו, בפורמט |
errorCode |
אם הפקודה נכשלה, יופיע קוד שגיאה שמסביר את הכשל. ערך זה לא מוגדר כשהפקודה בוטלה על ידי מבצע הקריאה החוזרת. |
newPassword |
לפקודות מסוג |
resetPasswordFlags[] |
לפקודות מסוג |
שדה איחוד אם המדיניות הזו מוגדרת, לא ניתן להגדיר את השדות |
|
clearAppsDataParams |
פרמטרים לפקודה |
startLostModeParams |
פרמטרים לפקודה |
stopLostModeParams |
פרמטרים לפקודה |
שדה איחוד status . סטטוס ספציפי לפקודה. חשוב לשים לב שחלק מהפקודות לא משתמשות באפשרות הזו, ובמיוחד , , ו- . בעתיד, יכול להיות שהפקודות האלה ישתמשו גם באפשרות הזו. status יכול להיות רק אחד מהבאים: |
|
clearAppsDataStatus |
פלט בלבד. הסטטוס של הפקודה |
startLostModeStatus |
פלט בלבד. סטטוס הפקודה |
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 ואילך. שים לב שאפליקציה יכולה לאחסן נתונים מחוץ לנתוני האפליקציה, למשל באחסון חיצוני או במילון משתמש. למידע נוסף, יש לעיין ב- . |
START_LOST_MODE |
העברת המכשיר למצב אובדן מכשיר. התכונה נתמכת רק במכשירים שמנוהלים באופן מלא או במכשירים בבעלות הארגון שיש להם פרופיל מנוהל. למידע נוסף, יש לעיין ב- . |
STOP_LOST_MODE |
הפעולה מוציאה את המכשיר ממצב אובדן מכשיר. התכונה נתמכת רק במכשירים שמנוהלים באופן מלא או במכשירים בבעלות הארגון שיש להם פרופיל מנוהל. למידע נוסף, יש לעיין ב- . |
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[] |
שמות החבילות של האפליקציות שהנתונים שלהן יימחקו לאחר הפעלת הפקודה. |
StartLostModeParams
פרמטרים שמשויכים לפקודה
כדי להעביר את המכשיר למצב אובדן מכשיר. כדי שהמכשיר יועבר למצב אובדן, יש לספק לפחות אחד מהפרמטרים, לא כולל שם הארגון.START_LOST_MODE
ייצוג JSON |
---|
{ "lostMessage": { object ( |
שדות | |
---|---|
lostMessage |
ההודעה שמוצגת למשתמש כשהמכשיר במצב אובדן מכשיר. |
lostPhoneNumber |
מספר הטלפון שהשיחה תועבר אליו כשהמכשיר יהיה במצב אובדן מכשיר והקשה על לחצן ההתקשרות של בעל המכשיר. |
lostEmailAddress |
כתובת האימייל שמוצגת למשתמש כשהמכשיר במצב אובדן מכשיר. |
lostStreetAddress |
הכתובת שמוצגת למשתמש כשהמכשיר במצב אובדן מכשיר. |
lostOrganization |
שם הארגון שמוצג למשתמש כשהמכשיר במצב אובדן מכשיר. |
StopLostModeParams
אין שדות בסוג הזה.
פרמטרים שמשויכים לפקודה
כדי להוציא את המכשיר ממצב אובדן מכשיר.STOP_LOST_MODE
ClearAppsDataStatus
הסטטוס של הפקודה
לניקוי הנתונים של האפליקציות שצוינו מהמכשיר.CLEAR_APP_DATA
ייצוג JSON |
---|
{
"results": {
string: {
object ( |
שדות | |
---|---|
results |
התוצאות לכל אפליקציה, מיפוי משמות חבילות לתוצאת הניקוי המתאימה. אובייקט שמכיל רשימה של |
PerAppResult
התוצאה של ניסיון למחוק את הנתונים של אפליקציה אחת.
ייצוג JSON |
---|
{
"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 |
הסטטוס. |
סטטוס
הסטטוס.
.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 |
הסטטוס. |
סטטוס
הסטטוס.
.StopLostModeStatus
טיפוסים בני מנייה (enums) | |
---|---|
STATUS_UNSPECIFIED |
לא צוין. הערך הזה לא בשימוש. |
SUCCESS |
המכשיר יצא ממצב אובדן מכשיר. |
NOT_IN_LOST_MODE |
המכשיר לא במצב אובדן מכשיר. |