REST Resource: chromeosdevices

Ресурс: ChromeOsDevice

Устройства Google Chrome работают на базе Chrome OS . Подробнее о распространённых задачах API см. в Руководстве разработчика .

JSON-представление 
{
  "deviceId": string,
  "serialNumber": string,
  "status": string,
  "lastSync": string,
  "supportEndDate": string,
  "annotatedUser": string,
  "annotatedLocation": string,
  "notes": string,
  "model": string,
  "meid": string,
  "orderNumber": string,
  "willAutoRenew": boolean,
  "osVersion": string,
  "platformVersion": string,
  "firmwareVersion": string,
  "macAddress": string,
  "bootMode": string,
  "lastEnrollmentTime": string,
  "kind": string,
  "recentUsers": [
    {
      "type": string,
      "email": string
    }
  ],
  "activeTimeRanges": [
    {
      "activeTime": integer,
      "date": string
    }
  ],
  "ethernetMacAddress": string,
  "annotatedAssetId": string,
  "etag": string,
  "diskVolumeReports": [
    {
      "volumeInfo": [
        {
          "volumeId": string,
          "storageTotal": string,
          "storageFree": string
        }
      ]
    }
  ],
  "systemRamTotal": string,
  "cpuStatusReports": [
    {
      "reportTime": string,
      "cpuUtilizationPercentageInfo": [
        integer
      ],
      "cpuTemperatureInfo": [
        {
          "temperature": integer,
          "label": string
        }
      ]
    }
  ],
  "cpuInfo": [
    {
      "model": string,
      "architecture": string,
      "maxClockSpeedKhz": integer,
      "logicalCpus": [
        {
          "maxScalingFrequencyKhz": integer,
          "currentScalingFrequencyKhz": integer,
          "idleDuration": string,
          "cStates": [
            {
              "displayName": string,
              "sessionDuration": string
            }
          ]
        }
      ]
    }
  ],
  "deviceFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "systemRamFreeReports": [
    {
      "reportTime": string,
      "systemRamFreeInfo": [
        string
      ]
    }
  ],
  "lastKnownNetwork": [
    {
      "ipAddress": string,
      "wanIpAddress": string
    }
  ],
  "autoUpdateExpiration": string,
  "ethernetMacAddress0": string,
  "dockMacAddress": string,
  "manufactureDate": string,
  "orgUnitPath": string,
  "tpmVersionInfo": {
    "family": string,
    "specLevel": string,
    "manufacturer": string,
    "tpmModel": string,
    "firmwareVersion": string,
    "vendorSpecific": string
  },
  "screenshotFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "orgUnitId": string,
  "osUpdateStatus": {
    object (OsUpdateStatus)
  },
  "firstEnrollmentTime": string,
  "lastDeprovisionTimestamp": string,
  "deprovisionReason": enum (DeprovisionReason),
  "deviceLicenseType": enum (DeviceLicenseType),
  "backlightInfo": [
    {
      object (BacklightInfo)
    }
  ],
  "autoUpdateThrough": string,
  "extendedSupportEligible": boolean,
  "extendedSupportStart": string,
  "extendedSupportEnabled": boolean,
  "fanInfo": [
    {
      object (FanInfo)
    }
  ],
  "chromeOsType": enum (ChromeOsType),
  "diskSpaceUsage": {
    object (ByteUsage)
  },
  "osVersionCompliance": enum (Compliance)
}
Поля
deviceId

string

Уникальный идентификатор устройства Chrome.

serialNumber

string

Серийный номер устройства Chrome, указанный при его включении. Это значение совпадает с серийным номером в консоли администратора на вкладке «Устройства» Chrome OS .

status

string

Статус устройства.

Допустимые значения:

  • ACTIVE : Устройство зарегистрировано в домене.
  • DELINQUENT : Годовая лицензия на домен истёк, и устройство больше не получает политики и настройки. После покупки новой лицензии устройство вернётся в состояние ACTIVE .
  • PRE_PROVISIONED : Устройство зарегистрировано для автоматической регистрации . Устройство PRE_PROVISIONED можно переместить в другое организационное подразделение или удалить. После завершения регистрации устройство станет ACTIVE .
  • DEPROVISIONED : Устройство больше не подлежит регистрации в домене. Заказ отменён. Настройки устройства кэшированы на устройстве. При повторной активации устройства к нему будут применены последние системные настройки.
  • DISABLED : Устройство отключено администратором и не может быть использовано.
  • INACTIVE : Устройство не зарегистрировано в домене.
  • RETURN_ARRIVED : Получен запрос на замену данного устройства.
  • RETURN_REQUESTED : Был сделан запрос на замену этого устройства.
  • SHIPPED : Устройство отправлено из инвентаря Google. (Устарело)
  • UNKNOWN : Невозможно определить состояние устройства.
