Devices

בסוף הדף תוכלו לראות רשימה של השיטות למשאב הזה.

ייצוגים של משאבים

משאב 'מכשירים' מייצג מכשיר נייד שמנוהל על ידי ה-EMM ושייך למשתמש ארגוני מסוים.

{
  "kind": "androidenterprise#device",
  "androidId": string,
  "managementType": string,
  "policy": {
    "autoUpdatePolicy": string,
    "productAvailabilityPolicy": string,
    "productPolicy": [
      {
        "productId": string,
        "tracks": [
          string
        ],
        "trackIds": [
          string
        ],
        "managedConfiguration": {
          "kind": string,
          "productId": string,
          "managedProperty": [
            {
              "key": string,
              "valueBool": boolean,
              "valueInteger": integer,
              "valueString": string,
              "valueStringArray": [
                string
              ],
              "valueBundle": {
                "managedProperty": [
                  (ManagedProperty)
                ]
              },
              "valueBundleArray": [
                {
                  "managedProperty": [
                    (ManagedProperty)
                  ]
                }
              ]
            }
          ],
          "configurationVariables": {
            "kind": "androidenterprise#configurationVariables",
            "mcmId": string,
            "variableSet": [
              {
                "kind": "androidenterprise#variableSet",
                "placeholder": string,
                "userValue": string
              }
            ]
          }
        },
        "autoInstallPolicy": {
          "autoInstallMode": string,
          "autoInstallPriority": integer,
          "autoInstallConstraint": [
            {
              "networkTypeConstraint": string,
              "chargingStateConstraint": string,
              "deviceIdleStateConstraint": string
            }
          ],
          "minimumVersionCode": integer
        },
        "autoUpdateMode": string,
        "enterpriseAuthenticationAppLinkConfigs": [
          {
            "uri": string
          }
        ]
      }
    ],
    "maintenanceWindow": {
      "startTimeAfterMidnightMs": long,
      "durationMs": long
    },
    "deviceReportPolicy": string
  },
  "report": {
    "lastUpdatedTimestampMillis": long,
    "appState": [
      {
        "packageName": string,
        "keyedAppState": [
          {
            "key": string,
            "stateTimestampMillis": long,
            "severity": string,
            "message": string,
            "data": string
          }
        ]
      }
    ]
  },
  "latestBuildFingerprint": string,
  "sdkVersion": integer,
  "maker": string,
  "model": string,
  "device": string,
  "product": string,
  "retailBrand": string
}
שם הנכס ערך תיאור הערות
androidId string מזהה Android של Google Play Services של המכשיר, שמקודד כמחרוזת הקסדצימלית קטנה. לדוגמה, "123456789abcdef0".
device string שם הקוד הפנימי של החומרה של המכשיר. מקור הערך: android.os.Build.DEVICE. (שדה בשם "מכשיר" לכל יומן/wireless/android/android_checkin.proto)
kind string
latestBuildFingerprint string טביעת האצבע של גרסת ה-build של המכשיר, אם היא ידועה.
maker string יצרן המכשיר. מקור הערך: android.os.Build.MANUFACTURER.
managementType string ההגדרה קובעת באיזו מידה המכשיר נשלט על ידי ספק EMM מנוהל של Google Play בתצורות פריסה שונות.

ערכים אפשריים כוללים:
  • "managedDevice", מכשיר שהבעלים שלו הוא בקר מדיניות המכשיר (DPC) של ה-EMM.
  • 'managedProfile', מכשיר עם פרופיל שמנוהל על ידי ה-DPC (ה-DPC הוא הבעלים של הפרופיל), בנוסף לפרופיל אישי נפרד שלא זמין לבקר DPC.
  • "containerApp", לא בשימוש יותר (הוצא משימוש).
  • 'unmanagedProfile': מכשיר שקיבל הרשאה (על ידי מנהל הדומיין, באמצעות מסוף Admin כדי להפעיל את ההרשאה) להשתמש ב-Google Play לארגונים, אבל הפרופיל עצמו אינו בבעלות של DPC.


הערכים הקבילים הם:
  • "containerApp"
  • "managedDevice"
  • "managedProfile"
  • "unmanagedProfile"
model string שם הדגם של המכשיר. מקור הערך: android.os.Build.MODEL.
policy nested object המדיניות שנאכפה במכשיר.
policy.autoUpdatePolicy string קובעת מתי אפשר להחיל עדכונים אוטומטיים של אפליקציות במכשיר.

חלופה מומלצת: autoUpdateMode, שמוגדר לכל אפליקציה, מספק גמישות רבה יותר לגבי תדירות העדכון.

