- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- 指令
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- AddEsimParams
- ActivationState
- RemoveEsimParams
- RequestDeviceInfoParams
- DeviceInfo
- WipeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- 狀態
- StopLostModeStatus
- 狀態
- EsimCommandStatus
- 狀態
- InternalErrorDetails
- OperationCodeDetail
- ErrorCodeDetail
- EsimInfo
- RequestDeviceInfoStatus
- 狀態
- EidInfo
- Eid
- 試試看!
向裝置發出指令。傳回的 Operation
資源會在 metadata
欄位中包含 Command
。使用取得作業方法取得指令狀態。
HTTP 要求
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
這個網址使用 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 |
指令的有效期限。如果裝置在這段時間內未執行指令,指令就會過期。如未指定,預設時間長度為十分鐘。沒有時間長度上限。 時間長度以秒為單位,最多可有 9 個小數位數,並應以「 |
userName |
裝置擁有者的資源名稱,格式為 |
errorCode |
如果指令失敗,系統會顯示說明失敗原因的錯誤代碼。如果呼叫端取消指令,系統就不會設定這個值。如要說明指令錯誤的原因,請依下列順序 (最優先) 選擇欄位:1. 指令專屬欄位,例如 |
newPassword |
如果是 |
resetPasswordFlags[] |
如果是 |
聯集欄位 如果設定這項政策,就不得設定 |
|
clearAppsDataParams |
|
startLostModeParams |
將裝置設為遺失模式的 |
stopLostModeParams |
|
addEsimParams |
(選用步驟) |
removeEsimParams |
(選用步驟) 使用 |
requestDeviceInfoParams |
(選用步驟) 用於取得裝置相關資訊的 |
wipeParams |
(選用步驟) 用於抹除裝置的 |
聯集欄位 status 。指令專屬狀態。請注意,部分指令不會使用這項功能,特別是 、 、 和 。日後這些指令也可能會使用這項功能。status 只能是下列其中一項: |
|
clearAppsDataStatus |
僅供輸出。 |
startLostModeStatus |
僅供輸出。將裝置設為遺失模式的 |
stopLostModeStatus |
僅供輸出。將裝置移出遺失模式的 |
esimStatus |
僅供輸出。 |
requestDeviceInfoStatus |
僅供輸出。 |
CommandType
指令類型。
列舉 | |
---|---|
COMMAND_TYPE_UNSPECIFIED |
這個值不允許使用。 |
LOCK |
鎖定裝置,就像螢幕鎖定逾時一樣。 |
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 卡設定檔,請使用 指令。如要決定清除裝置資料時如何處理 eSIM 卡設定檔,請在政策中設定 。注意:如要在單一裝置上佈建多張 eSIM 卡,建議在連續執行指令之間間隔幾分鐘。 |
REMOVE_ESIM |
從裝置中移除 eSIM 卡設定檔。這項功能適用於 Android 15 以上版本。另請參閱 。 |
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 卡設定檔後的啟用狀態。 |
ActivationState
下載 eSIM 卡設定檔後的啟用狀態。
列舉 | |
---|---|
ACTIVATION_STATE_UNSPECIFIED |
未指定 eSIM 啟用狀態。預設值為:個人裝置上的 eSIM 卡設定檔為 ,公司裝置上的 eSIM 卡設定檔為 。 |
ACTIVATED |
下載後,eSIM 卡會自動啟用。如果將此狀態設為個人裝置的啟用狀態,系統會拒絕執行指令。 |
NOT_ACTIVATED |
已下載 eSIM 卡設定檔,但尚未啟用。在這種情況下,使用者必須在裝置上啟用 eSIM 卡。 |
RemoveEsimParams
與
指令相關聯的參數,可從裝置移除 eSIM 卡設定檔。REMOVE_ESIM
JSON 表示法 |
---|
{ "iccId": string } |
欄位 | |
---|---|
iccId |
必要欄位。要刪除的 eSIM 卡設定檔 ICC ID。 |
RequestDeviceInfoParams
與
指令相關聯的參數,可取得裝置相關資訊。REQUEST_DEVICE_INFO
JSON 表示法 |
---|
{
"deviceInfo": enum ( |
欄位 | |
---|---|
deviceInfo |
必要欄位。要要求的裝置資訊類型。 |
DeviceInfo
要要求的裝置資訊類型。
列舉 | |
---|---|
DEVICE_INFO_UNSPECIFIED |
這個值不允許使用。 |
EID |
要求 eSIM 卡的 ID。系統會要求使用者核准揭露資訊,然後才會傳回結果。如果使用者未核准揭露事項,系統會傳回 。這項功能僅適用於設有工作資料夾的個人裝置,且裝置搭載 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 商店。 |
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 卡的相關資訊。只有在 eSIM 作業 |
聯集欄位 status_details 。 或 指令的狀態詳細資料。status_details 只能是下列其中一項: |
|
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 |
如果是 指令,裝置上找不到要移除的 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 |
未指定作業代碼詳細資料。Android Management API 無法辨識 。不過,請參閱 。 |
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。請注意,在本例中, 是 EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE 的最低有效 3 個位元組,用於指定主題代碼和原因代碼,如這裡所示。整數的最高有效位元組會歸零。舉例來說,主題代碼 8.11.1 和原因代碼 5.1 在 中會以二進位表示為 0000 0000 1000 1011 0001 0000 0101 0001,十進位則為 9113681。 |
OPERATION_HTTP |
詳情請參閱 EuiccManager.OPERATION_HTTP。 |
ErrorCodeDetail
與
相對應的錯誤代碼詳細資料。errorCode
EsimInfo
新增或移除的 eSIM 卡詳細資料。
JSON 表示法 |
---|
{ "iccId": string } |
欄位 | |
---|---|
iccId |
僅供輸出。eSIM 卡的 ICC ID。 |
RequestDeviceInfoStatus
指令的狀態。REQUEST_DEVICE_INFO
JSON 表示法 |
---|
{ "status": enum ( |
欄位 | |
---|---|
status |
僅供輸出。 |
聯集欄位 device_info 。管理員要求的裝置資訊詳細資料。只有在 為 時,才會填入這個欄位。device_info 只能是下列其中一項: |
|
eidInfo |
裝置 EID 的相關資訊。 |
狀態
指令的狀態。REQUEST_DEVICE_INFO
列舉 | |
---|---|
STATUS_UNSPECIFIED |
未指定。系統不會使用這個值。 |
SUCCEEDED |
裝置資訊已成功傳送。 |
PENDING_USER_ACTION |
使用者尚未完成分享裝置資訊的必要動作。 |
USER_DECLINED |
使用者拒絕分享裝置資訊。 |
UNSUPPORTED |
這部裝置不支援所要求的裝置資訊,例如裝置不支援 eSIM 卡。 |
EidInfo
裝置 EID 的相關資訊。
JSON 表示法 |
---|
{
"eids": [
{
object ( |
欄位 | |
---|---|
eids[] |
僅供輸出。每個 eUICC 晶片的 EID 資訊。 |
埃德
每個 eUICC 晶片的 EID 資訊。
JSON 表示法 |
---|
{ "eid": string } |
欄位 | |
---|---|
eid |
僅供輸出。EID |