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 можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора id.

Описание синтаксиса запроса, а также свойств запросов и ответов можно найти в документации по 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. Для удобства восприятия пример кода разделен на строки.

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 можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора id.
  • deviceId – это уникальный идентификатор устройства, который можно найти в ответе на запрос списка устройств с ChromeOS.

Описание синтаксиса запроса, а также свойств запросов и ответов можно найти в документации по 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 можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора id.
  • deviceId – это уникальный идентификатор устройства, который можно найти в ответе на запрос списка устройств с ChromeOS.

Описание синтаксиса запроса, а также свойств запросов и ответов можно найти в документации по 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 можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора id.

Описание свойств запросов и ответов можно найти в документации по 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 можно получить, запросив данные о пользователе. При этом в параметре пути userKey соответствующего оператора необходимо указать свой адрес электронной почты администратора или уникальный идентификатор администратора id.

Описание свойств запросов и ответов можно найти в документации по API.

Запрос JSON

Ниже приведен пример запроса JSON для перемещения трех устройств с 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.