Method: enterprises.devices.issueCommand

Emite um comando para um dispositivo. O recurso Operation retornado contém um Command no campo metadata. Use o método get operation para ver o status do comando.

Solicitação HTTP

POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

O nome do dispositivo no formato enterprises/{enterpriseId}/devices/{deviceId}.

Corpo da solicitação

O corpo da solicitação contém uma instância de Command.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/androidmanagement

Para mais informações, consulte a Visão geral do OAuth 2.0.

Comando

Um comando.

Representação JSON 
{
  "type": enum (CommandType),
  "createTime": string,
  "duration": string,
  "userName": string,
  "errorCode": enum (CommandErrorCode),
  "newPassword": string,
  "resetPasswordFlags": [
    enum (ResetPasswordFlag)
  ],

  // Union field params can be only one of the following:
  "clearAppsDataParams": {
    object (ClearAppsDataParams)
  }
  // End of list of possible types for union field params.

  // Union field status can be only one of the following:
  "clearAppsDataStatus": {
    object (ClearAppsDataStatus)
  }
  // End of list of possible types for union field status.
}
Campos
type

enum (CommandType)

O tipo do comando.
createTime

string (Timestamp format)

O carimbo de data/hora em que o comando foi criado. O timestamp é gerado automaticamente pelo servidor.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Por quanto tempo o comando é válido. O comando expirará se não for executado pelo dispositivo durante esse período. Se não for especificado, a duração padrão será de dez minutos. Não existe uma duração máxima.

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

string

O nome do recurso do usuário que tem o dispositivo no formulário enterprises/{enterpriseId}/users/{userId}. Isso é gerado automaticamente pelo servidor com base no dispositivo ao qual o comando é enviado.
errorCode

enum (CommandErrorCode)

Se o comando falhou, um código de erro explicando a falha. Isso não é definido quando o comando é cancelado pelo autor da chamada.
newPassword

string

Para comandos do tipo RESET_PASSWORD, opcionalmente especifica a nova senha.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Para comandos do tipo RESET_PASSWORD, especifica opcionalmente sinalizações.

Campo de união params. Parâmetros específicos do comando. Observe que alguns comandos não usam isso, em especial LOCK, RESET_PASSWORD, REBOOT e RELINQUISH_OWNERSHIP. No futuro, esses comandos também poderão usar isso.

Se isso for definido, os campos [new_password][google.android.devicemanagement.v1.new_password] e [reset_password_flags][google.android.devicemanagement.v1.reset_password_flags] não poderão ser definidos. params pode ser apenas de um dos tipos a seguir:
clearAppsDataParams

object (ClearAppsDataParams)

Parâmetros do comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo. Consulte os ClearAppsDataParams. Se isso for definido, é recomendável não definir type. Nesse caso, o servidor a define automaticamente como CLEAR_APP_DATA. Também é aceitável definir explicitamente type como CLEAR_APP_DATA.
Campo de união status. Status específico do comando. Observe que alguns comandos não usam esse recurso, em particular [LOCK][google.android.devicemanagement.v1.Command.LOCK], [RESET_PASSWORD][google.android.devicemanagement.v1.Command.RESET_PASSWORD], [REBOOT][google.android.devicemanagement.v1.Command.REBOOT] e [RELINQUISH_OWNERSHIP][google.android.devicemanagement.v1.Command.RELINQUISH_OWNERSHIP]. No futuro, esses comandos também poderão usar isso. status pode ser apenas de um dos tipos a seguir:
clearAppsDataStatus

object (ClearAppsDataStatus)

Apenas saída. Status do comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo. Consulte os ClearAppsDataStatus.

Tipo de comando

Tipos de comando.

Enums
COMMAND_TYPE_UNSPECIFIED Este valor não é permitido.
LOCK Bloqueie o dispositivo, como se o tempo limite da tela de bloqueio tivesse expirado.
RESET_PASSWORD Redefinir a senha do usuário.
REBOOT Reinicialize o dispositivo. Compatível apenas com dispositivos totalmente gerenciados que executam o Android 7.0 (API de nível 24) ou versões posteriores.
RELINQUISH_OWNERSHIP Remove o perfil de trabalho e todas as políticas de um dispositivo Android 8.0 ou superior da empresa, deixando de usá-lo para uso pessoal. Os apps e dados associados aos perfis pessoais são preservados. O dispositivo será excluído do servidor depois de confirmar o comando.
CLEAR_APP_DATA Limpa os dados de apps especificados. Ela é compatível com o Android 9 e versões mais recentes. Um aplicativo pode armazenar dados fora de seus dados de aplicativo, por exemplo, no armazenamento externo ou em um dicionário do usuário. Consulte também clearAppsDataParams.

Código de erro de comando

Um código de erro de comando. Este é um campo somente leitura preenchido pelo servidor.

Enums
COMMAND_ERROR_CODE_UNSPECIFIED Não houve erro.
UNKNOWN Ocorreu um erro desconhecido.
API_LEVEL O nível de API do dispositivo não é compatível com esse comando.
MANAGEMENT_MODE O modo de gerenciamento (proprietário do perfil, proprietário do dispositivo etc.) não é compatível com o comando.
INVALID_VALUE O comando tem um valor de parâmetro inválido.
UNSUPPORTED O dispositivo não é compatível com o comando. Atualizar o Android Device Policy para a versão mais recente pode resolver o problema.

RedefinirResenhadaSenha

Sinalizações que podem ser usadas para o tipo de comando RESET_PASSWORD.

Enums
RESET_PASSWORD_FLAG_UNSPECIFIED Esse valor é ignorado.
REQUIRE_ENTRY Não permita que outros administradores alterem a senha novamente até que o usuário a digite.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Não peça credenciais do usuário na inicialização do dispositivo.
LOCK_NOW Bloqueie o dispositivo após a redefinição da senha.

ClearAppsDataParams

Parâmetros associados ao comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo.

Representação JSON 
{
  "packageNames": [
    string
  ]
}
Campos
packageNames[]

string

Os nomes dos pacotes dos apps cujos dados serão apagados quando o comando for executado.

StatusdeDadosdoGoogleApps

Status do comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo.

Representação JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Campos
results

map (key: string, value: object (PerAppResult))

Os resultados por app, um mapeamento dos nomes de pacotes para os respectivos resultados de limpeza.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Resultado do app

O resultado de uma tentativa de limpar os dados de um único app.

Representação JSON 
{
  "clearingResult": enum (ClearingResult)
}
Campos
clearingResult

enum (ClearingResult)

O resultado de uma tentativa de limpar os dados de um único app.

Resultado

O resultado de uma tentativa de limpar os dados de um único app.

Enums
CLEARING_RESULT_UNSPECIFIED Resultado não especificado.
SUCCESS Os dados do app foram apagados.
APP_NOT_FOUND Não foi possível limpar os dados do app porque ele não foi encontrado.
APP_PROTECTED Não foi possível limpar os dados do app porque ele está protegido. Por exemplo, isso pode se aplicar a apps essenciais para o funcionamento do dispositivo, como a Google Play Store.
API_LEVEL Não foi possível limpar os dados do app porque o nível da API do dispositivo não é compatível com esse comando.