- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- פקודה
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- סטטוס
- StopLostModeStatus
- סטטוס
- רוצים לנסות?
יוצר פקודה למכשיר. המשאב Operation
שהוחזר מכיל Command
בשדה metadata
שלו. צריך להשתמש בשיטת get Action כדי לקבל את הסטטוס של הפקודה.
בקשת 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 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
duration |
משך הזמן שבו הפקודה תקפה. תוקף הפקודה יפוג אם המכשיר לא יבצע אותה בפרק הזמן הזה. ברירת המחדל למשך הזמן, אם לא צוין, היא עשר דקות. אין משך זמן מקסימלי. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
userName |
שם המשאב של המשתמש שהמכשיר נמצא בבעלותו, בצורת |
errorCode |
אם הפקודה נכשלה, יוצג קוד שגיאה שמסביר את הכשל. הערך הזה לא מוגדר כשהפקודה מבטלת על ידי מבצע הקריאה החוזרת. |
newPassword |
לפקודות מסוג |
resetPasswordFlags[] |
לפקודות מסוג |
שדה איחוד אם המדיניות הזו מוגדרת, אין להגדיר את השדות |
|
clearAppsDataParams |
פרמטרים של הפקודה |
startLostModeParams |
פרמטרים לפקודה |
stopLostModeParams |
פרמטרים לפקודה |
שדה איחוד status . הסטטוס הספציפי לפקודה. חשוב לשים לב שחלק מהפקודות לא משתמשות באפשרות הזו, במיוחד ב- , ב- , ב- וב- . בעתיד, גם הפקודות האלה עשויות להשתמש באפשרות הזו. status יכול להיות רק אחת מהאפשרויות הבאות: |
|
clearAppsDataStatus |
פלט בלבד. הסטטוס של הפקודה |
startLostModeStatus |
פלט בלבד. הסטטוס של הפקודה |
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 ואילך. הערה: האפליקציה יכולה לאחסן נתונים מחוץ לנתוני האפליקציה, למשל באחסון חיצוני או במילון משתמש. מידע נוסף מופיע כאן: . |
START_LOST_MODE |
המכשיר עובר למצב אובדן מכשיר. נתמך רק במכשירים מנוהלים או במכשירים בבעלות הארגון עם פרופיל מנוהל. מידע נוסף מופיע כאן: . |
STOP_LOST_MODE |
זה מוציא את המכשיר ממצב אובדן מכשיר. נתמך רק במכשירים מנוהלים או במכשירים בבעלות הארגון עם פרופיל מנוהל. מידע נוסף מופיע כאן: . |
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[] |
שמות החבילות של האפליקציות שהנתונים שלהן יימחקו כאשר תבוצע הפקודה. |
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
התוצאה של ניסיון לנקות את הנתונים של אפליקציה אחת.
טיפוסים בני מנייה (enum) | |
---|---|
CLEARING_RESULT_UNSPECIFIED |
לא צוינה תוצאה. |
SUCCESS |
נתוני האפליקציה הזו נוקו. |
APP_NOT_FOUND |
לא ניתן היה למחוק את נתוני האפליקציה הזו כי האפליקציה לא נמצאה. |
APP_PROTECTED |
לא ניתן היה למחוק את נתוני האפליקציה הזו כי היא מוגנת. לדוגמה, הוראות כאלה עשויות להיות רלוונטיות לאפליקציות שחיוניות לתפקוד המכשיר, כמו חנות Google Play. |
API_LEVEL |
אי אפשר למחוק את הנתונים של האפליקציה הזו כי רמת ה-API של המכשיר לא תומכת בפקודה הזו. |
StartLostModeStatus
הסטטוס של הפקודה
להעברת המכשיר למצב אובדן מכשיר.START_LOST_MODE
ייצוג JSON |
---|
{
"status": enum ( |
שדות | |
---|---|
status |
הסטטוס. |
סטטוס
הסטטוס.
.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 |
הסטטוס. |
סטטוס
הסטטוס.
.StopLostModeStatus
טיפוסים בני מנייה (enum) | |
---|---|
STATUS_UNSPECIFIED |
לא צוין. הערך הזה לא בשימוש. |
SUCCESS |
המכשיר יצא ממצב אובדן מכשיר. |
NOT_IN_LOST_MODE |
המכשיר לא במצב אובדן. |