lastSync

string

Дата и время последней синхронизации устройства с параметрами политики в консоли администратора. Значение представлено в формате даты и времени ISO 8601. Время представляет собой полную дату с добавлением часов, минут и секунд в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 .

supportEndDate

string

Конечная дата начала поддержки устройства. Это применимо только к устройствам, приобретенным напрямую у Google. Значение имеет формат даты и времени ISO 8601. Время представляет собой полную дату с добавлением часов, минут и секунд в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 .

annotatedUser

string

Пользователь устройства, указанный администратором. Максимальная длина — 100 символов. Допускаются пустые значения.

annotatedLocation

string

Адрес или местоположение устройства, указанное администратором. Максимальная длина — 200 символов. Допускаются пустые значения.

notes

string

Заметки об этом устройстве добавлены администратором. Поиск по этому свойству можно выполнить с помощью параметра query метода list . Максимальная длина — 500 символов. Допускаются пустые значения.

model

string

Информация о модели устройства. Если у устройства нет этой информации, это свойство не включается в ответ.

meid

string

Идентификатор мобильного оборудования (MEID) или международный идентификатор мобильного оборудования (IMEI) для карты мобильной связи 3G в мобильном устройстве. MEID/IMEI обычно используется при добавлении устройства в тарифный план оператора беспроводной связи с постоплатой. Если у устройства нет этой информации, это свойство не включается в ответ. Подробнее об экспорте списка MEID/IMEI см. в Руководстве разработчика .

orderNumber

string

Номер заказа устройства. Номер заказа есть только у устройств, приобретённых напрямую у Google.

willAutoRenew

boolean

Определяет, будет ли устройство автоматически продлеваться после даты окончания поддержки. Это свойство доступно только для чтения.

osVersion

string

Версия операционной системы устройства Chrome.

platformVersion

string

Версия платформы устройства Chrome.

firmwareVersion

string

Версия прошивки устройства Chrome.

macAddress

string

MAC-адрес беспроводного устройства. Если у устройства нет этой информации, она не включается в ответ.

bootMode

string

Режим загрузки устройства. Возможные значения:

  • Verified : на устройстве установлена ​​действительная версия Chrome OS.
  • Dev : аппаратный переключатель разработчика на устройстве включён. При загрузке устройство запускает оболочку командной строки. Пример переключателя разработчика см. в информации для разработчиков Chromebook .
lastEnrollmentTime

string

Дата и время последней регистрации устройства. Значение указано в формате даты и времени ISO 8601. Время — это полная дата с добавлением часов, минут и секунд в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 . Подробнее об автоматической и ручной регистрации см. в справочном центре Chrome .

kind

string

Тип ресурса. Для ресурса Chromeosdevices значение — admin#directory#chromeosdevice .

recentUsers[]

object

Список недавних пользователей устройства в порядке убывания времени последнего входа в систему.

recentUsers[].type

string

Тип пользователя.

Допустимые значения:

  • USER_TYPE_MANAGED : Пользователь управляется доменом.
  • USER_TYPE_UNMANAGED : Пользователь не управляется доменом.
recentUsers[].email

string

Адрес электронной почты пользователя. Присутствует только для типа пользователя USER_TYPE_MANAGED .

activeTimeRanges[]

object

Список активных временных диапазонов (только для чтения).

activeTimeRanges[].activeTime

integer

Продолжительность использования в миллисекундах.

activeTimeRanges[].date

string

Дата использования.

ethernetMacAddress

string

MAC-адрес устройства на сетевом интерфейсе Ethernet.

annotatedAssetId

string

Идентификатор актива, отмеченный администратором или указанный во время регистрации.

etag

string

ETag ресурса.

diskVolumeReports[]

object

Отчеты о дисковом пространстве и другая информация о смонтированных/подключенных томах.

diskVolumeReports[].volumeInfo[]

object

Тома дисков

diskVolumeReports[].volumeInfo[].volumeId

string

Идентификатор тома

diskVolumeReports[].volumeInfo[].storageTotal

string ( int64 format)

Общий объем дискового пространства [в байтах]

diskVolumeReports[].volumeInfo[].storageFree

string ( int64 format)

Свободное место на диске [в байтах]

systemRamTotal

string ( int64 format)

Общий объем оперативной памяти на устройстве в байтах

cpuStatusReports[]

object

Отчеты об использовании и температуре ЦП (только для чтения)

cpuStatusReports[].reportTime

string

Дата и время получения отчета.

