Method: enterprises.devices.issueCommand

デバイスにコマンドを送信します。返された Operation リソースの metadata フィールドには Command が含まれています。get オペレーション メソッドを使用して、コマンドのステータスを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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)

コマンドのタイプ。
createTime

string (Timestamp format)

コマンドが作成されたときのタイムスタンプ。タイムスタンプはサーバーによって自動的に生成されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
duration

string (Duration format)

コマンドが有効な期間。この間にデバイスで実行されなかった場合、コマンドは期限切れになります。指定しない場合、デフォルトの時間は 10 分です。最大時間はありません。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
userName

string

デバイスを所有するユーザーのリソース名（enterprises/{enterpriseId}/users/{userId} 形式）。これは、コマンドが送信されるデバイスに基づいてサーバーが自動的に生成します。
errorCode

enum (CommandErrorCode)

コマンドが失敗した場合は、失敗を説明するエラーコード。呼び出し元によってコマンドがキャンセルされた場合、このフラグは設定されません。
newPassword

string

RESET_PASSWORD タイプのコマンドの場合は、必要に応じて新しいパスワードを指定します。注: Android 14 デバイスの場合、新しいパスワードは数字のみの場合は 6 文字以上にする必要があります。一致しない場合、コマンドは INVALID_VALUE で失敗します。
resetPasswordFlags[]

enum (ResetPasswordFlag)

RESET_PASSWORD タイプのコマンドの場合は、必要に応じてフラグを指定します。

共用体フィールド params。コマンドに固有のパラメータ。ただし、一部のコマンド（特に LOCK、RESET_PASSWORD、REBOOT、RELINQUISH_OWNERSHIP）では使用されません。今後、これらのコマンドでも使用される可能性があります。

これを設定する場合、new_password フィールドと reset_password_flags フィールドは設定しないでください。params は次のいずれかになります。
clearAppsDataParams

object (ClearAppsDataParams)

指定したアプリのデータをデバイスから消去する CLEAR_APP_DATA コマンドのパラメータ。ClearAppsDataParams をご覧ください。これを設定する場合は、type を設定しないことをおすすめします。この場合、サーバーは自動的に CLEAR_APP_DATA に設定します。type を明示的に CLEAR_APP_DATA に設定することもできます。
startLostModeParams

object (StartLostModeParams)

デバイスを紛失モードにするための START_LOST_MODE コマンドのパラメータ。StartLostModeParams をご覧ください。これを設定する場合は、type を設定しないことをおすすめします。この場合、サーバーは自動的に START_LOST_MODE に設定します。type を明示的に START_LOST_MODE に設定することもできます。
stopLostModeParams

object (StopLostModeParams)

デバイスを紛失モードから解除する STOP_LOST_MODE コマンドのパラメータ。StopLostModeParams をご覧ください。これを設定する場合は、type を設定しないことをおすすめします。この場合、サーバーは自動的に STOP_LOST_MODE に設定します。type を明示的に STOP_LOST_MODE に設定することもできます。
共用体フィールド status。コマンド固有のステータス。ただし、一部のコマンド（特に LOCK、RESET_PASSWORD、REBOOT、RELINQUISH_OWNERSHIP）では使用されません。今後、これらのコマンドでも使用される可能性があります。status は次のいずれかになります。
clearAppsDataStatus

object (ClearAppsDataStatus)

出力専用。デバイスから指定したアプリのデータを消去する CLEAR_APP_DATA コマンドのステータス。ClearAppsDataStatusをご確認ください。
startLostModeStatus

object (StartLostModeStatus)

出力専用。デバイスを紛失モードにするための START_LOST_MODE コマンドのステータス。StartLostModeStatusをご確認ください。
stopLostModeStatus

object (StopLostModeStatus)

出力専用。デバイスの紛失モードを解除する STOP_LOST_MODE コマンドのステータス。StopLostModeStatusをご確認ください。

CommandType

コマンドの種類。

列挙型
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 もご覧ください。

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[]

string

コマンドの実行時にデータが消去されるアプリのパッケージ名。

StartLostModeParams

デバイスを紛失モードにするための START_LOST_MODE コマンドに関連付けられたパラメータ。デバイスを紛失モードにするには、組織名を除くパラメータを少なくとも 1 つ指定する必要があります。

JSON 表現 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
フィールド
lostMessage

object (UserFacingMessage)

デバイスが紛失モードになっているときにユーザーに表示されるメッセージ。
lostPhoneNumber

object (UserFacingMessage)

デバイスが紛失モードになっていて、[所有者に通話] ボタンがタップされたときに発信される電話番号。
lostEmailAddress

string

デバイスが紛失モードになっているときにユーザーに表示されるメールアドレス。
lostStreetAddress

object (UserFacingMessage)

デバイスが紛失モードになっているときにユーザーに表示される住所。
lostOrganization

object (UserFacingMessage)

デバイスが紛失モードになっているときにユーザーに表示される組織名。

StopLostModeParams

この型にはフィールドがありません。

デバイスの紛失モードを解除する 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

1 つのアプリのデータを消去しようとした結果。

JSON 表現 
{
  "clearingResult": enum (ClearingResult)
}
フィールド
clearingResult

enum (ClearingResult)

1 つのアプリのデータを消去しようとした結果。

ClearingResult

1 つのアプリのデータを消去しようとした結果。

列挙型
CLEARING_RESULT_UNSPECIFIED 結果が指定されていません。
SUCCESS このアプリのデータは正常に消去されました。
APP_NOT_FOUND このアプリのデータは、アプリが見つからなかったため消去できませんでした。
APP_PROTECTED このアプリは保護されているため、このアプリのデータは削除できませんでした。たとえば、Google Play ストアなど、デバイスの機能に不可欠なアプリに適用される場合があります。
API_LEVEL デバイスの API レベルがこのコマンドをサポートしていないため、このアプリのデータは消去できませんでした。

StartLostModeStatus

デバイスを紛失モードにするための 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 デバイスがすでに紛失モードになっている。

StopLostModeStatus

デバイスの紛失モードを解除する STOP_LOST_MODE コマンドのステータス。

JSON 表現 
{
  "status": enum (Status)
}
フィールド
status

enum (Status)

ステータス。StopLostModeStatus をご覧ください。

ステータス

ステータス。StopLostModeStatus をご覧ください。

列挙型
STATUS_UNSPECIFIED 指定なし。この値は使用されません。
SUCCESS デバイスの紛失モードが解除されました。
NOT_IN_LOST_MODE デバイスが紛失モードになっていないこと。