Directory API: מכשירי ChromeOS

אחזור של כל מכשירי ChromeOS בחשבון

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

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

  • השדה customerId הוא מזהה ייחודי של חשבון Google של הלקוח.
  • כאדמינים של החשבון, אתם יכולים להשתמש גם במחרוזת my_customer שמייצגת את customerId של החשבון. אפשר לקבל את הערך של customerId גם באמצעות הפעולה Retrieve a user. משתמשים בכתובת האימייל של האדמין או בערך המשתמש הייחודי id של האדמין בפרמטר הנתיב userKey של הפעולה.

למידע על מחרוזות השאילתות, הבקשות והתגובות, ראו חומר העזר בנושא API.

דוגמה: סינון מכשירים לפי משתמש

בדוגמה הזו מתבצע חיפוש של משתמש ספציפי באמצעות query=user:help desk. התשובה מכילה משאב chromeosdevice יחיד, שבו הערך של annotatedUser הוא help desk:

בקשת JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=user:help desk&orderBy=status
&sortOrder=ASCENDING&maxResults=100

תגובת JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "etag": "1234567890"
       "deviceId": "def456",
       "serialNumber": "234567",
       "status": "ACTIVE",
       "lastSync": "2013-03-05T17:30:04.325Z",
       "supportEndDate": "2014-04-05T17:30:04.325Z",
       "annotatedUser": "help desk",
       "annotatedLocation": "Mountain View help desk Chromebook",
       "annotatedAssetId": "1234567890",
       "notes": "Loaned from support",
       "orderNumber": "1234",
       "willAutoRenew": true,
       "osVersion": "Browser Version 18.0",
       "platformVersion": "Platform Version 1415.2.0",
       "firmwareVersion": "Firmware Version 1.2.3.4",
       "bootMode": "validated",
       "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
       "orgUnitPath": "corp/engineering",
       "recentUsers": [
         {
           "type": "USER_TYPE_MANAGED",
           "email": "user@customer.com"
         }
       ],
       "activeTimeRanges": [
         {
           "date": "2012-04-05",
           "activeTime": "3600000"
         }
       ],
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

דוגמה: סינון מכשירים לפי מספר סידורי

בדוגמה הזו מתבצע חיפוש של מספר סידורי ספציפי באמצעות query=id:123456, כאשר 123456 הוא המספר הסידורי של המכשיר. התשובה שמוצגת למטה מכילה תשובה תואמת אחת, שבה המאפיין serialNumber תואם לערך החיפוש.

בקשת JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=id:123456&orderBy=status
&sortOrder=ASCENDING&maxResults=100

תגובת JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "deviceId": "abc123",
       "serialNumber": "123456",
       "status": "SHIPPED",
       "supportEndDate": "1404457200000",
       "model": "model_value",
       "meid": "meid_value",
       "macAddress": "mac_address_value",
       "orderNumber": "1234",
       "willAutoRenew": true
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

דוגמת התגובה הזו כוללת את המאפיינים model,‏ meid ו-macAddress. אם למכשיר אין את המאפיינים האלה, הם לא נכללים בתגובה. פרטים מלאים זמינים במאמר ייצוג המשאב Chromeosdevices.

ייצוא של רשימת MEID

השדה meid הוא מזהה הציוד הנייד (MEID) של הכרטיס הנייד מסוג 3G במכשיר ChromeOS. בדרך כלל משתמשים ב-MEID כשמוסיפים מכשיר לחבילת שירות של ספק סלולרי בתשלום לאחר השימוש. כדי לייצא את רשימת ה-MEID, משתמשים בבקשה GET הבאה ובערכים של nextPageToken כדי לאחזר את הרשימה המלאה של מזהי ה-MEID. כדי לשפר את הקריאוּת, דוגמת הקוד הזו כוללת החזרות שורה: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?fields=nextPageToken,chromeosdevices(meid)

אחזור של מכשיר ChromeOS

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

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • השדה customerId הוא מזהה ייחודי של חשבון Google של הלקוח.
  • כאדמינים של החשבון, אתם יכולים להשתמש גם במחרוזת my_customer שמייצגת את customerId של החשבון. אפשר לקבל את הערך של customerId גם באמצעות הפעולה Retrieve a user. משתמשים בכתובת האימייל של האדמין או בערך המשתמש הייחודי id של האדמין בפרמטר הנתיב userKey של הפעולה.
  • השדה deviceId הוא מזהה ייחודי של מכשיר, והוא מופיע בתגובה של הפעולה Retrieve all ChromeOS devices.

