Directory API: מכשירים ניידים

‫Google Workspace Directory API מאפשר לכם לנהל מכשירים ניידים בארגון. בדף הזה יש דוגמאות לאופן שבו אפשר לראות את רשימת המכשירים הניידים, לקבל פרטים על מכשיר ספציפי, וגם להוסיף או להסיר מכשיר.

במסמך הזה אנחנו יוצאים מנקודת הנחה שהשלמתם בהצלחה את הדרישות המוקדמות. במכשירי Android צריך להתקין את אפליקציית Device Policy. במכשירי iOS צריך לרשום את המכשירים בשירות Google Mobile Management.

בדוגמאות האלה, ערכי ה-placeholder customerId ו-resourceId מציינים את המקומות שבהם צריך לספק את המזהים האלה. אפשר לקבל את customerId באמצעות השיטה Users.get. ‫resourceId הוא מזהה ייחודי של Google למכשיר, והוא מופיע בתגובה של השיטה Retrieve all mobile devices.

אחזור כל המכשירים הניידים

כדי לאחזר את כל המכשירים הניידים בחשבון, משתמשים בבקשה GET הבאה וכוללים את ההרשאה שמתוארת במאמר הרשאת בקשות. בדוגמה הזו נעשה שימוש בהחזרות שורה כדי לשפר את הקריאות:

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}
  /devices/mobile?projection={BASIC|FULL}&query=query
  &orderBy=orderBy category&sortOrder={ASCENDING|DESCENDING}
  &pageToken=token for next results page
  &maxResults=max number of results per page

מאפייני הבקשה והתגובה מפורטים בהפניית ה-API.

תגובת JSON

{
   "kind": "directory#mobiledevices",
   "mobiledevices": [
    {
     "kind": "directory#mobiledevice",
     "resourceId": "resourceId",
     "deviceId": "deviceId",
     "name": [
      "Sales"
     ],
     "email": [
      "sales@example.com"
     ],
     "model": "Nexus 4",
     "os": "Android 4.2.2",
     "type": "ANDROID",
     "status": "APPROVED",
     "hardwareId": "1234567890",
     "firstSync": "2013-05-15T17:30:04.325Z",
     "lastSync": "2013-06-05T17:30:04.325Z",
     "userAgent": "Google Apps Device Policy 4.14",
   },
   {
     "kind": "directory#mobiledevice",
     "resourceId": "resourceId",
     "deviceId": "deviceId",
     "name": [
      "Liz"
     ],
     "email": [
      "liz@example.com"
     ],
     "model": "Galaxy Nexus",
     "os": "Android 4.2.2",
     "type": "ANDROID",
     "status": "APPROVED",
     "hardwareId": "9123456780",
     "firstSync": "2013-06-05T17:30:04.325Z",
     "lastSync": "2013-08-12T17:30:04.325Z",
     "userAgent": "Google Apps Device Policy 4.14",
    }
   ],
   "nextPageToken": "next_page_token_value"
  }

אחזור מכשיר נייד

כדי לאחזר את המאפיינים של מכשיר נייד, משתמשים בבקשת GET הבאה וכוללים את ההרשאה שמתוארת בקטע הרשאת בקשות. בדוגמה הזו נעשה שימוש בהחזרות שורה כדי לשפר את הקריאות:

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}
  /devices/mobile/resourceId?projection={FULL|BASIC}

מאפייני הבקשה והתגובה מפורטים בהפניית ה-API.

בקשת JSON

דוגמה לבקשה של resourceId:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
  mobile/resourceId?projection=FULL

תגובת JSON

{
   "kind": "directory#mobiledevice",
   "resourceId": "resourceId",
   "deviceId": "deviceId",
   "name": [
    "Sales3"
   ],
   "email": [
    "sales@example.com"
   ],
   "model": "Nexus 4",
   "os": "Android 4.2.2",
   "type": "ANDROID",
   "status": "APPROVED",
   "hardwareId": "1234567890",
   "firstSync": "2010-05-15T17:30:04.325Z",
   "lastSync": "2013-06-05T17:30:04.325Z",
   "userAgent": "Google Apps Device Policy 4.14",
  }

אישור מכשיר נייד

כדי לאשר מכשיר נייד, משתמשים בבקשה POST ומצרפים את ההרשאה שמתוארת במאמר בנושא אישור בקשות. בדוגמה הזו נעשה שימוש בהחזרות שורה כדי לשפר את הקריאות:

POST https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}
  /devices/mobile/resourceId/action

מאפייני הבקשה והתגובה מפורטים בהפניית ה-API.

בקשת JSON

בקשת ה-JSON הבאה מציגה בקשה לדוגמה לאישור מכשיר:

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices
  /mobile/resourceId/action

גוף הבקשה הוא:

{
    "action": "approve"
}

בקשה שמתבצעת בהצלחה מחזירה קוד סטטוס HTTP 200.

הסרת מכשיר נייד

כדי להסיר מכשיר נייד, משתמשים בבקשה הבאה DELETE ומצרפים את ההרשאה שמתוארת במאמר איך מאשרים בקשות. בדוגמה הזו נעשה שימוש בהחזרות שורה כדי לשפר את הקריאות:

DELETE https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}
  /devices/mobile/resourceId

מאפייני הבקשה והתגובה מפורטים בהפניית ה-API.

בקשה שמתבצעת בהצלחה מחזירה קוד סטטוס HTTP 200.