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

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 デバイスが紛失モードではない。