Method: enterprises.devices.issueCommand

Wydaje polecenie na urządzeniu. Zwrócony zasób Operation zawiera w polu metadata wartość Command. Aby sprawdzić stan polecenia, użyj metody operacji get.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Nazwa urządzenia w formacie enterprises/{enterpriseId}/devices/{deviceId}.

Treść żądania

Treść żądania zawiera wystąpienie elementu Command.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w omówieniu protokołu OAuth 2.0.

Polecenie

Polecenie.

Zapis 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.
}
Pola
type

enum (CommandType)

Typ polecenia.
createTime

string (Timestamp format)

Sygnatura czasowa utworzenia polecenia. Sygnatura czasowa jest generowana automatycznie przez serwer.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Czas trwania polecenia. Polecenie wygaśnie, jeśli nie zostanie w tym czasie wykonane przez urządzenie. Jeśli nie określono inaczej, domyślny czas trwania to 10 minut. Nie ma maksymalnego czasu trwania.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „s”. Przykład: "3.5s".
userName

string

Nazwa zasobu użytkownika będącego właścicielem urządzenia, podana w formacie enterprises/{enterpriseId}/users/{userId}. Jest on generowany automatycznie przez serwer na podstawie urządzenia, na które zostało wysłane polecenie.
errorCode

enum (CommandErrorCode)

Jeśli polecenie zakończyło się niepowodzeniem, wyświetlany jest kod błędu z informacją o niepowodzeniu. Ta wartość nie jest ustawiona, gdy polecenie zostanie anulowane przez element wywołujący.
newPassword

string

W przypadku poleceń typu RESET_PASSWORD opcjonalnie określa nowe hasło. Uwaga: nowe hasło musi mieć co najmniej 6 znaków, jeśli jest cyfrą w przypadku urządzeń z Androidem 14. W przeciwnym razie polecenie INVALID_VALUE zakończy się niepowodzeniem.
resetPasswordFlags[]

enum (ResetPasswordFlag)

W przypadku poleceń typu RESET_PASSWORD opcjonalnie określa flagi.

Pole sumy params. Parametry specyficzne dla polecenia. Pamiętaj, że niektóre polecenia go nie używają. Dotyczy to zwłaszcza LOCK, RESET_PASSWORD, REBOOT i RELINQUISH_OWNERSHIP. W przyszłości mogą one też korzystać z tych poleceń.

Jeśli ta wartość jest ustawiona, nie można ustawiać pól new_password ani reset_password_flags. params może być tylko jedną z tych wartości:
clearAppsDataParams

object (ClearAppsDataParams)

Parametry polecenia CLEAR_APP_DATA do usuwania z urządzenia danych określonych aplikacji. Zobacz ClearAppsDataParams. Jeśli ta zasada jest skonfigurowana, zalecamy, aby nie ustawiać wartości type. W takim przypadku serwer automatycznie ustawi go na CLEAR_APP_DATA. Możesz też jednoznacznie ustawić wartość type na CLEAR_APP_DATA.
startLostModeParams

object (StartLostModeParams)

Parametry polecenia START_LOST_MODE umożliwiające uruchomienie urządzenia w trybie utraconego urządzenia. Zobacz StartLostModeParams. Jeśli ta zasada jest skonfigurowana, zalecamy, aby nie ustawiać wartości type. W takim przypadku serwer automatycznie ustawi go na START_LOST_MODE. Możesz też jednoznacznie ustawić wartość type na START_LOST_MODE.
stopLostModeParams

object (StopLostModeParams)

Parametry polecenia STOP_LOST_MODE umożliwiające wyjście z trybu utraconego urządzenia. Zobacz StopLostModeParams. Jeśli ta zasada jest skonfigurowana, zalecamy, aby nie ustawiać wartości type. W takim przypadku serwer automatycznie ustawi go na STOP_LOST_MODE. Możesz też jednoznacznie ustawić wartość type na STOP_LOST_MODE.
Pole sumy status. Stan specyficzny dla polecenia. Pamiętaj, że niektóre polecenia go nie używają. Dotyczy to zwłaszcza LOCK, RESET_PASSWORD, REBOOT i RELINQUISH_OWNERSHIP. W przyszłości mogą one też korzystać z tych poleceń. status może być tylko jedną z tych wartości:
clearAppsDataStatus