מידע על מחרוזות השאילתות, הבקשות והתגובות זמין בחומר העזר בנושא API.

בקשת JSON

דוגמה לבקשה. כדי לשפר את הקריאוּת, דוגמת הקוד הזו כוללת החזרות שורה: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

תגובת JSON

בקשה שהצליחה מחזירה את קוד הסטטוס HTTP 200. יחד עם קוד הסטטוס, התשובה מחזירה את המאפיינים של מכשיר ChromeOS: 

{
  "kind": "directory#chromeosdevice",
  "deviceId": "device_id_value",
  "serialNumber": "device_serial_number",
  "status": "ACTIVE",
  "lastSync": "2012-04-05T17:30:04.325Z",
  "supportEndDate": "2014-04-05T17:30:04.325Z",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "12345667890",
  "notes": "Loaned from support",
  "orderNumber": "123456",
  "willAutoRenew": true,
  "osVersion": "Browser Version 18.0",
  "platformVersion": "Platform Version 1415.2.0",
  "firmwareVersion": "Firmware Version 1.2.3.4",
  "bootMode": "validated"
  "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
  "orgUnitPath": "corp/engineering"
}

עדכון מכשיר ChromeOS

כדי לעדכן מכשיר ChromeOS, משתמשים בבקשה PUT הבאה וכוללים את ההרשאה שמתוארת בקטע אישור בקשות. כדי לשפר את הקריאוּת, דוגמת הקוד הזו כוללת החזרות שורה: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • השדה customerId הוא מזהה ייחודי של חשבון Google של הלקוח.
  • כאדמינים של החשבון, אתם יכולים להשתמש גם במחרוזת my_customer שמייצגת את customerId של החשבון. אפשר לקבל את הערך של customerId גם באמצעות הפעולה Retrieve a user. משתמשים בכתובת האימייל של האדמין או בערך המשתמש הייחודי id של האדמין בפרמטר הנתיב userKey של הפעולה.
  • השדה deviceId הוא מזהה ייחודי של מכשיר, והוא מופיע בתגובה של הפעולה Retrieve all ChromeOS devices.

מידע על מחרוזות השאילתות, הבקשות והתגובות זמין בחומר העזר בנושא API.

בקשת JSON

בקשת ה-JSON לדוגמה הבאה מעדכנת את המאפיינים annotatedUser,‏ annotatedLocation,‏ annotatedAssetId,‏ notes ו-orgUnitPath של מכשיר ChromeOS. כדי לשפר את הקריאוּת, דוגמת הקוד הזו כוללת החזרות שורה: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
 דוגמה לגוף הבקשה: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

בבקשת עדכון, צריך לכלול רק את הנכסים עם הערכים המעודכנים.

בקשה שהצליחה מחזירה את קוד הסטטוס HTTP 200. התגובה מחזירה את המאפיינים של מכשיר ChromeOS המעודכן, יחד עם קוד הסטטוס.

ביטול ההקצאה או השבתה של מכשירי ChromeOS

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

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/
devices/chromeos:batchChangeStatus

  • השדה customerId הוא מזהה ייחודי של חשבון Google של הלקוח.
  • כאדמינים של החשבון, אתם יכולים להשתמש גם במחרוזת my_customer שמייצגת את customerId של החשבון. אפשר לקבל את הערך של customerId גם באמצעות הפעולה Retrieve a user. משתמשים בכתובת האימייל של האדמין או בערך המשתמש הייחודי id של האדמין בפרמטר הנתיב userKey של הפעולה.

למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API.

בקשת JSON

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

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 גוף הבקשה להסרת הקצאה לדוגמה הוא: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
 גוף הבקשה להשבתה הוא: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

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

העברת מכשירי ChromeOS ליחידה ארגונית

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

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • השדה customerId הוא מזהה ייחודי של חשבון Google של הלקוח.
  • כאדמינים של החשבון, אתם יכולים להשתמש גם במחרוזת my_customer שמייצגת את customerId של החשבון. אפשר לקבל את הערך של customerId גם באמצעות הפעולה Retrieve a user. משתמשים בכתובת האימייל של האדמין או בערך המשתמש הייחודי id של האדמין בפרמטר הנתיב userKey של הפעולה.

למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API.

בקשת JSON

בקשת ה-JSON הבאה היא דוגמה לבקשה להעברת 3 מכשירי ChromeOS ליחידה ארגונית בשם /Marketing: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/chromeos/moveDevicesToOu?orgUnitPath=/Marketing

גוף הבקשה להעברת המכשיר הוא:

{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"]
}

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