- HTTP-запрос
- Параметры пути
- Текст запроса
- Ответный текст
- Области полномочий
- Командование
- Тип команды
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- AddEsimParams
- Состояние активации
- RemoveEsimParams
- RequestDeviceInfoParams
- Информация об устройстве
- WipeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- Статус
- StopLostModeStatus
- Статус
- EsimCommandStatus
- Статус
- InternalErrorDetails
- OperationCodeDetail
- ErrorCodeDetail
- EsimInfo
- RequestDeviceInfoStatus
- Статус
- EidInfo
- Ид
- Попробуйте!
Отправляет команду устройству. Возвращаемый ресурс Operation содержит Command в поле metadata . Используйте метод getOperation , чтобы получить статус команды.
HTTP-запрос
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
В URL-адресе используется синтаксис транскодирования gRPC .
Параметры пути
| Параметры | |
|---|---|
name | Название устройства в формате |
Текст запроса
Тело запроса содержит экземпляр класса Command .
Ответный текст
В случае успеха тело ответа содержит экземпляр Operation .
Области полномочий
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/androidmanagement
Для получения более подробной информации см.OAuth 2.0 Overview .
Командование
Команда.
| JSON-представление |
|---|
{ "type": enum ( |
| Поля | |
|---|---|
type | Тип команды. |
createTime | Временная метка, в которую была создана команда. Временная метка генерируется сервером автоматически. Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: |
duration | Продолжительность действия команды. Если команда не будет выполнена устройством в течение этого времени, она истечет. Если продолжительность не указана, она составляет десять минут. Максимальная продолжительность не ограничена. Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « |
userName | Имя ресурса пользователя, которому принадлежит устройство, имеет формат |
errorCode | Если команда завершилась с ошибкой, отображается код ошибки, объясняющий причину сбоя. Этот код не устанавливается, если команда отменяется вызывающей стороной. Для анализа ошибок команды следует отдавать предпочтение полям в следующем порядке (наиболее предпочтительные — первыми): 1. Поля, специфичные для команды, такие как |
newPassword | Для команд типа |
resetPasswordFlags[] | Для команд типа |
Параметры, специфичные для данной команды. Обратите внимание, что некоторые команды их не используют, в частности Если этот параметр установлен, то поля | |
clearAppsDataParams | Параметры команды |
startLostModeParams | Параметры команды |
stopLostModeParams | Параметры команды |
addEsimParams | Необязательный параметр. Параметры для команды |
removeEsimParams | Необязательный параметр. Параметры для команды |
requestDeviceInfoParams | Необязательный параметр. Параметры для команды |
wipeParams | Необязательный параметр. Параметры для команды |
| Конец взаимоисключающих областей. | |
Статус, специфичный для конкретной команды. Обратите внимание, что некоторые команды его не используют, в частности , , и . В будущем эти команды также могут его использовать. Ниже приведен список взаимоисключающих полей. В ответе будет установлено не более одного из полей: | |
clearAppsDataStatus | Только вывод. Состояние команды |
startLostModeStatus | Только вывод. Состояние команды |
stopLostModeStatus | Только вывод. Состояние команды |
esimStatus | Только вывод. Статус команды |
requestDeviceInfoStatus | Только вывод. Статус команды |
| Конец взаимоисключающих областей. | |
Тип команды
Типы команд.
| Перечисления | |
|---|---|
COMMAND_TYPE_UNSPECIFIED | Это значение недопустимо. |
LOCK | Заблокируйте устройство, как если бы истекло время ожидания блокировки экрана. Для рабочего профиля, если существует отдельная блокировка рабочего профиля, это блокирует только рабочий профиль, за одним исключением: на рабочих профилях на принадлежащих организации устройствах под управлением Android 8, 9 или 10 это блокирует все устройство. |
RESET_PASSWORD | Сбросить пароль пользователя. |
REBOOT | Перезагрузите устройство. Поддерживается только на полностью управляемых устройствах под управлением Android 7.0 (уровень API 24) или выше. |
RELINQUISH_OWNERSHIP | Удаляет рабочий профиль и все политики с принадлежащего компании устройства Android 8.0+, освобождая устройство для личного использования. Приложения и данные, связанные с личным(-ыми) профилем(-ами), сохраняются. Устройство будет удалено с сервера после подтверждения команды. |
CLEAR_APP_DATA | Очищает данные приложений указанных приложений. Поддерживается в Android 9 и выше. Обратите внимание, что приложение может хранить данные вне своего основного хранилища, например, во внешней памяти или в пользовательском словаре. См. также . |
START_LOST_MODE | Переводит устройство в режим «Потеряно». Поддерживается только на полностью управляемых устройствах или устройствах, принадлежащих организации и имеющих управляемый профиль. См. также . |
STOP_LOST_MODE | Выводит устройство из режима «Потеряно». Поддерживается только на полностью управляемых устройствах или устройствах, принадлежащих организации и имеющих управляемый профиль. См. также . |
ADD_ESIM | Добавляет профиль eSIM к устройству. Поддерживается в Android 15 и выше. См. также . Для удаления профиля eSIM используйте команду . Обратите внимание, что команда REMOVE_ESIM не поддерживается на корпоративных устройствах с рабочим профилем, работающих под управлением Android 16 QPR2 или Android 16 QPR3. Чтобы определить, что произойдет с профилем eSIM при очистке устройства, установите в политике. Примечание: Для инициализации нескольких eSIM на одном устройстве рекомендуется установить задержку в несколько минут между последовательными выполнениями команды. |
REMOVE_ESIM | Удаляет профиль eSIM с устройства. Поддерживается на устройствах Android 15 и выше. Эта команда не поддерживается на корпоративных устройствах с рабочим профилем, работающих под управлением Android 16 QPR2 или Android 16 QPR3. См. также . |
REQUEST_DEVICE_INFO | Запросите информацию, относящуюся к устройству. |
WIPE | Очищает устройство от данных, выполняя сброс до заводских настроек для устройства, принадлежащего компании, или удаляя рабочий профиль для личного устройства с рабочим профилем. Очистка происходит только после того, как устройство подтвердит команду. Команду можно отменить до этого момента. |
CommandErrorCode
Код ошибки команды. Это поле только для чтения, заполняемое сервером.
| Перечисления | |
|---|---|
COMMAND_ERROR_CODE_UNSPECIFIED | Ошибки не было. |
UNKNOWN | Произошла неизвестная ошибка. |
API_LEVEL | Данный API-интерфейс устройства не поддерживает эту команду. |
MANAGEMENT_MODE | Режим управления (владелец профиля, владелец устройства и т. д.) не поддерживает эту команду. |
INVALID_VALUE | Команда имеет недопустимое значение параметра. |
UNSUPPORTED | Устройство не поддерживает эту команду. Обновление политики устройств Android до последней версии может решить проблему. |
ResetPasswordFlag
Флаги, которые можно использовать для типа команды RESET_PASSWORD .
| Перечисления | |
|---|---|
RESET_PASSWORD_FLAG_UNSPECIFIED | Это значение игнорируется. |
REQUIRE_ENTRY | Не позволяйте другим администраторам повторно менять пароль, пока пользователь его не введёт. |
DO_NOT_ASK_CREDENTIALS_ON_BOOT | Не запрашивайте учетные данные пользователя при загрузке устройства. |
LOCK_NOW | После сброса пароля заблокируйте устройство. |
ClearAppsDataParams
Параметры, связанные с командой для очистки данных указанных приложений с устройства. CLEAR_APP_DATA
| JSON-представление |
|---|
{ "packageNames": [ string ] } |
| Поля | |
|---|---|
packageNames[] | Названия пакетов приложений, данные которых будут удалены при выполнении команды. |
StartLostModeParams
Параметры, связанные с командой для перевода устройства в режим потери. Для перевода устройства в режим потери необходимо указать хотя бы один из параметров, за исключением названия организации. START_LOST_MODE
| JSON-представление |
|---|
{ "lostMessage": { object ( |
| Поля | |
|---|---|
lostMessage | Сообщение, отображаемое пользователю, когда устройство находится в режиме утери. |
lostPhoneNumber | Номер телефона, на который будет совершен звонок, когда устройство будет находиться в режиме утери и будет нажата кнопка «Позвонить владельцу». |
lostEmailAddress | Адрес электронной почты, отображаемый пользователю, когда устройство находится в режиме утери. |
lostStreetAddress | Адрес, отображаемый пользователю, когда устройство находится в режиме утери. |
lostOrganization | Название организации, отображаемое пользователю, когда устройство находится в режиме утери. |
StopLostModeParams
Этот тип не содержит полей.
Параметры, связанные с командой для вывода устройства из режима потери. STOP_LOST_MODE
AddEsimParams
Параметры, связанные с командой для добавления профиля eSIM к устройству. ADD_ESIM
| JSON-представление |
|---|
{
"activationCode": string,
"activationState": enum ( |
| Поля | |
|---|---|
activationCode | Обязательно. Код активации для профиля eSIM. |
activationState | Обязательно. Состояние активации профиля eSIM после его загрузки. |
Состояние активации
Состояние активации профиля eSIM после его загрузки.
| Перечисления | |
|---|---|
ACTIVATION_STATE_UNSPECIFIED | Состояние активации eSIM не указано. По умолчанию профиль eSIM имеет значение на личных устройствах и на устройствах, принадлежащих компании. |
ACTIVATED | eSIM-карта автоматически активируется после загрузки. Установка этого параметра в качестве состояния активации для личных устройств приведет к отклонению команды. |
NOT_ACTIVATED | Профиль eSIM загружен, но не активирован. В этом случае пользователю потребуется активировать eSIM вручную на устройстве. |
RemoveEsimParams
Параметры, связанные с командой для удаления профиля eSIM с устройства. REMOVE_ESIM
| JSON-представление |
|---|
{ "iccId": string } |
| Поля | |
|---|---|
iccId | Обязательно. Идентификатор ICC профиля eSIM, который необходимо удалить. |
RequestDeviceInfoParams
Параметры, связанные с командой , для получения информации об устройстве. REQUEST_DEVICE_INFO
| JSON-представление |
|---|
{
"deviceInfo": enum ( |
| Поля | |
|---|---|
deviceInfo | Обязательно. Тип запрашиваемой информации об устройстве. |
Информация об устройстве
Тип запрашиваемой информации об устройстве.
| Перечисления | |
|---|---|
DEVICE_INFO_UNSPECIFIED | Это значение недопустимо. |
EID | Запросите идентификатор eSIM. Пользователю будет предложено подтвердить разрешение на раскрытие информации, прежде чем будет возвращен результат. Если пользователь не подтвердит разрешение, будет возвращено значение . Эта функция поддерживается только для личных устройств с рабочими профилями и версиями Android 13 и выше. |
WipeParams
Параметры, связанные с командой для очистки устройства. WIPE
| JSON-представление |
|---|
{ "wipeDataFlags": [ enum ( |
| Поля | |
|---|---|
wipeDataFlags[] | Необязательно. Флаги, определяющие, какие данные следует удалить. |
wipeReason | Необязательно. Короткое сообщение, отображаемое пользователю перед удалением рабочего профиля на личных устройствах. Это не влияет на устройства, принадлежащие компании. Максимальная длина сообщения — 200 символов. |
ClearAppsDataStatus
Статус команды для очистки данных указанных приложений с устройства. CLEAR_APP_DATA
| JSON-представление |
|---|
{
"results": {
string: {
object ( |
| Поля | |
|---|---|
results | Результаты для каждого приложения представляют собой сопоставление названий пакетов с соответствующими результатами очистки. Объект, содержащий список пар |
PerAppResult
Результат попытки очистить данные одного-единственного приложения.
| JSON-представление |
|---|
{
"clearingResult": enum ( |
| Поля | |
|---|---|
clearingResult | Результат попытки очистить данные одного-единственного приложения. |
ClearingResult
Результат попытки очистить данные одного-единственного приложения.
| Перечисления | |
|---|---|
CLEARING_RESULT_UNSPECIFIED | Результат не уточнен. |
SUCCESS | Данные этого приложения были успешно очищены. |
APP_NOT_FOUND | Данные этого приложения не удалось очистить, поскольку приложение не было найдено. |
APP_PROTECTED | Данные этого приложения не удалось удалить, поскольку оно защищено. Например, это может относиться к приложениям, критически важным для функционирования устройства, таким как Google Play Store. |
API_LEVEL | Не удалось очистить данные этого приложения, поскольку уровень API устройства не поддерживает эту команду. |
StartLostModeStatus
Статус команды для перевода устройства в режим потери. START_LOST_MODE
| JSON-представление |
|---|
{
"status": enum ( |
| Поля | |
|---|---|
status | Статус. См. |
Статус
Статус. См. . StartLostModeStatus
| Перечисления | |
|---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCESS | Устройство было переведено в режим "потеряно". |
RESET_PASSWORD_RECENTLY | Устройство не удалось перевести в режим утери, поскольку администратор недавно сбросил пароль устройства. |
USER_EXIT_LOST_MODE_RECENTLY | Устройство не удалось перевести в режим утери, поскольку пользователь недавно вышел из этого режима. |
ALREADY_IN_LOST_MODE | Устройство уже находится в режиме пропажи. |
StopLostModeStatus
Статус команды для вывода устройства из режима потери. STOP_LOST_MODE
| JSON-представление |
|---|
{
"status": enum ( |
| Поля | |
|---|---|
status | Статус. См. |
Статус
Статус. См. . StopLostModeStatus
| Перечисления | |
|---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCESS | Устройство было выведено из режима утери. |
NOT_IN_LOST_MODE | Устройство не находится в режиме утери. |
EsimCommandStatus
Информация о состоянии и сообщении об ошибке (если таковое имеется) команды или ADD_ESIM . REMOVE_ESIM
| JSON-представление |
|---|
{ "status": enum ( |
| Поля | |
|---|---|
status | Только вывод. Статус команды |
esimInfo | Только для вывода. Информация о добавленной или удаленной eSIM. Эта информация заполняется только тогда, когда |
Подробная информация о состоянии команды или . Ниже приведён список взаимоисключающих полей. В ответе будет установлено не более одного из этих полей: | |
internalErrorDetails | Только вывод. Подробности ошибки, если |
| Конец взаимоисключающих областей. | |
Статус
Статус команды или ADD_ESIM . REMOVE_ESIM
| Перечисления | |
|---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCESS | Операция eSIM на устройстве прошла успешно. |
IN_PROGRESS | Процесс внедрения eSIM-карт продолжается. |
PENDING_USER_ACTION | Для продолжения работы eSIM пользователю необходимо выполнить определенное действие. |
ERROR_SETUP_IN_PROGRESS | Операция eSIM не может быть выполнена, пока идет процесс настройки. |
ERROR_USER_DENIED | Пользователь отклонил операцию eSIM. |
INTERNAL_ERROR | Произошла ошибка при попытке добавить или удалить eSIM на устройстве. См. . |
ERROR_ICC_ID_NOT_FOUND | При выполнении команды iccId удаляемой eSIM-карты не был найден на устройстве. Это может означать либо то, что eSIM-карта не принадлежит предприятию, либо то, что eSIM-карта, соответствующая идентификатору отсутствует на устройстве. |
ERROR_MULTIPLE_ACTIVE_ESIMS_NO_AVAILABLE_SLOT | Команда завершилась с ошибкой при попытке добавить новую eSIM с состоянием активации , поскольку несколько слотов eSIM на устройстве содержат активные профили eSIM, и нет свободных слотов eSIM. Для решения этой проблемы новую eSIM можно добавить с состоянием активации для последующей ручной активации, или же пользователю необходимо сначала деактивировать существующую активную eSIM, чтобы операция могла продолжиться. |
InternalErrorDetails
Подробная информация о внутренних ошибках, если таковые имеются, для команд или ADD_ESIM . REMOVE_ESIM
| JSON-представление |
|---|
{ "operationCode": string, "errorCode": string, "operationCodeDetail": enum ( |
| Поля | |
|---|---|
operationCode | Только вывод. Целочисленное представление кода операции, как указано здесь . Дополнительные сведения см. в |
errorCode | Только вывод. Целочисленное представление кода ошибки, как указано здесь . См. также |
operationCodeDetail | Только вывод. Подробная информация о коде операции, соответствующая |
errorCodeDetail | Только вывод. Подробная информация о коде ошибки, соответствующем |
OperationCodeDetail
Подробная информация о коде операции, соответствующая параметру . operationCode
| Перечисления | |
|---|---|
OPERATION_CODE_DETAIL_UNSPECIFIED | Детали кода операции не указаны. Код не распознается API управления Android. Однако см. . |
OPERATION_SYSTEM | Подробности см. в EuiccManager.OPERATION_SYSTEM . |
OPERATION_SIM_SLOT | Подробности см. в файле EuiccManager.OPERATION_SIM_SLOT . |
OPERATION_EUICC_CARD | Подробности см. в файле EuiccManager.OPERATION_EUICC_CARD . |
OPERATION_SMDX | Подробности см. в файле EuiccManager.OPERATION_SMDX . |
OPERATION_SWITCH | Подробности см. в EuiccManager.OPERATION_SWITCH . |
OPERATION_DOWNLOAD | Подробности см. в EuiccManager.OPERATION_DOWNLOAD . |
OPERATION_METADATA | Подробности см. в EuiccManager.OPERATION_METADATA . |
OPERATION_EUICC_GSMA | Подробности см. в EuiccManager.OPERATION_EUICC_GSMA . |
OPERATION_APDU | Подробности см. в файле EuiccManager.OPERATION_APDU . |
OPERATION_SMDX_SUBJECT_REASON_CODE | Подробности см. в EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE . Обратите внимание, что в данном случае — это младшие 3 байта EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE , указывающие код субъекта и код причины, как указано здесь . Старший байт целого числа обнуляется. Например, код субъекта 8.11.1 и код причины 5.1 представлены в как 0000 0000 1000 1011 0001 0000 0101 0001 в двоичном представлении, что в десятичном — 9113681. |
OPERATION_HTTP | Подробности см. в EuiccManager.OPERATION_HTTP . |
ErrorCodeDetail
Подробная информация о коде ошибки, соответствующем . errorCode
| Перечисления | |
|---|---|
ERROR_CODE_DETAIL_UNSPECIFIED | Подробная информация о коде ошибки не указана. не распознается API управления Android. Однако см. |
ERROR_TIME_OUT | Подробности см. в EuiccManager.ERROR_TIME_OUT . |
ERROR_EUICC_MISSING | Подробности см. в EuiccManager.ERROR_EUICC_MISSING . |
ERROR_UNSUPPORTED_VERSION | Подробности см. в EuiccManager.ERROR_UNSUPPORTED_VERSION . |
ERROR_ADDRESS_MISSING | Подробности см. в EuiccManager.ERROR_ADDRESS_MISSING . |
ERROR_INVALID_CONFIRMATION_CODE | Подробности см. в EuiccManager.ERROR_INVALID_CONFIRMATION_CODE . |
ERROR_CERTIFICATE_ERROR | Подробности см. в EuiccManager.ERROR_CERTIFICATE_ERROR . |
ERROR_NO_PROFILES_AVAILABLE | Подробности см. в EuiccManager.ERROR_NO_PROFILES_AVAILABLE . |
ERROR_CONNECTION_ERROR | Подробности см. в EuiccManager.ERROR_CONNECTION_ERROR . |
ERROR_INVALID_RESPONSE | Подробности см. в EuiccManager.ERROR_INVALID_RESPONSE . |
ERROR_CARRIER_LOCKED | Подробности см. в EuiccManager.ERROR_CARRIER_LOCKED . |
ERROR_DISALLOWED_BY_PPR | Подробности см. в EuiccManager.ERROR_DISALLOWED_BY_PPR . |
ERROR_INVALID_ACTIVATION_CODE | Подробности см. в EuiccManager.ERROR_INVALID_ACTIVATION_CODE . |
ERROR_INCOMPATIBLE_CARRIER | Подробности см. в EuiccManager.ERROR_INCOMPATIBLE_CARRIER . |
ERROR_OPERATION_BUSY | Подробности см. в EuiccManager.ERROR_OPERATION_BUSY . |
ERROR_INSTALL_PROFILE | Подробности см. в EuiccManager.ERROR_INSTALL_PROFILE . |
ERROR_EUICC_INSUFFICIENT_MEMORY | Подробности см. в EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY . |
ERROR_INVALID_PORT | Подробности см. в EuiccManager.ERROR_INVALID_PORT . |
ERROR_SIM_MISSING | Подробности см. в EuiccManager.ERROR_SIM_MISSING . |
EsimInfo
Добавлены или удалены данные об eSIM.
| JSON-представление |
|---|
{ "iccId": string } |
| Поля | |
|---|---|
iccId | Только вывод. Идентификатор ICC eSIM. |
RequestDeviceInfoStatus
Статус команды . REQUEST_DEVICE_INFO
| JSON-представление |
|---|
{ "status": enum ( |
| Поля | |
|---|---|
status | Только вывод. Статус команды |
Подробная информация об устройстве, запрошенная администратором. Заполняется только при . Ниже приведен список взаимоисключающих полей. В ответе будет установлено не более одного из полей: | |
eidInfo | Информация, относящаяся к электронным идентификаторам устройства. |
| Конец взаимоисключающих областей. | |
Статус
Статус команды . REQUEST_DEVICE_INFO
| Перечисления | |
|---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCEEDED | Информация об устройстве успешно передана. |
PENDING_USER_ACTION | Пользователь не выполнил действия, необходимые для обмена информацией об устройстве. |
USER_DECLINED | Пользователь отказался от предоставления информации об устройстве. |
UNSUPPORTED | Запрошенная информация об устройстве не поддерживается данным устройством, например, eSIM не поддерживается данным устройством. |
EidInfo
Информация, относящаяся к электронным идентификаторам устройства.
| JSON-представление |
|---|
{
"eids": [
{
object ( |
| Поля | |
|---|---|
eids[] | Только вывод. Информация EID для каждого чипа eUICC. |
Ид
Идентификационная информация EID для каждого чипа eUICC.
| JSON-представление |
|---|
{ "eid": string } |
| Поля | |
|---|---|
eid | Только вывод. Идентификатор участника (EID). |