object (ClearAppsDataStatus)

Tylko dane wyjściowe. Stan polecenia CLEAR_APP_DATA umożliwiającego usunięcie z urządzenia danych określonych aplikacji. Zobacz ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Tylko dane wyjściowe. Stan polecenia START_LOST_MODE umożliwiającego przełączenie urządzenia w tryb utraconego urządzenia. Zobacz StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Tylko dane wyjściowe. Stan polecenia STOP_LOST_MODE umożliwiającego wyjście z trybu utraconego urządzenia. Zobacz StopLostModeStatus.

CommandType

Typy poleceń.

Wartości w polu enum
COMMAND_TYPE_UNSPECIFIED Ta wartość jest niedozwolona.
LOCK Zablokuj urządzenie tak, jakby wygasł limit czasu blokady ekranu.
RESET_PASSWORD Zresetuj hasło użytkownika.
REBOOT Zrestartuj urządzenie. Obsługiwane tylko na w pełni zarządzanych urządzeniach z Androidem 7.0 (poziom interfejsu API 24) lub nowszym.
RELINQUISH_OWNERSHIP Usuwa profil służbowy i wszystkie zasady z należącego do firmy urządzenia z Androidem 8.0 lub nowszym, dzięki czemu urządzenie jest wykorzystywane do celów prywatnych. Aplikacje i dane powiązane z profilami osobistymi zostaną zachowane. Po potwierdzeniu polecenia urządzenie zostanie usunięte z serwera.
CLEAR_APP_DATA Czyści dane określonych aplikacji. Ta funkcja jest obsługiwana w Androidzie 9 i nowszych. Pamiętaj, że aplikacja może przechowywać dane poza swoimi danymi, np. w pamięci zewnętrznej czy w słowniku użytkownika. Zobacz też clearAppsDataParams.
START_LOST_MODE Przełącza urządzenie w tryb utraconego urządzenia. Ta funkcja jest obsługiwana tylko na urządzeniach w pełni zarządzanych lub należących do organizacji z profilem zarządzanym. Zobacz też startLostModeParams.
STOP_LOST_MODE Wyjdź z trybu utraconego urządzenia. Ta funkcja jest obsługiwana tylko na urządzeniach w pełni zarządzanych lub należących do organizacji z profilem zarządzanym. Zobacz też stopLostModeParams.

CommandErrorCode

Kod błędu polecenia. To pole jest tylko do odczytu wypełniane przez serwer.

Wartości w polu enum
COMMAND_ERROR_CODE_UNSPECIFIED Nie wystąpił żaden błąd.
UNKNOWN Wystąpił nieznany błąd.
API_LEVEL Poziom interfejsu API urządzenia nie obsługuje tego polecenia.
MANAGEMENT_MODE Tryb zarządzania (właściciel profilu, właściciel urządzenia itp.) nie obsługuje tego polecenia.
INVALID_VALUE Polecenie zawiera nieprawidłową wartość parametru.
UNSUPPORTED Urządzenie nie obsługuje polecenia. Problem może rozwiązać zaktualizowanie Android Device Policy do najnowszej wersji.

ResetPasswordFlag

Flagi, których można używać w poleceniach typu RESET_PASSWORD.

Wartości w polu enum
RESET_PASSWORD_FLAG_UNSPECIFIED Ta wartość jest ignorowana.
REQUIRE_ENTRY Nie zezwalaj innym administratorom na ponowną zmianę hasła, dopóki go nie wpisze.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Nie pytaj o dane logowania użytkownika podczas uruchamiania urządzenia.
LOCK_NOW Zablokuj urządzenie po zresetowaniu hasła.

ClearAppsDataParams

Parametry powiązane z poleceniem CLEAR_APP_DATA do usuwania z urządzenia danych określonych aplikacji.

Zapis JSON 
{
  "packageNames": [
    string
  ]
}
Pola
packageNames[]

string

Nazwy pakietów aplikacji, których dane zostaną wyczyszczone po wykonaniu polecenia.

StartLostModeParams

Parametry powiązane z poleceniem START_LOST_MODE niezbędne do przejścia na tryb utraconego urządzenia. Aby urządzenie znalazło się w trybie utraconego urządzenia, trzeba podać co najmniej 1 z tych parametrów (bez nazwy organizacji).

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

