Method: enterprises.devices.issueCommand

Выдает команду устройству. Возвращенный ресурс Operation содержит Command в поле metadata . Используйте метод операции get , чтобы получить статус команды.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Имя устройства в формате enterprises/{enterpriseId}/devices/{deviceId} .

Тело запроса

Тело запроса содержит экземпляр Command .

Тело ответа

В случае успеха тело ответа содержит экземпляр Operation .

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Команда

Команда.

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.
}
Поля
type

enum ( CommandType )

Тип команды.

create Time

string ( Timestamp format)

Временная метка создания команды. Временная метка автоматически генерируется сервером.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

duration

string ( Duration format)

Продолжительность действия команды. Срок действия команды истечет, если она не будет выполнена устройством в течение этого времени. Продолжительность по умолчанию, если она не указана, составляет десять минут. Максимальной продолжительности не существует.

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

user Name

string

Имя ресурса пользователя, которому принадлежит устройство, в форме enterprises/{enterpriseId}/users/{userId} . Он автоматически генерируется сервером в зависимости от устройства, на которое отправляется команда.

error Code

enum ( CommandErrorCode )

Если команда не выполнена, отображается код ошибки, объясняющий сбой. Не устанавливается, когда команда отменяется вызывающим абонентом.

new Password

string

Для команд типа RESET_PASSWORD дополнительно указывает новый пароль. Примечание. Новый пароль должен содержать не менее 6 символов, если он цифровой, в случае устройств Android 14. В противном случае команда завершится с ошибкой INVALID_VALUE .

reset Password Flags[]

enum ( ResetPasswordFlag )

Для команд типа RESET_PASSWORD дополнительно задаются флаги.

params поля объединения. Параметры, специфичные для команды. Обратите внимание, что некоторые команды не используют это, в частности LOCK , RESET_PASSWORD , REBOOT и RELINQUISH_OWNERSHIP . В будущем эти команды также могут использовать это.

Если он установлен, то поля new_password и reset_password_flags не должны быть установлены. params могут быть только одним из следующих:

clear Apps Data Params

object ( ClearAppsDataParams )

Параметры для команды CLEAR_APP_DATA для очистки данных указанных приложений с устройства. См. ClearAppsDataParams . Если этот параметр установлен, то рекомендуется не задавать type . В этом случае сервер автоматически устанавливает значение CLEAR_APP_DATA . Также допустимо явно указать type CLEAR_APP_DATA .

start Lost Mode Params

object ( StartLostModeParams )

Параметры для команды START_LOST_MODE для перевода устройства в режим потери. См. StartLostModeParams . Если этот параметр установлен, то рекомендуется не задавать type . В этом случае сервер автоматически устанавливает для него значение START_LOST_MODE . Также допустимо явно указать type START_LOST_MODE .

stop Lost Mode Params

object ( StopLostModeParams )

Параметры для команды STOP_LOST_MODE для вывода устройства из режима потери. См. StopLostModeParams . Если этот параметр установлен, то рекомендуется не задавать type . В этом случае сервер автоматически устанавливает для него значение STOP_LOST_MODE . Также допустимо явно указать type STOP_LOST_MODE .

status поля объединения. Статус, специфичный для команды. Обратите внимание, что некоторые команды не используют это, в частности LOCK , RESET_PASSWORD , REBOOT и RELINQUISH_OWNERSHIP . В будущем эти команды также могут использовать это. status может быть только одним из следующих:
clear Apps Data Status

object ( ClearAppsDataStatus )

Только вывод. Статус команды CLEAR_APP_DATA для очистки данных указанных приложений с устройства. См. ClearAppsDataStatus .

start Lost Mode Status

object ( StartLostModeStatus )

Только вывод. Статус команды START_LOST_MODE для перевода устройства в режим потери. См. StartLostModeStatus .

stop Lost Mode Status

object ( StopLostModeStatus )

Только вывод. Статус команды STOP_LOST_MODE для вывода устройства из режима потери. См. StopLostModeStatus .

ТипКоманды

Типы команд.

Перечисления
COMMAND_TYPE_UNSPECIFIED Это значение запрещено.
LOCK Заблокируйте устройство, как если бы время ожидания блокировки экрана истекло.
RESET_PASSWORD Сбросьте пароль пользователя.
REBOOT Перезагрузите устройство. Поддерживается только на полностью управляемых устройствах под управлением Android 7.0 (уровень API 24) или выше.
RELINQUISH_OWNERSHIP Удаляет рабочий профиль и все политики с корпоративного устройства Android 8.0+, предоставляя устройство для личного использования. Приложения и данные, связанные с личными профилями, сохраняются. Устройство будет удалено с сервера после подтверждения команды.
CLEAR_APP_DATA Очищает данные приложений указанных приложений. Это поддерживается на Android 9 и выше. Обратите внимание, что приложение может хранить данные за пределами данных своего приложения, например, во внешнем хранилище или в пользовательском словаре. См. также clearAppsDataParams .
START_LOST_MODE Переводит устройство в режим пропажи. Поддерживается только на полностью управляемых устройствах или устройствах, принадлежащих организации, с управляемым профилем. См. также startLostModeParams .
STOP_LOST_MODE Выводит устройство из режима пропажи. Поддерживается только на полностью управляемых устройствах или устройствах, принадлежащих организации, с управляемым профилем. См. также stopLostModeParams .

