REST Resource: chromeosdevices

Recurso: ChromeOsDevice

Os dispositivos Google Chrome funcionam com o Chrome OS. Para mais informações sobre tarefas comuns da 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)
    }
  ],
  "autoUpdateThrough": string,
  "extendedSupportEligible": boolean,
  "extendedSupportStart": string,
  "extendedSupportEnabled": boolean,
  "fanInfo": [
    {
      object (FanInfo)
    }
  ],
  "chromeOsType": enum (ChromeOsType),
  "diskSpaceUsage": {
    object (ByteUsage)
  },
  "osVersionCompliance": enum (Compliance)
}
Campos
deviceId

string

O ID exclusivo do dispositivo Chrome.
serialNumber

string

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

string

O status do dispositivo.

Os valores aceitáveis 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 volta 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 vai estar 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 no aparelho. Se o dispositivo for ativado novamente, as configurações de sistema mais recentes 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: o pedido para substituir este dispositivo chegou.
  • RETURN_REQUESTED: foi feita uma solicitação para substituir este dispositivo.
  • SHIPPED: o dispositivo é enviado do inventário do Google. (descontinuado)
  • UNKNOWN: não foi possível determinar o status do dispositivo.
lastSync

string

Data e 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. A hora é 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 receber suporte. Isso se aplica apenas aos dispositivos comprados diretamente do Google. O valor está no formato de data e hora ISO 8601. A hora é 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 anotado pelo administrador. O tamanho máximo é de 100 caracteres. Valores vazios são permitidos.
annotatedLocation

string

O endereço ou local do dispositivo conforme anotado 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

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

string

O identificador de equipamento móvel (MEID) ou a identificação internacional de equipamento móvel (IMEI) do 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 essas informações, essa propriedade não será incluída na resposta. Para mais informações sobre como exportar uma lista de MEID/IMEI, consulte o Guia do desenvolvedor.
orderNumber

string

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

boolean

Determina se o dispositivo vai renovar automaticamente o suporte após a data de término. Essa é 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 essas informações, elas não serão incluídas 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 de hardware para desenvolvedores do dispositivo está ativada. Ao inicializar, o dispositivo tem um shell de linha de comando. Para ver um exemplo de troca de desenvolvedor, consulte as informações para desenvolvedores 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. A hora é 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 o registro automático e manual, 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 dos usuários recentes do dispositivo, em ordem decrescente, pelo horário do último login.
recentUsers[].type

string

O tipo de usuário.

Os valores aceitáveis 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. Isso só vai 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 de recursos conforme anotado 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

ID 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 utilização e temperatura da CPU (somente leitura)
cpuStatusReports[].reportTime

string

Data e hora em que a denúncia foi recebida.
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

Marcador da CPU
cpuInfo[]

object

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

string

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

string

A arquitetura da CPU.
cpuInfo[].maxClockSpeedKhz

integer

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

object

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

integer

Frequência máxima em que a CPU pode ser executada, por política.
cpuInfo[].logicalCpus[].currentScalingFrequencyKhz

integer

Frequência atual em que a CPU está sendo executada.
cpuInfo[].logicalCpus[].idleDuration

string (Duration format)

Tempo ocioso desde a última inicialização.

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.

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

object

Uma lista de arquivos de dispositivos para baixar (somente leitura)
deviceFiles[].name

string

Nome do arquivo
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 de quantidades de memória RAM disponível (somente leitura)
systemRamFreeReports[].reportTime

string

Data e hora em que a denúncia foi recebida.
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
(deprecated)

string (int64 format)

(Somente leitura) O carimbo de data/hora após o qual o dispositivo vai parar de receber atualizações ou suporte do Chrome. Use "autoUpdateThrough".
ethernetMacAddress0

string

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

string

