Method: enterprises.devices.issueCommand

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

Żą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 artykule Omówienie 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 określająca, kiedy polecenie zostało utworzone. Znak czasu jest generowany automatycznie przez serwer.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Czas, przez jaki polecenie jest ważne. Polecenie wygaśnie, jeśli nie zostanie wykonane w tym czasie przez urządzenie. Jeśli nie określisz inaczej, domyślny czas to 10 minut. Nie ma maksymalnego czasu trwania.

Czas w sekundach z maksymalnie 9 miejscami po przecinku, zakończony literą „s”. Przykład: "3.5s".
userName

string

Nazwa zasobu użytkownika, do którego należy urządzenie, w formacie enterprises/{enterpriseId}/users/{userId}. Serwer automatycznie generuje go na podstawie urządzenia, na które polecenie zostało wysłane.
errorCode

enum (CommandErrorCode)

Jeśli polecenie nie zadziała, kod błędu wyjaśniający błąd. Nie jest on ustawiany, gdy wywołujący anuluje polecenie.
newPassword

string

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

enum (ResetPasswordFlag)

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

Pole sumy params. Parametry związane z poszczególnymi poleceniami. Pamiętaj, że niektóre polecenia nie korzystają z tego, w szczególności LOCK, RESET_PASSWORD, REBOOT i RELINQUISH_OWNERSHIP. W przyszłości te polecenia mogą również używać tego parametru.

Jeśli ta wartość jest ustawiona, pola new_password i reset_password_flags nie mogą być ustawione. params może być tylko jednym z tych elementów:
clearAppsDataParams

object (ClearAppsDataParams)

Parametry polecenia CLEAR_APP_DATA służące do wyczyszczenia danych określonych aplikacji z urządzenia. Zobacz ClearAppsDataParams. Jeśli to pole jest skonfigurowane, sugeruje się, że type nie powinno być skonfigurowane. W takim przypadku serwer automatycznie ustawia tę wartość na CLEAR_APP_DATA. Dopuszczalne jest też jawne ustawienie wartości type na CLEAR_APP_DATA.
startLostModeParams

object (StartLostModeParams)

Parametry polecenia START_LOST_MODE wskazującego na przejście urządzenia w tryb utraconego urządzenia. Zobacz StartLostModeParams. Jeśli ta wartość jest ustawiona, zalecamy nie ustawiać wartości type. W takim przypadku serwer automatycznie ustawia tę wartość na START_LOST_MODE. Dopuszczalne jest też jawne ustawienie wartości type na START_LOST_MODE.
stopLostModeParams

object (StopLostModeParams)

Parametry polecenia STOP_LOST_MODE, które wyjmuje urządzenie z trybu utraconego urządzenia. Zobacz StopLostModeParams. Jeśli ta wartość jest ustawiona, zalecamy nie ustawiać wartości type. W tym przypadku serwer automatycznie ustawia wartość STOP_LOST_MODE. Dopuszczalne jest też bezpośrednie ustawienie atrybutu type jako STOP_LOST_MODE.
Pole sumy status. Stan powiązany z poleceniem. Pamiętaj, że niektóre polecenia nie korzystają z tego, w szczególności LOCK, RESET_PASSWORD, REBOOT i RELINQUISH_OWNERSHIP. W przyszłości te polecenia mogą również używać tego parametru. status może mieć tylko jedną z tych wartości:
clearAppsDataStatus

object (ClearAppsDataStatus)