object (UserFacingMessage)

Wiadomość wyświetlana użytkownikowi, gdy urządzenie znajduje się w trybie utraconego urządzenia.
lostPhoneNumber

object (UserFacingMessage)

Numer telefonu, z którym zostanie nawiązane połączenie po naciśnięciu przycisku połączenia z właścicielem urządzenia w trybie utraconego urządzenia.
lostEmailAddress

string

Adres e-mail wyświetlany użytkownikowi, gdy urządzenie znajduje się w trybie utraconego urządzenia.
lostStreetAddress

object (UserFacingMessage)

Adres pocztowy wyświetlany użytkownikowi, gdy urządzenie działa w trybie utraconego urządzenia.
lostOrganization

object (UserFacingMessage)

Nazwa organizacji wyświetlana użytkownikowi, gdy urządzenie znajduje się w trybie utraconego urządzenia.

StopLostModeParams

Ten typ nie ma żadnych pól.

Parametry powiązane z poleceniem STOP_LOST_MODE, które pozwalają wyłączyć urządzenie z trybu utraconego urządzenia.

ClearAppsDataStatus

Stan polecenia CLEAR_APP_DATA umożliwiającego usunięcie z urządzenia danych określonych aplikacji.

Zapis JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Pola
results

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

Wyniki dla poszczególnych aplikacji, mapowanie z nazw pakietów na odpowiednie wyniki czyszczenia.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

Wynik próby wyczyszczenia danych 1 aplikacji.

Zapis JSON 
{
  "clearingResult": enum (ClearingResult)
}
Pola
clearingResult

enum (ClearingResult)

Wynik próby wyczyszczenia danych 1 aplikacji.

ClearingResult

Wynik próby wyczyszczenia danych 1 aplikacji.

Wartości w polu enum
CLEARING_RESULT_UNSPECIFIED Nieokreślony wynik.
SUCCESS Dane tej aplikacji zostały wyczyszczone.
APP_NOT_FOUND Nie można wyczyścić danych aplikacji, ponieważ nie została znaleziona.
APP_PROTECTED Nie można wyczyścić danych tej aplikacji, ponieważ jest ona chroniona. Może to dotyczyć na przykład aplikacji niezbędnych do funkcjonowania urządzenia, takich jak Sklep Google Play.
API_LEVEL Nie można wyczyścić danych aplikacji, ponieważ poziom interfejsu API urządzenia nie obsługuje tego polecenia.

StartLostModeStatus

Stan polecenia START_LOST_MODE umożliwiającego przełączenie urządzenia w tryb utraconego urządzenia.

Zapis JSON 
{
  "status": enum (Status)
}
Pola
status

enum (Status)

Stan. Zobacz StartLostModeStatus.

Stan

Stan. Zobacz StartLostModeStatus.

Wartości w polu enum
STATUS_UNSPECIFIED Nie określono. Ta wartość nie jest używana.
SUCCESS Urządzenie zostało przełączone w tryb utraconego urządzenia.
RESET_PASSWORD_RECENTLY Nie udało się przełączyć urządzenia w tryb utraconego urządzenia, ponieważ administrator ostatnio zresetował do niego hasło.
USER_EXIT_LOST_MODE_RECENTLY Nie udało się przełączyć urządzenia w tryb utraconego urządzenia, ponieważ użytkownik niedawno wyszedł z tego trybu.
ALREADY_IN_LOST_MODE Urządzenie jest już w trybie utraconego urządzenia.

StopLostModeStatus

Stan polecenia STOP_LOST_MODE umożliwiającego wyjście z trybu utraconego urządzenia.

Zapis JSON 
{
  "status": enum (Status)
}
Pola
status

enum (Status)

Stan. Zobacz StopLostModeStatus.

Stan

Stan. Zobacz StopLostModeStatus.

Wartości w polu enum
STATUS_UNSPECIFIED Nie określono. Ta wartość nie jest używana.
SUCCESS Urządzenie zostało wyłączone z trybu utraconego urządzenia.
NOT_IN_LOST_MODE Urządzenie nie jest w trybie utraconego urządzenia.