Method: enterprises.devices.issueCommand

Invia un comando a un dispositivo. La risorsa Operation restituita contiene un elemento Command nel campo metadata. Utilizza il metodo operativo get per ottenere lo stato del comando.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Il nome del dispositivo nel formato enterprises/{enterpriseId}/devices/{deviceId}.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Command.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la pagina Panoramica di OAuth 2.0.

Comando

Un comando.

Rappresentazione 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)
  },
  "startLostModeParams": {
    object (StartLostModeParams)
  },
  "stopLostModeParams": {
    object (StopLostModeParams)
  }
  // End of list of possible types for union field params.

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

enum (CommandType)

Il tipo di comando.
createTime

string (Timestamp format)

Il timestamp in cui è stato creato il comando. Il timestamp viene generato automaticamente dal server.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

La durata di validità del comando. Il comando scadrà se non viene eseguito dal dispositivo durante questo periodo. Se non specificata, la durata predefinita è dieci minuti. Non esiste una durata massima.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
userName

string

Il nome della risorsa dell'utente proprietario del dispositivo nel formato enterprises/{enterpriseId}/users/{userId}. Questo viene generato automaticamente dal server in base al dispositivo a cui viene inviato il comando.
errorCode

enum (CommandErrorCode)

Se il comando non è riuscito, un codice di errore che spiega l'errore. Non è impostato quando il comando viene annullato dal chiamante.
newPassword

string

Per i comandi di tipo RESET_PASSWORD, specifica facoltativamente la nuova password. Nota: nel caso dei dispositivi Android 14, la nuova password deve contenere almeno 6 caratteri se è numerica. In caso contrario, il comando non andrà a buon fine con INVALID_VALUE.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Per i comandi di tipo RESET_PASSWORD, specifica facoltativamente i flag.

Campo di unione params. Parametri specifici del comando. Tieni presente che alcuni comandi non la utilizzano, in particolare LOCK, RESET_PASSWORD, REBOOT e RELINQUISH_OWNERSHIP. In futuro potrebbero essere usati anche questi comandi.

Se questa impostazione è impostata, i campi new_password e reset_password_flags non devono essere impostati. params può essere solo uno dei seguenti:
clearAppsDataParams

object (ClearAppsDataParams)

Parametri per il comando CLEAR_APP_DATA per cancellare dal dispositivo i dati delle app specificate. Leggi i ClearAppsDataParams. Se questa impostazione è impostata, si consiglia di non impostare type. In questo caso, il server la imposta automaticamente su CLEAR_APP_DATA. È inoltre accettabile impostare esplicitamente type su CLEAR_APP_DATA.
startLostModeParams

object (StartLostModeParams)

Parametri per il comando START_LOST_MODE per attivare la modalità Dispositivo smarrito. Leggi i StartLostModeParams. Se questa impostazione è impostata, si consiglia di non impostare type. In questo caso, il server la imposta automaticamente su START_LOST_MODE. È inoltre accettabile impostare esplicitamente type su START_LOST_MODE.
stopLostModeParams

object (StopLostModeParams)

Parametri per il comando STOP_LOST_MODE per disattivare la modalità Dispositivo smarrito. Leggi i StopLostModeParams. Se questa impostazione è impostata, si consiglia di non impostare type. In questo caso, il server la imposta automaticamente su STOP_LOST_MODE. È inoltre accettabile impostare esplicitamente type su STOP_LOST_MODE.
Campo di unione status. Stato specifico del comando. Tieni presente che alcuni comandi non la utilizzano, in particolare LOCK, RESET_PASSWORD, REBOOT e RELINQUISH_OWNERSHIP. In futuro potrebbero essere usati anche questi comandi. status può essere solo uno dei seguenti:
clearAppsDataStatus

object (ClearAppsDataStatus)

Solo output. Stato del comando CLEAR_APP_DATA per cancellare dal dispositivo i dati delle app specificate. Leggi i ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Solo output. Stato del comando START_LOST_MODE per attivare la modalità Dispositivo smarrito. Leggi i StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Solo output. Stato del comando STOP_LOST_MODE per disattivare la modalità Dispositivo smarrito. Leggi i StopLostModeStatus.

CommandType

Tipi di comandi.

Enum
COMMAND_TYPE_UNSPECIFIED Questo valore non è consentito.
LOCK Blocca il dispositivo come se il timeout della schermata di blocco fosse scaduto.
RESET_PASSWORD Reimpostare la password dell'utente.
REBOOT Riavvia il dispositivo. Funzionalità supportata solo sui dispositivi completamente gestiti con Android 7.0 (livello API 24) o versioni successive.
RELINQUISH_OWNERSHIP Rimuove il profilo di lavoro e tutti i criteri da un dispositivo Android 8.0 o versioni successive di proprietà dell'azienda, cedendo il dispositivo per uso personale. Le app e i dati associati ai profili personali vengono conservati. Il dispositivo verrà eliminato dal server dopo che avrà confermato il comando.
CLEAR_APP_DATA Cancella i dati delle app specificate. Questa funzionalità è supportata su Android 9 e versioni successive. Tieni presente che un'applicazione può archiviare dati al di fuori dei propri dati dell'applicazione, ad esempio in un'unità di archiviazione esterna o in un dizionario utente. Vedi anche clearAppsDataParams.
START_LOST_MODE Attiva la modalità Dispositivo smarrito sul dispositivo. Funzionalità supportata solo sui dispositivi completamente gestiti o di proprietà dell'organizzazione con un profilo gestito. Vedi anche startLostModeParams.
STOP_LOST_MODE Consente di disattivare la modalità Dispositivo smarrito. Funzionalità supportata solo sui dispositivi completamente gestiti o di proprietà dell'organizzazione con un profilo gestito. Vedi anche stopLostModeParams.