cpuStatusReports[].cpuUtilizationPercentageInfo[]

integer

cpuStatusReports[].cpuTemperatureInfo[]

object

Список образцов температуры процессора.

cpuStatusReports[].cpuTemperatureInfo[].temperature

integer

Температура в градусах Цельсия.

cpuStatusReports[].cpuTemperatureInfo[].label

string

метка ЦП

cpuInfo[]

object

Информация о характеристиках процессора устройства.

cpuInfo[].model

string

Название модели процессора.

cpuInfo[].architecture

string

Архитектура центрального процессора.

cpuInfo[].maxClockSpeedKhz

integer

Максимальная тактовая частота процессора в кГц.

cpuInfo[].logicalCpus[]

object

Информация для логических процессоров

cpuInfo[].logicalCpus[].maxScalingFrequencyKhz

integer

Максимальная частота, на которой может работать ЦП, согласно политике.

cpuInfo[].logicalCpus[].currentScalingFrequencyKhz

integer

Текущая частота, на которой работает процессор.

cpuInfo[].logicalCpus[].idleDuration

string ( Duration format)

Время простоя с момента последней загрузки.

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s ». Пример: "3.5s" .

cpuInfo[].logicalCpus[].cStates[]

object

C-состояния отображают состояние энергопотребления процессора. Подробнее см. в документации производителя процессора.

cpuInfo[].logicalCpus[].cStates[].displayName

string

Название штата.

cpuInfo[].logicalCpus[].cStates[].sessionDuration

string ( Duration format)

Время, проведенное в состоянии с момента последней перезагрузки.

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s ». Пример: "3.5s" .

deviceFiles[]

object

Список файлов устройства для загрузки (только для чтения)

deviceFiles[].name

string

Имя файла

deviceFiles[].type

string

Тип файла

deviceFiles[].downloadUrl

string

URL для загрузки файла

deviceFiles[].createTime

string

Дата и время создания файла

systemRamFreeReports[]

object

Отчеты об объеме доступной оперативной памяти (только для чтения)

systemRamFreeReports[].reportTime

string

Дата и время получения отчета.

systemRamFreeReports[].systemRamFreeInfo[]

string ( int64 format)

lastKnownNetwork[]

object

Содержит последнюю известную сеть (только для чтения)

lastKnownNetwork[].ipAddress

string

IP-адрес.

lastKnownNetwork[].wanIpAddress

string

IP-адрес WAN.

autoUpdateExpiration
(deprecated)

string ( int64 format)

(Только для чтения) Временная метка, после которой устройство перестанет получать обновления или поддержку Chrome. Вместо этого используйте «autoUpdateThrough».

ethernetMacAddress0

string

MAC-адрес (только для чтения), используемый внутренним Ethernet-портом Chromebook и встроенным сетевым интерфейсом (Ethernet). Формат — двенадцать (12) шестнадцатеричных цифр без разделителей (заглавных букв). Это актуально только для некоторых устройств.

dockMacAddress

string

(Только для чтения) Встроенный MAC-адрес док-станции, к которой подключено устройство. Заводские настройки MAC-адреса, назначенного для использования док-станцией. Он зарезервирован специально для политики сквозного доступа к MAC-адресам устройств. Формат — двенадцать (12) шестнадцатеричных цифр без разделителей (заглавных букв). Это актуально только для некоторых устройств.

manufactureDate

string

(Только для чтения) Дата изготовления устройства в формате гггг-мм-дд.

orgUnitPath

string

Полный родительский путь с именем организационного подразделения, связанного с устройством. Имена путей нечувствительны к регистру. Если родительское организационное подразделение является организацией верхнего уровня, оно представлено косой чертой / . Это свойство можно обновить с помощью API. Подробнее о создании организационной структуры для устройства см. в справочном центре администрирования .

tpmVersionInfo

object

Доверенный платформенный модуль (TPM) (только для чтения)

tpmVersionInfo.family

string

Семейство TPM. Мы используем кодировку в стиле TPM 2.0, например:
TPM 1.2: "1.2" -> 312e3200
TPM 2.0: "2.0" -> 322e3000

tpmVersionInfo.specLevel

string

Уровень спецификации TPM. См. спецификацию библиотеки для TPM 2.0 и основную спецификацию для TPM 1.2.

tpmVersionInfo.manufacturer

string

Код производителя TPM.

tpmVersionInfo.tpmModel

string

Номер модели TPM.

tpmVersionInfo.firmwareVersion

string

Версия прошивки TPM.

tpmVersionInfo.vendorSpecific

string

Информация, специфичная для поставщика, например идентификатор поставщика.

screenshotFiles[]