כשהמדיניות autoUpdateMode מוגדרת כ-AUTO_UPDATE_POSTPONED או כ-AUTO_UPDATE_HIGH_PRIORITY, ל-autoUpdatePolicy אין השפעה.

השדה "ChoiceToTheUser" מאפשר למשתמש להגדיר את מדיניות עדכון האפליקציות. האפשרות 'תמיד' מפעילה עדכונים אוטומטיים. האפשרות "never" משביתה את העדכונים האוטומטיים. האפשרות 'wifiOnly' מפעילה עדכונים אוטומטיים רק כשהמכשיר מחובר ל-Wi-Fi.

הערכים הקבילים הם:
  • "always"
  • "choiceToTheUser"
  • "never"
  • "wifiOnly"
policy.deviceReportPolicy string האם המכשיר מדווח על מצב האפליקציה ל-EMM. ערך ברירת המחדל הוא "deviceReportDisabled".

הערכים הקבילים הם:
  • "deviceReportDisabled"
  • "deviceReportEnabled"
policy.maintenanceWindow nested object יש לעדכן את חלון התחזוקה שקובע מתי אפליקציות שפועלות בחזית.
policy.maintenanceWindow.durationMs long משך הזמן של חלון התחזוקה, באלפיות השנייה. משך הזמן חייב להיות בין 30 דקות ל-24 שעות (כולל).
policy.maintenanceWindow.startTimeAfterMidnightMs long שעת ההתחלה של חלון התחזוקה, באלפיות השנייה אחרי חצות במכשיר. Windows יכול להתפרס על פני חצות.
policy.productAvailabilityPolicy string הזמינות שהוענקה למכשיר לגבי המוצרים שצוינו. האפשרות 'הכול' מעניקה למכשיר גישה לכל המוצרים, בלי קשר לסטטוס האישור. האפשרות 'הכל' לא מפעילה חשיפה אוטומטית של טראקים של 'אלפא' או 'בטא'. "רשימת היתרים" מעניקה למכשיר גישה למוצרים שצוינו ב-productPolicy[]. אפשר להוסיף לרשימת ההיתרים רק מוצרים שאושרו או מוצרים שאושרו בעבר (מוצרים עם אישור שבוטל). אם לא תזינו ערך, הזמינות שמוגדרת ברמת המשתמש תחול כברירת מחדל.

הערכים הקבילים הם:
  • "all"
  • "whitelist"
policy.productPolicy[] list הרשימה של מדיניות המוצרים. המאפיין productAvailabilityPolicy צריך להיות מוגדר לערך WHITELIST או ALL כדי שמדיניות המוצר תחול.
policy.productPolicy[].autoInstallPolicy nested object מדיניות ההתקנה האוטומטית של המוצר.
policy.productPolicy[].autoInstallPolicy.autoInstallConstraint[] list המגבלות להתקנה אוטומטית של האפליקציה. ניתן לציין אילוץ אחד לכל היותר.

policy.productPolicy[].autoInstallPolicy.autoInstallConstraint[].chargingStateConstraint string מגבלה על מצב הטעינה.

הערכים הקבילים הם:
  • "chargingNotRequired"
  • "chargingRequired"
policy.productPolicy[].autoInstallPolicy.autoInstallConstraint[].deviceIdleStateConstraint string מגבלת מצב לא פעיל של המכשיר.

הערכים הקבילים הם:
  • "deviceIdleNotRequired"
  • "deviceIdleRequired"
policy.productPolicy[].autoInstallPolicy.autoInstallConstraint[].networkTypeConstraint string מגבלה על סוג הרשת.

הערכים הקבילים הם:
  • "anyNetwork"
  • "unmeteredNetwork"
policy.productPolicy[].autoInstallPolicy.autoInstallMode string מצב ההתקנה האוטומטית. אם המדיניות לא מוגדרת, ברירת המחדל היא "doNotAutoInstall". אפליקציה מותקנת באופן אוטומטי ללא קשר לחלון תחזוקה מוגדר.

הערכים הקבילים הם:
  • "autoInstallOnce"
  • "doNotAutoInstall"
  • "forceAutoInstall"
