REST Resource: chromeosdevices

Recurso: ChromeOsDevice

Os dispositivos Google Chrome são executados no Chrome OS. Para mais informações sobre tarefas comuns de API, consulte o Guia para desenvolvedores.

Representação 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)
    }
  ]
}
Campos
deviceId

string

O ID exclusivo do dispositivo Chrome.
serialNumber

string

O número de série do dispositivo Chrome inserido quando o dispositivo foi ativado. Esse valor é o mesmo que o Número de série do Admin Console na guia Dispositivos ChromeOS.
status

string

O status do dispositivo.

Os valores aceitos são:

  • ACTIVE: o dispositivo está registrado no domínio.
  • DELINQUENT: a licença anual do domínio expirou e o dispositivo não recebe mais políticas e configurações. Quando uma nova licença é comprada, o dispositivo retorna ao estado ACTIVE.
  • PRE_PROVISIONED: o dispositivo foi registrado no registro sem toque. Um dispositivo PRE_PROVISIONED pode ser movido para outra unidade organizacional ou excluído. Quando o registro for concluído, o dispositivo será ACTIVE.
  • DEPROVISIONED: o dispositivo não está mais qualificado para ser registrado no domínio. O pedido foi cancelado. As configurações do dispositivo foram armazenadas em cache. Se o dispositivo for ativado novamente, as configurações mais recentes do sistema serão aplicadas a ele.
  • DISABLED: o dispositivo foi desativado pelo administrador e não pode ser usado.
  • INACTIVE: o dispositivo não está registrado no domínio.
  • RETURN_ARRIVED: a solicitação de substituição deste dispositivo chegou.
  • RETURN_REQUESTED: foi feita uma solicitação para substituir este dispositivo.
  • SHIPPED: o dispositivo é enviado do inventário do Google. (uso suspenso)
  • UNKNOWN: o status do dispositivo não pode ser determinado.
lastSync

string

A data e a hora da última sincronização do dispositivo com as configurações de política no Admin Console. O valor está no formato de data e hora ISO 8601. O horário é a data completa mais horas, minutos e segundos no formato YYYY-MM-DDThh:mm:ssTZD. Por exemplo, 2010-04-05T17:30:04+01:00.
supportEndDate

string

A data final em que o dispositivo vai ter suporte. Isso é aplicável apenas aos dispositivos comprados diretamente do Google. O valor está no formato de data e hora ISO 8601. O horário é a data completa mais horas, minutos e segundos no formato YYYY-MM-DDThh:mm:ssTZD. Por exemplo, 2010-04-05T17:30:04+01:00.
annotatedUser

string

O usuário do dispositivo, conforme indicado pelo administrador. O tamanho máximo é de 100 caracteres. Valores vazios são permitidos.
annotatedLocation

string

O endereço ou o local do dispositivo, conforme informado pelo administrador. O nome deve ter no máximo 200 caracteres. Valores vazios são permitidos.
notes

string

Observações sobre este dispositivo adicionadas pelo administrador. Essa propriedade pode ser pesquisada com o parâmetro query do método list. O tamanho máximo é de 500 caracteres. Valores vazios são permitidos.
model

string

Informações do modelo do dispositivo. Se o dispositivo não tiver essa informação, a propriedade não será incluída na resposta.
meid

string

O Identificador de Equipamento Móvel (MEID, na sigla em inglês) ou a Identidade de Equipamento Móvel Internacional (IMEI) para o cartão móvel 3G em um dispositivo móvel. Um MEID/IMEI normalmente é usado ao adicionar um dispositivo a um plano de serviço pós-pago de uma operadora sem fio. Se o dispositivo não tiver essa informação, a propriedade não será incluída na resposta. Para saber mais sobre como exportar uma lista de MEID/IMEI, consulte o Guia para desenvolvedores.
orderNumber

string

O número do pedido do dispositivo. Somente dispositivos comprados diretamente do Google têm um número de pedido.
willAutoRenew

boolean

Determina se o dispositivo renovará automaticamente o suporte após a data de término do suporte. Esta é uma propriedade somente leitura.
osVersion

string

A versão do sistema operacional do dispositivo Chrome.
platformVersion

string

A versão da plataforma do dispositivo Chrome.
firmwareVersion

string

A versão do firmware do dispositivo Chrome.
macAddress

string

O endereço MAC sem fio do dispositivo. Se o dispositivo não tiver essa informação, ela não será incluída na resposta.
bootMode

string

O modo de inicialização do dispositivo. Os valores possíveis são:

  • Verified: o dispositivo está executando uma versão válida do Chrome OS.
  • Dev: a chave do hardware do desenvolvedor do dispositivo está ativada. Quando inicializado, o dispositivo tem um shell de linha de comando. Para ver um exemplo de switch do desenvolvedor, consulte as informações do desenvolvedor do Chromebook.