Tylko dane wyjściowe. Stan polecenia CLEAR_APP_DATA służącego do usunięcia z urządzenia danych określonych aplikacji. Zobacz ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Tylko dane wyjściowe. Stan polecenia START_LOST_MODE, które przełącza urządzenie w tryb utraconego urządzenia. Zobacz StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Tylko dane wyjściowe. Stan polecenia STOP_LOST_MODE wskazującego na 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 upłynął czas oczekiwania na ekranie blokady.
RESET_PASSWORD zresetować hasło użytkownika,
REBOOT Uruchom ponownie 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 urządzenia z Androidem 8.0 lub nowszym należącego do firmy, co pozwala na korzystanie z urządzenia do celów osobistych. Aplikacje i dane powiązane z profilami osobistymi pozostają bez zmian. Urządzenie zostanie usunięte z serwera po potwierdzeniu polecenia.
CLEAR_APP_DATA Czyści dane aplikacji wybranych aplikacji. Ta funkcja jest obsługiwana na Androidzie 9 i nowszych. Pamiętaj, że aplikacja może przechowywać dane poza swoimi danymi, np. w pamięci zewnętrznej lub w słowniku użytkownika. Zobacz też clearAppsDataParams.
START_LOST_MODE Przełącza urządzenie w tryb utraconego urządzenia. Obsługiwane tylko na w pełni zarządzanych urządzeniach lub urządzeniach należących do organizacji z profilem zarządzanym. Zobacz też startLostModeParams.
STOP_LOST_MODE Powoduje wyjście z trybu utraconego urządzenia. Obsługiwane tylko na w pełni zarządzanych urządzeniach lub urządzeniach należących do organizacji z profilem zarządzanym. Zobacz też stopLostModeParams.

CommandErrorCode

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

Wartości w polu enum
COMMAND_ERROR_CODE_UNSPECIFIED Brak błędów.
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 ma nieprawidłową wartość parametru.
UNSUPPORTED Urządzenie nie obsługuje tego polecenia. Problem może rozwiązać zaktualizowanie Zasad dotyczących urządzeń z Androidem do najnowszej wersji.

ResetPasswordFlag

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

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

ClearAppsDataParams

Parametry powiązane z poleceniem CLEAR_APP_DATA służące do wyczyszczenia danych określonych aplikacji z urządzenia.

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, które umożliwia włączenie trybu utraconego urządzenia. Aby urządzenie znalazło się w trybie utraconego urządzenia, należy podać co najmniej 1 z 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)

Komunikat wyświetlany użytkownikowi, gdy urządzenie jest w trybie utraconego urządzenia.
lostPhoneNumber

object (UserFacingMessage)

Numer telefonu, z którym zostanie nawiązane połączenie, gdy urządzenie jest w trybie utraconego urządzenia i klikniesz przycisk Połącz z właścicielem.
lostEmailAddress

string

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

object (UserFacingMessage)

Adres ulicy wyświetlany użytkownikowi, gdy urządzenie jest w trybie utraconego urządzenia.
lostOrganization

object (UserFacingMessage)

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

StopLostModeParams

Ten typ nie ma pól.

Parametry powiązane z poleceniem STOP_LOST_MODE, które umożliwiają wyłączenie trybu utraconego urządzenia.

ClearAppsDataStatus

Stan polecenia CLEAR_APP_DATA służącego do usunięcia 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, czyli mapowanie nazw pakietów na odpowiednie wyniki weryfikacji.

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

PerAppResult

Wynik próby wyczyszczenia danych z pojedynczej aplikacji.

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

enum (ClearingResult)

Wynik próby wyczyszczenia danych z pojedynczej aplikacji.

ClearingResult

Wynik próby wyczyszczenia danych z pojedynczej aplikacji.

Wartości w polu enum
CLEARING_RESULT_UNSPECIFIED Wynik nieokreślony.
SUCCESS Dane tej aplikacji zostały usunięte.
APP_NOT_FOUND Nie udało się wyczyścić danych tej aplikacji, ponieważ nie udało się jej znaleźć.
APP_PROTECTED Nie udało się wyczyścić danych tej aplikacji, ponieważ jest ona chroniona. Może to dotyczyć na przykład aplikacji, które są kluczowe dla działania urządzenia, takich jak Sklep Google Play.
API_LEVEL Nie można było wyczyścić danych tej aplikacji, ponieważ poziom interfejsu API urządzenia nie obsługuje tego polecenia.

StartLostModeStatus

Stan polecenia START_LOST_MODE, które przełącza urządzenie 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 niedawno 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 opuścił go.
ALREADY_IN_LOST_MODE Urządzenie jest już w trybie utraconego urządzenia.

StopLostModeStatus

Stan polecenia STOP_LOST_MODE, które usuwa urządzenie 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 wyjęte z trybu utraconego urządzenia.
NOT_IN_LOST_MODE Urządzenie nie jest w trybie utraconego urządzenia.