- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- コマンド
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- StartLostModeParams
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- StopLostModeParams
- ClearAppsDataStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- PerAppResult
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ClearingResult
- StartLostModeStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ステータス
- StopLostModeStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ステータス
- 試してみる
デバイスにコマンドを発行します。返される Operation
リソースの metadata
フィールドには Command
が含まれます。get オペレーション メソッドを使用して、コマンドのステータスを取得します。
HTTP リクエスト
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
|
リクエスト本文
リクエストの本文には Command
のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には Operation
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/androidmanagement
詳しくは、OAuth 2.0 の概要をご覧ください。
コマンド
コマンド。
JSON 表現 |
---|
{ "type": enum ( |
フィールド | |
---|---|
type |
コマンドのタイプ。 |
createTime |
コマンドが作成された時点のタイムスタンプ。タイムスタンプはサーバーによって自動的に生成されます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
duration |
コマンドの有効期間。この間にデバイスによって実行されないと、コマンドは期限切れになります。指定しない場合のデフォルトの期間は 10 分です。最大期間はありません。
|
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
デバイスを紛失モードにするための
コマンドに関連付けられたパラメータ。デバイスを紛失モードにするには、組織名を除く少なくとも 1 つのパラメータを指定する必要があります。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
1 つのアプリのデータを消去しようとした結果。
JSON 表現 |
---|
{
"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 |
ステータス。 |
ステータス
ステータス。
をご覧ください。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 |
デバイスが紛失モードになっていない。 |