Directory API: מכשירי Chrome

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

כדי להחזיר רשימה של כל מכשירי Chrome שהוקצו לחשבון, צריך להשתמש בבקשת 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 היא להשתמש בפעולה אחזור משתמש. צריך להשתמש בכתובת האימייל של האדמין או בערך 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 לנייד במכשיר Chrome. בדרך כלל משתמשים ב-MEID בעת הוספת מכשיר לתוכנית שירות בתשלום לאחר השימוש (postpay) של ספק אלחוטי. כדי לייצא את רשימת ה-MEID, משתמשים בבקשת GET הבאה ובערכי nextPageToken כדי לאחזר את הרשימה המלאה של MEIDs. כדי לשפר את הקריאוּת, דוגמת הקוד הזו כוללת החזרת שורה: 

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

אחזור מכשיר Chrome

כדי לאחזר מאפיינים של מכשיר Chrome, צריך להשתמש בבקשת 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 היא להשתמש בפעולה אחזור משתמש. צריך להשתמש בכתובת האימייל של האדמין או בערך id של המשתמש הייחודי של האדמין בפרמטר userKey של הפעולה.
  • הערך deviceId הוא מזהה ייחודי של מכשיר שנמצא בתגובה לפעולה אחזור כל מכשירי Chrome.

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

בקשת JSON

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

תגובת JSON

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

{
  "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"
}

עדכון מכשיר Chrome

כדי לעדכן מכשיר Chrome, צריך להשתמש בבקשת 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 היא להשתמש בפעולה אחזור משתמש. צריך להשתמש בכתובת האימייל של האדמין או בערך id של המשתמש הייחודי של האדמין בפרמטר userKey של הפעולה.
  • הערך deviceId הוא מזהה ייחודי של מכשיר שנמצא בתגובה לפעולה אחזור כל מכשירי Chrome.

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

בקשת JSON

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

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. יחד עם קוד הסטטוס, התגובה תחזיר את המאפיינים של מכשיר ה-Chrome המעודכן.

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

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

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

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

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

בקשת JSON

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

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.

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

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

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

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

בקשת JSON

בבקשת ה-JSON הבאה מוצגת בקשה לדוגמה להעברת 3 מכשירי Chrome ליחידה ארגונית בשם /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.