lastEnrollmentTime

string

A data e a hora em que o dispositivo foi registrado pela última vez. O valor está no formato de data e hora ISO 8601. O horário é a data completa mais horas, minutos e segundos no formato YYYY-MM-DDThh:mm:ssTZD. Por exemplo, 2010-04-05T17:30:04+01:00. Para mais informações sobre inscrições automáticas e manuais, consulte a Central de Ajuda do Chrome.
kind

string

O tipo de recurso. Para o recurso Chromeosdevices, o valor é admin#directory#chromeosdevice.
recentUsers[]

object

Uma lista de usuários recentes no dispositivo, em ordem decrescente, pelo horário do último login.
recentUsers[].type

string

O tipo do usuário.

Os valores aceitos são:

  • USER_TYPE_MANAGED: o usuário é gerenciado pelo domínio.
  • USER_TYPE_UNMANAGED: o usuário não é gerenciado pelo domínio.
recentUsers[].email

string

O endereço de e-mail do usuário. Só estará presente se o tipo de usuário for USER_TYPE_MANAGED.
activeTimeRanges[]

object

Uma lista de períodos ativos (somente leitura).
activeTimeRanges[].activeTime

integer

Duração do uso em milissegundos.
activeTimeRanges[].date

string

Data de uso.
ethernetMacAddress

string

O endereço MAC do dispositivo na interface de rede Ethernet.
annotatedAssetId

string

O identificador do recurso conforme observado por um administrador ou especificado durante a inscrição.
etag

string

ETag do recurso.
diskVolumeReports[]

object

Relatórios de espaço em disco e outras informações sobre volumes montados/conectados.
diskVolumeReports[].volumeInfo[]

object

Volumes de disco
diskVolumeReports[].volumeInfo[].volumeId

string

Código do volume
diskVolumeReports[].volumeInfo[].storageTotal

string (int64 format)

Espaço total em disco [em bytes]
diskVolumeReports[].volumeInfo[].storageFree

string (int64 format)

Espaço livre em disco [em bytes]
systemRamTotal

string (int64 format)

Total de RAM no dispositivo em bytes
cpuStatusReports[]

object

Relatórios de uso e temperatura da CPU (somente leitura)
cpuStatusReports[].reportTime

string

Data e hora em que o relatório foi recebido.
cpuStatusReports[].cpuUtilizationPercentageInfo[]

integer
cpuStatusReports[].cpuTemperatureInfo[]

object

Uma lista de amostras de temperatura da CPU.
cpuStatusReports[].cpuTemperatureInfo[].temperature

integer

Temperatura em graus Celsius.
cpuStatusReports[].cpuTemperatureInfo[].label

string

Rótulo da CPU
cpuInfo[]

object

Informações sobre as especificações da CPU no dispositivo.
cpuInfo[].model

string

O nome do modelo de CPU.
cpuInfo[].architecture

string

A arquitetura de CPU.
cpuInfo[].maxClockSpeedKhz

integer

A velocidade máxima do clock da CPU em kHz.
cpuInfo[].logicalCpus[]

object

Informações para as CPUs lógicas
cpuInfo[].logicalCpus[].maxScalingFrequencyKhz

integer

Frequência máxima de execução permitida para a CPU por política.
cpuInfo[].logicalCpus[].currentScalingFrequencyKhz

integer

Frequência atual de execução da CPU.
cpuInfo[].logicalCpus[].idleDuration

string (Duration format)

Tempo de inatividade desde a última inicialização.

Uma duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
cpuInfo[].logicalCpus[].cStates[]

object

Os estados C indicam o estado de consumo de energia da CPU. Para mais informações, consulte a documentação publicada pelo fabricante da CPU.
cpuInfo[].logicalCpus[].cStates[].displayName

string

Nome do estado.
cpuInfo[].logicalCpus[].cStates[].sessionDuration

string (Duration format)

Tempo gasto no estado desde a última reinicialização.

Uma duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
deviceFiles[]

object

Uma lista dos arquivos do dispositivo para download (somente leitura)
deviceFiles[].name

string

File name
deviceFiles[].type

string

Tipo de arquivo
deviceFiles[].downloadUrl

string

URL de download do arquivo
deviceFiles[].createTime

string

Data e hora em que o arquivo foi criado
systemRamFreeReports[]

object

Relatórios das quantidades de memória RAM disponível (somente leitura)
systemRamFreeReports[].reportTime

string

Data e hora em que o relatório foi recebido.
systemRamFreeReports[].systemRamFreeInfo[]

