- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי הרשאה
- Command
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- סטטוס
- StopLostModeStatus
- סטטוס
- רוצים לנסות?
שליחת פקודה למכשיר. המשאב Operation
שמוחזר מכיל Command
בשדה metadata
שלו. משתמשים בשיטת get operation כדי לקבל את סטטוס הפקודה.
בקשת HTTP
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
שם המכשיר בפורמט |
גוף הבקשה
גוף הבקשה מכיל מופע של Command
.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל מופע של Operation
.
היקפי הרשאה
נדרש היקף הרשאות OAuth הבא:
https://www.googleapis.com/auth/androidmanagement
למידע נוסף, ראו סקירה כללית על OAuth 2.0.
פקודה
פקודה.
ייצוג ב-JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
סוג הפקודה. |
create |
חותמת הזמן שבה נוצרה הפקודה. חותמת הזמן נוצרת באופן אוטומטי על ידי השרת. חותמת זמן בפורמט UTC "Zulu" של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
duration |
משך הזמן שבו הפקודה תקפה. אם הפקודה לא תבוצע במכשיר במהלך פרק הזמן הזה, תוקפה יפוג. אם לא צוין משך זמן, ברירת המחדל היא 10 דקות. אין משך זמן מקסימלי. משך זמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-' |
user |
שם המשאב של המשתמש שבבעלותו המכשיר, בפורמט |
error |
אם הפקודה נכשלה, קוד שגיאה עם הסבר על הכשל. הערך הזה לא מוגדר כשהמבצע מבטל את הפקודה. |
new |
בפקודות מסוג |
reset |
בפקודות מסוג |
שדה האיחוד אם השדה הזה מוגדר, אסור להגדיר את השדות |
|
clear |
פרמטרים לפקודה |
start |
פרמטרים לפקודה |
stop |
פרמטרים לפקודה |
שדה האיחוד status . סטטוס ספציפי לפקודה. חשוב לזכור שפקדים מסוימים לא משתמשים באפשרות הזו, במיוחד , , ו- . בעתיד יכול להיות שהפקודות האלה ישתמשו גם באפשרות הזו. הערך של status יכול להיות רק אחת מהאפשרויות הבאות: |
|
clear |
פלט בלבד. סטטוס הפקודה |
start |
פלט בלבד. סטטוס הפקודה |
stop |
פלט בלבד. סטטוס הפקודה |
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 |
המכשיר לא תומך בפקודה. ייתכן שהבעיה תיפתר אם תעדכנו את המדיניות של 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 ] } |
שדות | |
---|---|
package |
שמות החבילות של האפליקציות שהנתונים שלהן יימחקו כשהפקודה תבוצע. |
StartLostModeParams
פרמטרים שמשויכים לפקודה
להעברת המכשיר למצב אבוד. כדי להעביר את המכשיר למצב אבוד, צריך לספק לפחות אחד מהפרמטרים, לא כולל שם הארגון.START_LOST_MODE
ייצוג ב-JSON |
---|
{ "lostMessage": { object ( |
שדות | |
---|---|
lost |
ההודעה שתוצג למשתמש כשהמכשיר נמצא במצב אובדן. |
lost |
מספר הטלפון שאליו תבוצע שיחה כשהמכשיר במצב אבוד ותלחצו על הלחצן 'בעל המכשיר'. |
lost |
כתובת האימייל שמוצגת למשתמש כשהמכשיר נמצא במצב אובדן. |
lost |
הרחוב ומספר הבית שיוצגו למשתמש כשהמכשיר נמצא במצב אובדן. |
lost |
שם הארגון שמוצג למשתמש כשהמכשיר נמצא במצב אובדן. |
StopLostModeParams
אין שדות לסוג הזה.
פרמטרים שמשויכים לפקודה
כדי להוציא את המכשיר ממצב אובדן.STOP_LOST_MODE
ClearAppsDataStatus
סטטוס הפקודה
לניקוי הנתונים של אפליקציות מסוימות מהמכשיר.CLEAR_APP_DATA
ייצוג ב-JSON |
---|
{
"results": {
string: {
object ( |
שדות | |
---|---|
results |
התוצאות לפי אפליקציה, מיפוי של שמות חבילות לתוצאת הניקוי המתאימה. אובייקט שמכיל רשימה של זוגות |
PerAppResult
התוצאה של ניסיון לנקות את הנתונים של אפליקציה אחת.
ייצוג ב-JSON |
---|
{
"clearingResult": enum ( |
שדות | |
---|---|
clearing |
התוצאה של ניסיון לנקות את הנתונים של אפליקציה אחת. |
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 |
המכשיר לא במצב אובדן. |