policy.productPolicy[].autoInstallPolicy.autoInstallPriority integer עדיפות ההתקנה, כמספר שלם ללא סימן. מספר נמוך יותר פירושו עדיפות גבוהה יותר.
policy.productPolicy[].autoInstallPolicy.minimumVersionCode integer גרסת האפליקציה המינימלית. אם מותקנת גרסה נמוכה יותר של האפליקציה, היא תעודכן באופן אוטומטי בהתאם לאילוצי ההתקנה האוטומטית, במקום להמתין לעדכון האוטומטי הרגיל. אפשר להגדיר קוד גרסה מינימלי ל-20 אפליקציות לכל היותר בכל מכשיר.
policy.productPolicy[].autoUpdateMode string מצב העדכון האוטומטי של המוצר. כשמשתמשים בערך autoUpdateMode, הוא תמיד מקבל עדיפות על פני הבחירה של המשתמש. לכן כשמשתמש מבצע שינויים בהגדרות המכשיר באופן ידני, המערכת מתעלמת מהשינויים האלה.

הערכים הקבילים הם:
  • "autoUpdateDefault"
  • "autoUpdateHighPriority"
  • "autoUpdatePostponed"
policy.productPolicy[].enterpriseAuthenticationAppLinkConfigs[] list הגדרה של כתובת URL לאימות לאפליקציית מאמת החשבונות של ספק זהויות. כך אפשר להפעיל את אפליקציית מאמת החשבונות של ספק הזהויות במהלך האימות באפליקציה פרטית באמצעות Android WebView. אפליקציית מאמת החשבונות אמורה כבר להיות ה-handler שמוגדר כברירת מחדל לכתובת ה-URL לאימות במכשיר.
policy.productPolicy[].enterpriseAuthenticationAppLinkConfigs[].uri string כתובת URL לאימות.
policy.productPolicy[].managedConfiguration nested object התצורה המנוהלת של המוצר.
policy.productPolicy[].managedConfiguration.configurationVariables nested object מכילה את המזהה של פרופיל ההגדרות האישיות המנוהלות ואת קבוצת משתני התצורה (אם יש) שהוגדרו למשתמש.
policy.productPolicy[].managedConfiguration.configurationVariables.kind string
policy.productPolicy[].managedConfiguration.configurationVariables.mcmId string מזהה ההגדרות של ההגדרות המנוהלות.
policy.productPolicy[].managedConfiguration.configurationVariables.variableSet[] list קבוצת המשתנים שמשויכת למשתמש.
policy.productPolicy[].managedConfiguration.configurationVariables.variableSet[].kind string
policy.productPolicy[].managedConfiguration.configurationVariables.variableSet[].placeholder string מחרוזת ה-placeholder; מוגדרת על ידי EMM.
policy.productPolicy[].managedConfiguration.configurationVariables.variableSet[].userValue string הערך של ה-placeholder, הספציפי למשתמש.
policy.productPolicy[].managedConfiguration.kind string הוצא משימוש.