CommandErrorCode

Un codice di errore del comando. Si tratta di un campo di sola lettura compilato dal server.

Enum
COMMAND_ERROR_CODE_UNSPECIFIED Non si è verificato alcun errore.
UNKNOWN Si è verificato un errore sconosciuto.
API_LEVEL Il livello API del dispositivo non supporta questo comando.
MANAGEMENT_MODE La modalità di gestione (proprietario del profilo, proprietario del dispositivo e così via) non supporta il comando.
INVALID_VALUE Il comando contiene un valore del parametro non valido.
UNSUPPORTED Il dispositivo non supporta il comando. L'aggiornamento di Android Device Policy alla versione più recente potrebbe risolvere il problema.

ResetPasswordFlag

Flag utilizzabili per il tipo di comando RESET_PASSWORD.

Enum
RESET_PASSWORD_FLAG_UNSPECIFIED Questo valore viene ignorato.
REQUIRE_ENTRY Non consentire ad altri amministratori di cambiare di nuovo la password finché l'utente non l'ha inserita.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Non chiedere le credenziali utente all'avvio del dispositivo.
LOCK_NOW Blocca il dispositivo dopo la reimpostazione della password.

ClearAppsDataParams

Parametri associati al comando CLEAR_APP_DATA per cancellare dal dispositivo i dati delle app specificate.

Rappresentazione JSON 
{
  "packageNames": [
    string
  ]
}
Campi
packageNames[]

string

I nomi dei pacchetti delle app i cui dati verranno cancellati quando viene eseguito il comando.

StartLostModeParams

Parametri associati al comando START_LOST_MODE per attivare la modalità Dispositivo smarrito. Per attivare la modalità Dispositivo smarrito è necessario specificare almeno uno dei parametri, escluso il nome dell'organizzazione.

Rappresentazione JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Campi
lostMessage

object (UserFacingMessage)

Il messaggio mostrato all'utente quando il dispositivo è in modalità Dispositivo smarrito.
lostPhoneNumber

object (UserFacingMessage)

Il numero di telefono che verrà chiamato quando il dispositivo è in modalità Dispositivo smarrito e si tocca il pulsante Chiama proprietario.
lostEmailAddress

string

L'indirizzo email visualizzato all'utente quando il dispositivo è in modalità Dispositivo smarrito.
lostStreetAddress

object (UserFacingMessage)

La via mostrata all'utente quando il dispositivo è in modalità Dispositivo smarrito.
lostOrganization

object (UserFacingMessage)

Il nome dell'organizzazione mostrato all'utente quando il dispositivo è in modalità Dispositivo smarrito.

StopLostModeParams

Questo tipo non contiene campi.

Parametri associati al comando STOP_LOST_MODE per disattivare la modalità Dispositivo smarrito.

ClearAppsDataStatus

Stato del comando CLEAR_APP_DATA per cancellare dal dispositivo i dati delle app specificate.

Rappresentazione JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Campi
results

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

I risultati per app, una mappatura dai nomi dei pacchetti al rispettivo risultato di cancellazione.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

Il risultato di un tentativo di cancellare i dati di una singola app.

Rappresentazione JSON 
{
  "clearingResult": enum (ClearingResult)
}
Campi
clearingResult

enum (ClearingResult)

Il risultato di un tentativo di cancellare i dati di una singola app.

ClearingResult

Il risultato di un tentativo di cancellare i dati di una singola app.

Enum
CLEARING_RESULT_UNSPECIFIED Risultato non specificato.
SUCCESS I dati di questa app sono stati cancellati.
APP_NOT_FOUND Impossibile cancellare i dati di questa app perché non è stata trovata.
APP_PROTECTED Impossibile cancellare i dati di questa app perché è protetta. Ciò potrebbe riguardare, ad esempio, app essenziali per il funzionamento del dispositivo, come Google Play Store.
API_LEVEL Impossibile cancellare i dati di questa app perché il livello API del dispositivo non supporta questo comando.

StartLostModeStatus

Stato del comando START_LOST_MODE per attivare la modalità Dispositivo smarrito.

Rappresentazione JSON 
{
  "status": enum (Status)
}
Campi
status

enum (Status)

Lo stato. Leggi i StartLostModeStatus.

Stato

Lo stato. Leggi i StartLostModeStatus.

Enum
STATUS_UNSPECIFIED Non specificato. Questo valore non è utilizzato.
SUCCESS Sul dispositivo è stata attivata la modalità Dispositivo smarrito.
RESET_PASSWORD_RECENTLY Non è stato possibile attivare la modalità Dispositivo smarrito perché l'amministratore ha reimpostato di recente la password del dispositivo.
USER_EXIT_LOST_MODE_RECENTLY Non è stato possibile attivare la modalità Dispositivo smarrito perché l'utente è uscito di recente dalla modalità Dispositivo smarrito.
ALREADY_IN_LOST_MODE Il dispositivo è già in modalità Dispositivo smarrito.

StopLostModeStatus

Stato del comando STOP_LOST_MODE per disattivare la modalità Dispositivo smarrito.

Rappresentazione JSON 
{
  "status": enum (Status)
}
Campi
status

enum (Status)

Lo stato. Leggi i StopLostModeStatus.

Stato

Lo stato. Leggi i StopLostModeStatus.

Enum
STATUS_UNSPECIFIED Non specificato. Questo valore non è utilizzato.
SUCCESS Il dispositivo è stato ripristinato dalla modalità Dispositivo smarrito.
NOT_IN_LOST_MODE Il dispositivo non è in modalità Dispositivo smarrito.