string (int64 format)
lastKnownNetwork[]

object

Contém a última rede conhecida (somente leitura)
lastKnownNetwork[].ipAddress

string

O endereço IP.
lastKnownNetwork[].wanIpAddress

string

O endereço IP da WAN.
autoUpdateExpiration

string (int64 format)

(Somente leitura) O carimbo de data/hora após o qual o dispositivo deixará de receber atualizações ou suporte do Chrome.
ethernetMacAddress0

string

Endereço MAC (somente leitura) usado pela porta Ethernet interna do Chromebook e para a interface de rede interna (Ethernet). O formato é de 12 (12) dígitos hexadecimais sem delimitadores (letras maiúsculas). Isso só é relevante para alguns dispositivos.
dockMacAddress

string

(Somente leitura) Endereço MAC integrado da estação de base à qual o dispositivo está conectado. Configura o Endereço de controle de acesso à mídia (endereço MAC) atribuído para uso por uma base. Ele é reservado especificamente para a passagem MAC pela política do dispositivo. O formato é de 12 (12) dígitos hexadecimais sem delimitadores (letras maiúsculas). Isso só é relevante para alguns dispositivos.
manufactureDate

string

(Somente leitura) A data de fabricação do dispositivo no formato aaaa-mm-dd.
orgUnitPath

string

O caminho pai completo com o nome da unidade organizacional associada ao dispositivo. Os nomes de caminho não diferenciam maiúsculas de minúsculas. Se a unidade organizacional mãe for a organização de nível superior, ela será representada como uma barra /. Essa propriedade pode ser atualizada usando a API. Para mais informações sobre como criar uma estrutura organizacional para seu dispositivo, consulte a Central de Ajuda para administração.
tpmVersionInfo

object

Módulo de plataforma confiável (TPM, na sigla em inglês) (somente leitura)
tpmVersionInfo.family

string

Família TPM. Usamos a codificação de estilo TPM 2.0, por exemplo:
TPM 1.2: "1.2" -> 312e3200
TPM 2.0: "2.0" -> 322e3000
tpmVersionInfo.specLevel

string

Nível de especificação do TPM. Consulte a especificação da biblioteca para o TPM 2.0 e a especificação principal para o TPM 1.2.
tpmVersionInfo.manufacturer

string

Código do fabricante do TPM.
tpmVersionInfo.tpmModel

string

Número do modelo do TPM.
tpmVersionInfo.firmwareVersion

string

Versão do firmware do TPM.
tpmVersionInfo.vendorSpecific

string

Informações específicas do fornecedor, como o ID dele.
screenshotFiles[]

object

Uma lista de arquivos de captura de tela para download. O tipo é sempre "SCREENSHOT_FILE". (somente leitura)
screenshotFiles[].name

string

File name
screenshotFiles[].type

string

Tipo de arquivo
screenshotFiles[].downloadUrl

string

URL de download do arquivo
screenshotFiles[].createTime

string

Data e hora em que o arquivo foi criado
orgUnitId

string

O ID exclusivo da unidade organizacional. orgUnitPath é a versão legível de orgUnitId. Embora "orgUnitPath" possa mudar ao renomear uma unidade organizacional no caminho, "orgUnitId" não pode ser alterado em uma unidade organizacional. Essa propriedade pode ser atualizada usando a API. Para mais informações sobre como criar uma estrutura organizacional para seu dispositivo, consulte a Central de Ajuda para administração.
osUpdateStatus

object (OsUpdateStatus)

O status das atualizações do SO para o dispositivo.
firstEnrollmentTime

string

Data e hora da primeira vez que o dispositivo foi registrado.
lastDeprovisionTimestamp

string

(Somente leitura) Data e hora do último desprovisionamento do dispositivo.
deprovisionReason

enum (DeprovisionReason)

(Somente leitura) Motivo do desprovisionamento.
deviceLicenseType

enum (DeviceLicenseType)

Apenas saída. Tipo de licença do dispositivo.
backlightInfo[]

object (BacklightInfo)

Apenas saída. contém informações sobre a luz de fundo do dispositivo.

OsUpdateStatus

Contém informações sobre o status atual de atualização do SO.

Representação JSON 
{
  "state": enum (UpdateState),
  "targetOsVersion": string,
  "targetKioskAppVersion": string,
  "updateTime": string,
  "updateCheckTime": string,
  "rebootTime": string
}
Campos
state

enum (UpdateState)

O estado de uma atualização do SO.
targetOsVersion

string