Коммандерроркоде

Код ошибки команды. Это поле, доступное только для чтения, заполняемое сервером.

Перечисления
COMMAND_ERROR_CODE_UNSPECIFIED Ошибки не было.
UNKNOWN Произошла неизвестная ошибка.
API_LEVEL Уровень API устройства не поддерживает эту команду.
MANAGEMENT_MODE Режим управления (владелец профиля, владелец устройства и т. д.) не поддерживает команду.
INVALID_VALUE Команда имеет недопустимое значение параметра.
UNSUPPORTED Устройство не поддерживает команду. Обновление Политики устройств Android до последней версии может решить проблему.

СброспароляФлаг

Флаги, которые можно использовать для типа команды RESET_PASSWORD .

Перечисления
RESET_PASSWORD_FLAG_UNSPECIFIED Это значение игнорируется.
REQUIRE_ENTRY Не позволяйте другим администраторам снова менять пароль, пока пользователь не введет его.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Не запрашивайте учетные данные пользователя при загрузке устройства.
LOCK_NOW Заблокируйте устройство после сброса пароля.

ClearAppsDataParams

Параметры, связанные с командой CLEAR_APP_DATA для очистки данных указанных приложений с устройства.

JSON-представление 
{
  "packageNames": [
    string
  ]
}
Поля
package Names[]

string

Имена пакетов приложений, данные которых будут удалены при выполнении команды.

СтартЛостРежимПарамс

Параметры, связанные с командой START_LOST_MODE для перевода устройства в режим потери. Для перевода устройства в режим пропажи необходимо указать хотя бы один из параметров, не включая название организации.

JSON-представление 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Поля
lost Message

object ( UserFacingMessage )

Сообщение, отображаемое пользователю, когда устройство находится в режиме потери.

lost Phone Number

object ( UserFacingMessage )

Номер телефона, на который будет звонить, когда устройство находится в режиме потери и нажата кнопка вызова владельца.

lost Email Address

string

Адрес электронной почты, отображаемый пользователю, когда устройство находится в режиме потери.

lost Street Address

object ( UserFacingMessage )

Адрес, отображаемый пользователю, когда устройство находится в режиме потери.

lost Organization

object ( UserFacingMessage )

Название организации, отображаемое пользователю, когда устройство находится в режиме потери.

СтопЛостРежимПарамс

Этот тип не имеет полей.

Параметры, связанные с командой STOP_LOST_MODE для вывода устройства из режима потери.

ClearAppsDataStatus

Статус команды CLEAR_APP_DATA для очистки данных указанных приложений с устройства.

JSON-представление 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Поля
results

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

Результаты для каждого приложения — сопоставление имен пакетов с соответствующим результатом очистки.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

PerAppResult

Результат попытки очистить данные одного приложения.

JSON-представление 
{
  "clearingResult": enum (ClearingResult)
}
Поля
clearing Result

enum ( ClearingResult )

Результат попытки очистки данных одного приложения.

ОчисткаРезультат

Результат попытки очистки данных одного приложения.

Перечисления
CLEARING_RESULT_UNSPECIFIED Неопределенный результат.
SUCCESS Данные этого приложения были успешно удалены.
APP_NOT_FOUND Данные этого приложения не удалось очистить, поскольку приложение не найдено.
APP_PROTECTED Данные этого приложения не могут быть удалены, поскольку приложение защищено. Например, это может относиться к приложениям, критически важным для работы устройства, таким как Google Play Store.
API_LEVEL Данные этого приложения не удалось очистить, поскольку уровень API устройства не поддерживает эту команду.

Стартлостмодестатус

Статус команды START_LOST_MODE для перевода устройства в режим потери.

JSON-представление 
{
  "status": enum (Status)
}
Поля
status

enum ( Status )

Статус. См. StartLostModeStatus .

Статус

Статус. См. StartLostModeStatus .

Перечисления
STATUS_UNSPECIFIED Не указано. Это значение не используется.
SUCCESS Устройство было переведено в режим потери.
RESET_PASSWORD_RECENTLY Устройство не удалось перевести в режим потери, так как администратор недавно сбросил пароль устройства.
USER_EXIT_LOST_MODE_RECENTLY Устройство не удалось перевести в режим пропажи, поскольку пользователь недавно вышел из режима пропажи.
ALREADY_IN_LOST_MODE Устройство уже находится в режиме пропажи.

СтопLostModeStatus

Статус команды STOP_LOST_MODE для вывода устройства из режима потери.

JSON-представление 
{
  "status": enum (Status)
}
Поля
status

enum ( Status )

Статус. См. StopLostModeStatus .

Статус

Статус. См. StopLostModeStatus .

Перечисления
STATUS_UNSPECIFIED Не указано. Это значение не используется.
SUCCESS Устройство выведено из режима пропажи.
NOT_IN_LOST_MODE Устройство не находится в режиме потери.