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 כדי לאחזר את הרשימה המלאה של מזהי MEID. כדי לשפר את הקריאוּת, דוגמת הקוד כוללת החזרת שורות: 

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 של מכשיר Chrome, annotatedLocation, annotatedAssetId, notes וגם orgUnitPath נכסים. כדי להיות קריאים, דוגמת הקוד הזו כוללת החזרות שורות: 

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.