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

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

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

בדוגמאות האלה, placeholders‏ 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.