REST Resource: customer.devices.chromeos.commands

Recurso: DirectoryChromeosdevicesCommand

Informações sobre um comando emitido para um dispositivo.

Representação JSON 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Campos
commandId

string (int64 format)

ID exclusivo de um comando de dispositivo.
type

enum (CommandType)

O tipo do comando.
issueTime

string (Timestamp format)

O carimbo de data/hora em que o comando foi emitido pelo administrador.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
state

enum (State)

Indica o estado do comando.
commandExpireTime

string (Timestamp format)

O horário de expiração do comando. Se o dispositivo não executar o comando nesse período, ele vai expirar.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
commandResult

object (DirectoryChromeosdevicesCommandResult)

O resultado da execução do comando.
payload

string

O payload especificado pelo comando, se houver.

CommandType

Estabelece o tipo de comando que o dispositivo precisa executar.

Tipos enumerados
COMMAND_TYPE_UNSPECIFIED O tipo de comando não foi especificado.
REBOOT Reinicialize o dispositivo. Podem ser emitidos para dispositivos de quiosque e sessão de visitante gerenciada, além de dispositivos comuns com o ChromeOS versão 113 ou mais recente.
TAKE_A_SCREENSHOT Faça uma captura de tela do dispositivo. Disponível apenas se o dispositivo estiver no modo quiosque.
SET_VOLUME Defina o volume do dispositivo. Só pode ser emitido para dispositivos de quiosque e sessão de visitante gerenciada.
WIPE_USERS Exclua todos os usuários do dispositivo. A execução desse comando no dispositivo remove todos os dados do perfil do usuário, mas mantém a política e o registro do dispositivo.
REMOTE_POWERWASH Limpa o dispositivo fazendo uma lavagem energética. A execução desse comando no dispositivo remove todos os dados, incluindo políticas de usuário, políticas do dispositivo e políticas de registro. Aviso: a configuração original do dispositivo será restaurada sem o registro, a menos que ele esteja sujeito ao registro forçado ou automático. Use com cuidado, porque essa é uma ação irreversível.
DEVICE_START_CRD_SESSION Inicia uma sessão da Área de trabalho remota do Google Chrome.
CAPTURE_LOGS Capture os registros do sistema de um dispositivo em modo quiosque. Os registros podem ser baixados no link downloadUrl presente no campo deviceFiles de chromeosdevices.
FETCH_CRD_AVAILABILITY_INFO Busca os tipos disponíveis de sessões da Área de trabalho remota do Google Chrome (particulares ou compartilhadas) que podem ser usadas para se conectar remotamente ao dispositivo.
FETCH_SUPPORT_PACKET Buscar remotamente um pacote de suporte de um dispositivo. O pacote de suporte é um arquivo ZIP que contém vários registros do sistema e dados de depuração de um dispositivo ChromeOS. O pacote de suporte pode ser baixado no link downloadURL presente no campo deviceFiles de chromeosdevices.

Estado

Representa o estado do comando emitido.

Tipos enumerados
STATE_UNSPECIFIED O status do comando não foi especificado.
PENDING Um comando não expirado que ainda não foi enviado ao cliente.
EXPIRED O comando não foi executado pelo cliente dentro do tempo esperado.
CANCELLED O comando é cancelado pelo administrador enquanto está PENDENTE.
SENT_TO_CLIENT O comando foi enviado ao cliente.
ACKED_BY_CLIENT O cliente respondeu que recebeu o comando.
EXECUTED_BY_CLIENT O cliente executou o comando com ou sem sucesso.

DirectoryChromeosdevicesCommandResult

O resultado da execução de um comando.

Representação JSON 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Campos
result

enum (CommandResultType)

O resultado do comando.
executeTime

string (Timestamp format)

A hora em que o comando foi executado ou não.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
errorMessage

string

A mensagem de erro com uma breve explicação sobre o motivo da falha do comando. Presente somente se o comando falhar.
commandResultPayload

string

O payload do resultado do comando. Os comandos a seguir respondem com um payload:

  • DEVICE_START_CRD_SESSION: o payload é um objeto JSON em string no formato: { "url": url }. O URL fornecido vincula à sessão do Área de Trabalho Remota do Chrome e exige autenticação usando apenas o email associado à emissão do comando.
  • FETCH_CRD_AVAILABILITY_INFO: o payload é um objeto JSON em string no formato: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. O campo "remoteSupportAvailability" é definido como "AVAILABLE" se a sessão shared CRD para o dispositivo estiver disponível. O campo "remoteAccessAvailability" é definido como "AVAILABLE" se uma sessão de private CRD para o dispositivo estiver disponível.

CommandResultType

O tipo do resultado do comando.

Tipos enumerados
COMMAND_RESULT_TYPE_UNSPECIFIED O resultado do comando não foi especificado.
IGNORED O comando foi ignorado por estar obsoleto.
FAILURE Não foi possível executar o comando.
SUCCESS O comando foi executado.

Métodos

get

 Recebe dados de um comando específico emitido para o dispositivo.