(Somente leitura) Endereço MAC integrado da docking station a que o dispositivo está conectado. A fábrica define o endereço de controle de acesso à mídia (MAC) atribuído para uso por uma dock. Ele é reservado especificamente para a política de dispositivo de passagem de MAC. O formato é de 12 dígitos hexadecimais sem delimitador (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 completo da unidade mãe com o nome da unidade organizacional associada ao dispositivo. Os nomes de caminhos 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 administradores.
tpmVersionInfo

object

Trusted Platform Module (TPM) (somente leitura)
tpmVersionInfo.family

string

Família TPM. Usamos a codificação no 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 TPM 2.0 e a especificação principal para 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 ID do fornecedor.
screenshotFiles[]

object

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

string

Nome do arquivo
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 por humanos de "orgUnitId". Embora orgUnitPath possa mudar ao renomear uma unidade organizacional no caminho, orgUnitId não pode ser alterado para 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 administradores.
osUpdateStatus

object (OsUpdateStatus)

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

string

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

string

(Somente leitura) Data e hora do último cancelamento do provisionamento 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.
autoUpdateThrough

string

Apenas saída. O carimbo de data/hora após o qual o dispositivo vai parar de receber atualizações ou suporte do Chrome.
extendedSupportEligible

boolean

Apenas saída. Se o dispositivo precisa ou não ativar o suporte estendido.
extendedSupportStart

string

Apenas saída. Data do dispositivo em que a política de suporte estendido para atualizações automáticas começa.
extendedSupportEnabled

boolean

Apenas saída. Se a política de suporte estendido está ativada no dispositivo.
fanInfo[]

object (FanInfo)

Apenas saída. Informações sobre o ventilador do dispositivo.
chromeOsType

enum (ChromeOsType)

Apenas saída. Tipo de dispositivo Chrome OS.
diskSpaceUsage

object (ByteUsage)

Apenas saída. Quanto espaço em disco o dispositivo tem disponível e está usando no momento.
osVersionCompliance

enum (Compliance)

Apenas saída. Status de compliance da política do dispositivo com a versão do SO.

OsUpdateStatus

Contém informações sobre o status atual da 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 atualização de uma atualização do SO.
targetOsVersion

string

Nova versão da plataforma da imagem do SO sendo baixada e aplicada. Ele só é definido quando o status da atualização é UPDATE_STATUS_DOWNLOAD_IN_PROGRESS ou UPDATE_STATUS_NEED_REBOOT. Isso 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 uma reinicialização.
targetKioskAppVersion

string

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

string

Data e hora da última atualização bem-sucedida do SO.
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 atualização de uma atualização do SO.

Tipos enumerados
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 começou.
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.

Tipos enumerados
DEPROVISION_REASON_UNSPECIFIED O motivo do cancelamento do provisionamento é 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 expirou para o dispositivo.
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 Retirado de circulação. 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 pool de licenças do cliente.
DEPROVISION_REASON_REPAIR_CENTER O dispositivo foi desprovisionado pela Central de assistência técnica. Só pode ser definido pelo centro de serviços de reparo durante a devolução de mercadoria.

DeviceLicenseType

O tipo de licença deste dispositivo.

Tipos enumerados
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 independente anual.
EDUCATION_UPGRADE

O dispositivo tem um Upgrade do Chrome Education independente e permanente.
EDUCATION O dispositivo vem com um Upgrade do Chrome Education permanente.
KIOSK_UPGRADE O dispositivo tem um Upgrade anual de quiosque.
ENTERPRISE_UPGRADE_PERPETUAL Indica que o dispositivo está usando um Upgrade do Chrome Enterprise independente e permanente ou uma licença do Chrome Enterprise.
ENTERPRISE_UPGRADE_FIXED_TERM Indica que o dispositivo está usando um Upgrade do Chrome Enterprise independente e de prazo fixo ou uma licença do Chrome Enterprise.
EDUCATION_UPGRADE_PERPETUAL Indica que o dispositivo está usando um Upgrade do Chrome Education independente e permanente(também conhecido como licença permanente do Chrome EDU).
EDUCATION_UPGRADE_FIXED_TERM Indica que o dispositivo está usando um Upgrade do Chrome Education independente e de prazo fixo(também conhecido como licença de prazo fixo do Chrome EDU).

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 essa luz de fundo no sistema. Útil se o autor da chamada precisar correlacionar com outras informações.
maxBrightness

integer

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

integer

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

FanInfo

Informações sobre o ventilador do dispositivo.

Representação JSON 
{
  "speedRpm": integer
}
Campos
speedRpm

integer

Apenas saída. Velocidade do ventilador em RPM.

ChromeOsType

Tipo de dispositivo Chrome OS.

Tipos enumerados
CHROME_OS_TYPE_UNSPECIFIED Tipo de Chrome OS não especificado.
CHROME_OS_FLEX Tipo do Chrome OS: Chrome OS Flex.
CHROME_OS Chrome OS. Digite "Chrome OS".

ByteUsage

Representa uma capacidade de dados com alguma quantidade de uso atual em bytes.

Representação JSON 
{
  "capacityBytes": string,
  "usedBytes": string
}
Campos
capacityBytes

string (int64 format)

Apenas saída. O valor total da capacidade, em bytes.
usedBytes

string (int64 format)

Apenas saída. O valor de uso atual, em bytes.

Conformidade

Status de compliance da política do dispositivo com a versão do SO.

Tipos enumerados
COMPLIANCE_UNSPECIFIED Status de compliance não especificado.
COMPLIANT Status de compliance "Em compliance".
PENDING Status de compliance pendente.
NOT_COMPLIANT Status de compliance "Não em conformidade".

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.