REST Resource: chromeosdevices

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Recurso: ChromeOsDevice

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

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
}
Campos
deviceId

string

Mostra 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 Chrome OS.

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 for comprada, o dispositivo retornará ao estado ACTIVE.
  • PRE_PROVISIONED: o dispositivo foi registrado para o registro sem toque. Um dispositivo PRE_PROVISIONED pode ser movido ou excluído para outra unidade organizacional. Quando a inscrição for concluída, o dispositivo 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. 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: chegou a solicitação para substituir este dispositivo.
  • RETURN_REQUESTED: foi feita uma solicitação para substituir este dispositivo.
  • SHIPPED: o dispositivo é enviado a partir do inventário do Google. (uso suspenso)
  • UNKNOWN: não é possível determinar o status do dispositivo.
lastSync

string

Mostra a data e a hora da última sincronização do dispositivo com as configurações da 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 de suporte do dispositivo. 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. São permitidos valores vazios.

annotatedLocation

string

O endereço ou o local do dispositivo, conforme anotado pelo administrador. O nome deve ter no máximo 200 caracteres. São permitidos valores vazios.

notes

string

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

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, na sigla em inglês) ou a Identificação Internacional de Equipamento Móvel (IMEI, na sigla em inglês) 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 de telefonia sem fio. Se o dispositivo não tiver essas informações, essa propriedade não será incluída na resposta. Para ver mais informações sobre como exportar uma lista MEID/IMEI, consulte o Guia do desenvolvedor.

orderNumber

string

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

willAutoRenew

boolean

Determina se o dispositivo renovará a compatibilidade automaticamente após a data de término. Esta 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

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 do hardware do desenvolvedor do dispositivo está ativada. Quando inicializado, o dispositivo tem um shell de linha de comando. Para ver um exemplo de interruptor do desenvolvedor, consulte as informações para desenvolvedores do Chromebook.
lastEnrollmentTime

string

A data e a hora do último registro do dispositivo. 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 ver mais informações sobre a inscrição automática e manual, consulte a Central de Ajuda do Google Chrome.

kind

string

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

recentUsers[]

object

Lista de usuários recentes do dispositivo em ordem decrescente pelo horário do último login.

recentUsers[].type

string

O tipo de 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. Presente apenas 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

Endereço MAC do dispositivo na interface de rede Ethernet.

annotatedAssetId

string

É o identificador de recurso conforme indicado 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 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

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 relógio da CPU em kHz.

cpuInfo[].logicalCpus[]

object

Informações para 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 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 saber mais, 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 de arquivos dos dispositivos para download (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 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 em que 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 interface de rede integrada (ethernet). O formato é doze (12) dígitos hexadecimais sem nenhum delimitador (letras maiúsculas). Isso é relevante apenas para alguns dispositivos.

dockMacAddress

string

(Somente leitura) Endereço MAC integrado para a base de encaixe à qual o dispositivo se conectou. Configura para a configuração original o endereço de controle de acesso à mídia (endereço MAC) atribuído para uso em uma base. Ela é reservada especificamente para a política de passagem pelo MAC. O formato é doze (12) dígitos hexadecimais sem nenhum delimitador (letras maiúsculas). Isso é relevante apenas para alguns dispositivos.

manufactureDate

string

(Somente leitura) A data em que o dispositivo foi fabricado 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 de nível superior, ela será representada por 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 de administração.

tpmVersionInfo

object

Trusted Platform Module (TPM) (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 TPM. Veja 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 Trusted Platform Module.

tpmVersionInfo.vendorSpecific

string

Informações específicas do fornecedor, como o ID do fornecedor.

screenshotFiles[]

object

Uma lista de arquivos de captura de tela para download. 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 do "orgUnitId". Embora o orgUnitPath possa mudar ao renomear uma unidade organizacional no caminho, o 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 de administração.

osUpdateStatus

object (OsUpdateStatus)

O status das atualizações do sistema operacional para o dispositivo.

firstEnrollmentTime

string

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

Status da atualização

Contém informações sobre o status de atualização atual 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 da plataforma da imagem do SO que está sendo transferida por download e aplicada. Ela é definida apenas 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 para alguns casos extremos, por exemplo, o mecanismo de atualização é reiniciado sem uma reinicialização.

targetKioskAppVersion

string

Nova versão obrigatória da plataforma 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.

AtualizarEstado

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 não foi iniciada.
UPDATE_STATE_DOWNLOAD_IN_PROGRESS O download da atualização pendente está sendo feito.
UPDATE_STATE_NEED_REBOOT O dispositivo está pronto para instalar a atualização, mas precisa ser reiniciado.

Métodos

action

Realizar uma ação que afeta um dispositivo Chrome OS.

get

Recupera as propriedades do 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.