- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- 指令
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- 狀態
- StopLostModeStatus
- 狀態
- 試試看!
向裝置發出指令。傳回的 Operation
資源在其 metadata
欄位中包含 Command
。使用 get 作業方法取得指令狀態。
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 總覽。
指令
指令。
JSON 表示法 |
---|
{ "type": enum ( |
欄位 | |
---|---|
type |
指令的類型。 |
createTime |
指令建立時間的時間戳記。伺服器會自動產生時間戳記。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |
duration |
指令有效的持續時間。如果裝置在這段期間內未執行,指令就會失效。如未指定,則預設持續時間為十分鐘。沒有時間長度上限。 持續時間以秒為單位,最多 9 個小數位數,結尾為「 |
userName |
擁有裝置的使用者資源名稱,格式為 |
errorCode |
如果指令失敗,系統會顯示用來說明失敗的錯誤代碼。當呼叫端取消指令時,系統不會設定此設定。 |
newPassword |
針對 |
resetPasswordFlags[] |
對於 |
聯集欄位 如果已設定,則不得設定 |
|
clearAppsDataParams |
|
startLostModeParams |
|
stopLostModeParams |
|
聯集欄位 status 。指令專屬的狀態。請注意,某些指令並未使用這個指令,特別是 、 、 和 。日後這些指令可能也會使用這個方法。status 只能採用下列其中一種設定: |
|
clearAppsDataStatus |
僅供輸出。 |
startLostModeStatus |
僅供輸出。用於讓裝置進入遺失模式的 |
stopLostModeStatus |
僅供輸出。讓裝置退出遺失模式的 |
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 |
讓裝置退出遺失模式。僅支援全代管裝置或設有受管理設定檔的機構擁有的裝置。另請參閱 。 |
CommandErrorCode
指令錯誤代碼。這是伺服器填入的唯讀欄位。
列舉 | |
---|---|
COMMAND_ERROR_CODE_UNSPECIFIED |
沒有任何錯誤。 |
UNKNOWN |
發生不明錯誤。 |
API_LEVEL |
裝置的 API 級別不支援這項指令。 |
MANAGEMENT_MODE |
管理模式 (設定檔擁有者、裝置擁有者等) 不支援該指令。 |
INVALID_VALUE |
指令含有無效的參數值。 |
UNSUPPORTED |
裝置不支援指令。將 Android Device Policy 更新至最新版本後,或許就能解決這個問題。 |
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
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 |
表示該裝置未處於遺失模式。 |