object

Список файлов скриншотов для загрузки. Тип файла всегда "SCREENSHOT_FILE". (Только для чтения)

screenshotFiles[].name

string

Имя файла

screenshotFiles[].type

string

Тип файла

screenshotFiles[].downloadUrl

string

URL для загрузки файла

screenshotFiles[].createTime

string

Дата и время создания файла

orgUnitId

string

Уникальный идентификатор организационного подразделения. orgUnitPath — это удобочитаемая версия orgUnitId. Значение orgUnitPath может изменяться при переименовании организационного подразделения в пути, тогда как orgUnitId не может быть изменено для одного организационного подразделения. Это свойство можно обновить с помощью API. Подробнее о создании организационной структуры для вашего устройства см. в справочном центре администрирования .

osUpdateStatus

object ( OsUpdateStatus )

Статус обновлений ОС для устройства.

firstEnrollmentTime

string

Дата и время первой регистрации устройства.

lastDeprovisionTimestamp

string

(Только для чтения) Дата и время последнего отключения устройства.

deprovisionReason

enum ( DeprovisionReason )

(Только для чтения) Причина деактивации.

deviceLicenseType

enum ( DeviceLicenseType )

Только вывод. Тип лицензии устройства.

backlightInfo[]

object ( BacklightInfo )

Только вывод. Содержит информацию о подсветке устройства.

autoUpdateThrough

string

Только вывод. Временная метка, после которой устройство перестанет получать обновления или поддержку Chrome.

extendedSupportEligible

boolean

Только вывод. Требуется ли для устройства расширенная поддержка.

extendedSupportStart

string

Только вывод. Дата начала расширенной поддержки устройства для автоматических обновлений.

extendedSupportEnabled

boolean

Только вывод. Включена ли на устройстве расширенная политика поддержки.

fanInfo[]

object ( FanInfo )

Только вывод. Информация о вентиляторе устройства.

chromeOsType

enum ( ChromeOsType )

Только вывод. Тип Chrome OS устройства.

diskSpaceUsage

object ( ByteUsage )

Только вывод. Сколько места на диске доступно устройству и используется в данный момент.

osVersionCompliance

enum ( Compliance )

Только вывод. Статус соответствия версии ОС политике устройства.

OsUpdateStatus

Содержит информацию о текущем статусе обновления ОС.

JSON-представление 
{
  "state": enum (UpdateState),
  "targetOsVersion": string,
  "targetKioskAppVersion": string,
  "updateTime": string,
  "updateCheckTime": string,
  "rebootTime": string
}
Поля
state

enum ( UpdateState )

Состояние обновления ОС.

targetOsVersion

string

Новая версия платформы образа ОС, загружаемого и применяемого. Устанавливается только при статусе обновления UPDATE_STATUS_DOWNLOAD_IN_PROGRESS или UPDATE_STATUS_NEED_REBOOT. Обратите внимание, что в некоторых крайних случаях, например при перезапуске модуля обновления без перезагрузки, вместо UPDATE_STATUS_NEED_REBOOT может быть фиктивное значение "0.0.0.0".

targetKioskAppVersion

string

Новая требуемая версия платформы из ожидаемого обновленного приложения киоска.

updateTime

string

Дата и время последнего успешного обновления ОС.

updateCheckTime

string

Дата и время последней проверки обновлений.

rebootTime

string

Дата и время последней перезагрузки.

UpdateState

Состояние обновления ОС.

Перечисления
UPDATE_STATE_UNSPECIFIED Состояние обновления не указано.
UPDATE_STATE_NOT_STARTED Ожидается обновление, но оно еще не началось.
UPDATE_STATE_DOWNLOAD_IN_PROGRESS Ожидаемое обновление загружается.
UPDATE_STATE_NEED_REBOOT Устройство готово к установке обновления, но его необходимо перезагрузить.

DeprovisionReason

Причина деактивации устройства ChromeOS.

Перечисления
DEPROVISION_REASON_UNSPECIFIED Причина депровизации неизвестна.
DEPROVISION_REASON_SAME_MODEL_REPLACEMENT Замена той же модели. У вас есть право на возврат материалов (RMA), или вы заменяете неисправное устройство по гарантии на устройство той же модели.
DEPROVISION_REASON_UPGRADE

Устройство было модернизировано.

DEPROVISION_REASON_DOMAIN_MOVE

Домен устройства был изменен.

DEPROVISION_REASON_SERVICE_EXPIRATION

Срок действия обслуживания устройства истек.

DEPROVISION_REASON_OTHER

Устройство было деактивировано по устаревшей причине, которая больше не поддерживается.

DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT Замена другой модели. Вы заменяете это устройство на обновлённую или более новую модель.
DEPROVISION_REASON_RETIRING_DEVICE Вывод из эксплуатации. Вы жертвуете, утилизируете или иным образом выводите устройство из эксплуатации.
DEPROVISION_REASON_UPGRADE_TRANSFER Перенос обновления ChromeOS Flex. Это устройство ChromeOS Flex, которое вы заменяете на Chromebook в течение года.
DEPROVISION_REASON_NOT_REQUIRED Причина не требовалась. Например, лицензии были возвращены в лицензионный пул клиента.
DEPROVISION_REASON_REPAIR_CENTER Устройство было деинициализировано в сервисном центре. Восстановление возможно только в сервисном центре во время процедуры возврата товара (RMA).

Тип лицензии устройства

Тип лицензии этого устройства.

Перечисления
DEVICE_LICENSE_TYPE_UNSPECIFIED Тип лицензии неизвестен.
ENTERPRISE Устройство поставляется в комплекте с бессрочной подпиской Chrome Enterprise Upgrade.
ENTERPRISE_UPGRADE

Для устройства доступна ежегодная автономная подписка на Chrome Enterprise Upgrade.

EDUCATION_UPGRADE

Устройство имеет постоянную автономную версию Chrome Education Upgrade.

EDUCATION Устройство поставляется в комплекте с бессрочной подпиской Chrome Education Upgrade.
KIOSK_UPGRADE Для устройства предусмотрено ежегодное обновление киоска.
ENTERPRISE_UPGRADE_PERPETUAL Указывает, что устройство использует автономную постоянную версию Chrome Enterprise Upgrade, лицензию Chrome Enterprise.
ENTERPRISE_UPGRADE_FIXED_TERM Указывает, что устройство использует автономную версию Chrome Enterprise Upgrade с фиксированным сроком действия, лицензию Chrome Enterprise.
EDUCATION_UPGRADE_PERPETUAL Указывает на то, что устройство использует автономную бессрочную лицензию Chrome Education Upgrade (также известную как бессрочная лицензия Chrome EDU).
EDUCATION_UPGRADE_FIXED_TERM Указывает на то, что устройство использует автономную лицензию Chrome Education Upgrade с фиксированным сроком действия (также известную как лицензия Chrome EDU с фиксированным сроком действия).

ПодсветкаИнформация

Информация о подсветке устройства.

JSON-представление 
{
  "path": string,
  "maxBrightness": integer,
  "brightness": integer
}
Поля
path

string

Только вывод. Путь к этой подсветке в системе. Полезно, если вызывающему абоненту необходимо сопоставить её с другой информацией.

maxBrightness

integer

Только выход. Максимальная яркость подсветки.

brightness

integer

Только вывод. Текущая яркость подсветки, от 0 до maxBrightness.

ФанИнфо

Информация о вентиляторе устройства.

JSON-представление 
{
  "speedRpm": integer
}
Поля
speedRpm

integer

Только выход. Скорость вентилятора в об/мин.

ChromeOsType

Тип Chrome OS устройства.

Перечисления
CHROME_OS_TYPE_UNSPECIFIED Тип Chrome OS не указан.
CHROME_OS_FLEX Тип Chrome OS Chrome OS Flex.
CHROME_OS Тип Chrome OS Chrome OS.

ByteUsage

Представляет собой емкость данных с некоторым объемом текущего использования в байтах.

JSON-представление 
{
  "capacityBytes": string,
  "usedBytes": string
}
Поля
capacityBytes

string ( int64 format)

Только вывод. Общая ёмкость в байтах.

usedBytes

string ( int64 format)

Только вывод. Текущее значение использования в байтах.

Согласие

Статус соответствия версии ОС политике устройства.

Перечисления
COMPLIANCE_UNSPECIFIED Статус соответствия не указан.
COMPLIANT Статус соответствия соответствует.
PENDING Ожидается статус соответствия.
NOT_COMPLIANT Статус соответствия: не соответствует.

Методы

action
(deprecated)

 Вместо этого используйте BatchChangeChromeOsDeviceStatus .

get

 Извлекает свойства устройства Chrome OS.

list

 Возвращает постраничный список устройств Chrome OS в учетной записи.

moveDevicesToOu

 Перемещает или вставляет несколько устройств Chrome OS в организационное подразделение.

patch

 Обновляет обновляемые свойства устройства, такие как annotatedUser , annotatedLocation , notes , orgUnitPath или annotatedAssetId .

update

 Обновляет обновляемые свойства устройства, такие как annotatedUser , annotatedLocation , notes , orgUnitPath или annotatedAssetId .