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 — использовать операцию Получить пользователя . Используйте адрес электронной почты администратора или значение уникального 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 — использовать операцию Получить пользователя . Используйте адрес электронной почты администратора или значение уникального id пользователя администратора в параметре пути userKey операции.
  • 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 — использовать операцию Получить пользователя . Используйте адрес электронной почты администратора или значение уникального id пользователя администратора в параметре пути userKey операции.
  • 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 — использовать операцию Получить пользователя . Используйте адрес электронной почты администратора или значение уникального 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 — использовать операцию Получить пользователя . Используйте адрес электронной почты администратора или значение уникального id пользователя администратора в параметре пути userKey операции.

Свойства запроса и ответа см. в Справочнике 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 .