Nova versão de plataforma da imagem do SO que está sendo transferida por download e aplicada. Ele só é definido quando o status da atualização é UPDATE_STATUS_DOWNLOAD_IN_PROGRESS ou UPDATE_STATUS_NEED_REBOOT. Esse pode ser um "0.0.0.0" fictício para UPDATE_STATUS_NEED_REBOOT em alguns casos extremos, por exemplo, quando o mecanismo de atualização é reiniciado sem reiniciar.
targetKioskAppVersion

string

Nova versão de plataforma necessária do aplicativo de quiosque atualizado pendente.
updateTime

string

Data e hora da última atualização do SO bem-sucedida.
updateCheckTime

string

Data e hora da última verificação de atualização.
rebootTime

string

Data e hora da última reinicialização.

UpdateState

O estado de uma atualização do SO.

Enums
UPDATE_STATE_UNSPECIFIED O estado da atualização não foi especificado.
UPDATE_STATE_NOT_STARTED Há uma atualização pendente, mas ela ainda não foi iniciada.
UPDATE_STATE_DOWNLOAD_IN_PROGRESS O download da atualização pendente está em andamento.
UPDATE_STATE_NEED_REBOOT O dispositivo está pronto para instalar a atualização, mas precisa ser reiniciado.

DeprovisionReason

O motivo do desprovisionamento de um dispositivo ChromeOS.

Enums
DEPROVISION_REASON_UNSPECIFIED O motivo do desprovisionamento é desconhecido.
DEPROVISION_REASON_SAME_MODEL_REPLACEMENT Substituição pelo mesmo modelo. Você tem uma autorização de devolução de materiais (ADM) ou está substituindo um dispositivo com defeito na garantia pelo mesmo modelo de dispositivo.
DEPROVISION_REASON_UPGRADE

O dispositivo foi atualizado.
DEPROVISION_REASON_DOMAIN_MOVE

O domínio do dispositivo foi alterado.
DEPROVISION_REASON_SERVICE_EXPIRATION

O serviço do dispositivo expirou.
DEPROVISION_REASON_OTHER

O dispositivo foi desprovisionado por um motivo legado que não é mais compatível.
DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT Substituição por outro modelo. Você está substituindo este dispositivo por um modelo atualizado ou mais recente.
DEPROVISION_REASON_RETIRING_DEVICE Saindo da frota. Você está doando, descartando ou removendo o dispositivo do uso.
DEPROVISION_REASON_UPGRADE_TRANSFER Transferência de upgrade do ChromeOS Flex. Este é um dispositivo ChromeOS Flex que você está substituindo por um Chromebook dentro de um ano.
DEPROVISION_REASON_NOT_REQUIRED Não era necessário informar um motivo. Por exemplo, as licenças foram devolvidas ao conjunto de licenças do cliente.
DEPROVISION_REASON_REPAIR_CENTER O dispositivo foi desprovisionado pela central de serviços de reparo. Essa opção só pode ser definida pela central de serviços de reparo durante a ADM.

DeviceLicenseType

O tipo de licença do dispositivo.

Enums
DEVICE_LICENSE_TYPE_UNSPECIFIED O tipo de licença é desconhecido.
ENTERPRISE O dispositivo vem com um Upgrade vitalício do Chrome Enterprise.
ENTERPRISE_UPGRADE O dispositivo tem um Upgrade do Chrome Enterprise anual e independente.
EDUCATION_UPGRADE O dispositivo tem um Upgrade do Chrome Education autônomo vitalício.
EDUCATION O dispositivo acompanha um Upgrade vitalício do Chrome Education.
KIOSK_UPGRADE O dispositivo tem um Upgrade de quiosque anual.

BacklightInfo

Informações sobre as luzes de fundo do dispositivo.

Representação JSON 
{
  "path": string,
  "maxBrightness": integer,
  "brightness": integer
}
Campos
path

string

Apenas saída. Caminho para a luz de fundo no sistema. Útil se o autor da chamada precisar relacionar-se com outras informações.
maxBrightness

integer

Apenas saída. Brilho máximo para a luz de fundo.
brightness

integer

Apenas saída. Brilho atual da luz de fundo, entre 0 e maxBrightness.

Métodos

action
(deprecated)

 Use BatchChangeChromeOsDeviceStatus.

get

 Recupera as propriedades de um dispositivo Chrome OS.

list

 Recupera uma lista paginada de dispositivos Chrome OS em uma conta.

moveDevicesToOu

 Move ou insere vários dispositivos Chrome OS em uma unidade organizacional.

patch

 Atualiza as propriedades atualizáveis de um dispositivo, como annotatedUser, annotatedLocation, notes, orgUnitPath ou annotatedAssetId.

update

 Atualiza as propriedades atualizáveis de um dispositivo, como annotatedUser, annotatedLocation, notes, orgUnitPath ou annotatedAssetId.