policy.productPolicy[].managedConfiguration.managedProperty[] list קבוצת המאפיינים המנוהלים של ההגדרה הזו.
policy.productPolicy[].managedConfiguration.managedProperty[].key string המפתח הייחודי שמזהה את הנכס.
policy.productPolicy[].managedConfiguration.managedProperty[].valueBool boolean הערך הבוליאני - יופיע רק אם סוג הנכס הוא בוליאני.
policy.productPolicy[].managedConfiguration.managedProperty[].valueBundle nested object החבילה של הנכסים המנוהלים – האפשרות הזו תופיע רק אם סוג הנכס הוא חבילה.
policy.productPolicy[].managedConfiguration.managedProperty[].valueBundle.managedProperty[] list רשימת הנכסים המנוהלים.
policy.productPolicy[].managedConfiguration.managedProperty[].valueBundleArray[] list רשימת החבילות של נכסים - תופיע רק אם סוג הנכס הוא bundle_array.
policy.productPolicy[].managedConfiguration.managedProperty[].valueBundleArray[].managedProperty[] list רשימת הנכסים המנוהלים.
policy.productPolicy[].managedConfiguration.managedProperty[].valueInteger integer ערך המספר השלם - יוצג רק אם סוג הנכס הוא מספר שלם.
policy.productPolicy[].managedConfiguration.managedProperty[].valueString string ערך המחרוזת – יופיע רק אם סוג הנכס הוא מחרוזת, בחירה או מוסתר.
policy.productPolicy[].managedConfiguration.managedProperty[].valueStringArray[] list רשימת ערכי המחרוזת - תופיע רק אם סוג הנכס הוא בחירה מרובה.
policy.productPolicy[].managedConfiguration.productId string מזהה המוצר שעבורו משמשת ההגדרה המנוהלת, למשל 'app:com.google.android.gm'.
policy.productPolicy[].productId string המזהה של המוצר. לדוגמה, "app:com.google.android.gm".
policy.productPolicy[].trackIds[] list הרשאת גישה למכשיר למסלולי ההפצה של המוצרים שצוינו, שזוהו על ידי trackIds. כדי לקבל את רשימת מסלולי ההפצה של מוצר, צריך להתקשר אל Products.Get.
policy.productPolicy[].tracks[] list הוּצא משימוש. במקומה צריך להשתמש במדיניות trackIds.
product string שם המוצר של המכשיר. מקור הערך: android.os.Build.PRODUCT.
report nested object הדוח על המכשיר עודכן בהתאם למצבים האחרונים של האפליקציה.
report.appState[] list רשימה של מצבי האפליקציה שהוגדרו על ידי האפליקציות המנוהלות במכשיר. מצבי האפליקציה מוגדרים על ידי מפתחי האפליקציה. השדה הזה תמיד יופיע.
report.appState[].keyedAppState[] list רשימת מצבים של האפליקציה במפתח. השדה הזה תמיד יופיע.
report.appState[].keyedAppState[].data string שדה נוסף שמיועד לנתונים קריאים למחשבים. לדוגמה, מספר או אובייקט JSON. כדי למנוע XSS, מומלץ להסיר מהנתונים כל HTML לפני הצגתו.
report.appState[].keyedAppState[].key string מפתח שמציין בשביל מה האפליקציה מספקת את המצב. תוכן המפתח מוגדר על ידי מפתח האפליקציה. כדי למנוע XSS, מומלץ להסיר כל קוד HTML מהמפתח לפני הצגתו. השדה הזה תמיד יופיע.
report.appState[].keyedAppState[].message string הודעה בפורמט חופשי שבודק אנושי יכול לקרוא את מצב האפליקציה. לדוגמה, הודעת שגיאה. כדי למנוע XSS, אנחנו ממליצים להסיר כל קוד HTML מההודעה לפני הצגתו.
report.appState[].keyedAppState[].severity string רמת החומרה של מצב האפליקציה. השדה הזה תמיד יופיע.

הערכים הקבילים הם:
  • "severityError"
  • "severityInfo"
report.appState[].keyedAppState[].stateTimestampMillis long חותמת הזמן של המועד שבו האפליקציה הגדירה את המצב באלפיות השנייה מתקופה של זמן מערכת. השדה הזה תמיד יופיע.
report.appState[].packageName string שם החבילה של האפליקציה. השדה הזה תמיד יופיע.
report.lastUpdatedTimestampMillis long חותמת הזמן של עדכון הדוח האחרון, באלפיות השנייה מאז תקופת הזמן של המערכת. השדה הזה תמיד יופיע.
retailBrand string מותג הקמעונאי של המכשיר, אם הוגדר. ראו android.os.Build.BRAND
sdkVersion integer גרסת תאימות ל-API.

שיטות

forceReportUpload
העלאת דוח שמכיל את השינויים במצבי האפליקציה במכשיר מאז יצירת הדוח האחרון. אפשר לקרוא לשיטה הזו עד 3 פעמים בכל 24 שעות למכשיר נתון.
get
מאחזר את הפרטים של המכשיר.
getState
מאחזר אם הגישה של המכשיר לשירותי Google מופעלת או מושבתת. מצב המכשיר תקף רק אם אכיפת כללי המדיניות לניהול הניידות בארגון (EMM) במכשירי Android מופעלת במסוף Google Admin. אחרת, המערכת מתעלמת ממצב המכשיר וכל המכשירים מורשים לגשת לשירותי Google. האפשרות הזו נתמכת רק למשתמשים המנוהלים על ידי Google.
list
מאחזר את המזהים של כל המכשירים של המשתמש.
setState
מגדיר אם הגישה של מכשיר לשירותי Google מופעלת או מושבתת. מצב המכשיר תקף רק אם אכיפת כללי המדיניות לניהול הניידות בארגון (EMM) במכשירי Android מופעלת במסוף Google Admin. אחרת, המערכת מתעלמת ממצב המכשיר וכל המכשירים מורשים לגשת לשירותי Google. האפשרות הזו נתמכת רק למשתמשים המנוהלים על ידי Google.
עדכון
מתבצע עדכון של מדיניות המכשיר.

כדי להבטיח שהמדיניות נאכפת כראוי, צריך למנוע מחשבונות לא מנוהלים גישה ל-Google Play על ידי הגדרה של allowed_accounts בתצורה המנוהלת של חבילת Google Play. למידע נוסף, ראו הגבלת חשבונות ב-Google Play.