- 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
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
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 |
コマンドが有効である期間。この期間内にデバイスで実行されない場合、コマンドは期限切れになります。指定しない場合のデフォルトの期間は 10 分です。最大期間はありません。
|
userName |
デバイスを所有するユーザーのリソース名( |
errorCode |
コマンドが失敗した場合は、失敗を説明するエラーコード。呼び出し元によってコマンドがキャンセルされた場合、これは設定されません。コマンドエラーの理由については、次の順序でフィールドを使用します(優先度の高い順)。1. |
newPassword |
|
resetPasswordFlags[] |
|
共用体フィールド このフィールドが設定されている場合、 |
|
clearAppsDataParams |
指定したアプリのデータをデバイスから消去する |
startLostModeParams |
デバイスを紛失モードにする |
stopLostModeParams |
デバイスを紛失モードから解除するための |
addEsimParams |
省略可。デバイスに eSIM プロファイルを追加する |
removeEsimParams |
省略可。デバイスから eSIM プロファイルを削除する |
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 プロファイルがどうなるかを指定するには、ポリシーで を設定します。注: 1 つのデバイスに複数の 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
デバイスを紛失モードにする
コマンドに関連付けられたパラメータ。デバイスを紛失モードにするには、組織名以外のパラメータを少なくとも 1 つ指定する必要があります。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 プロファイルが 、会社所有デバイスでは になります。 |
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 の識別子をリクエストします。結果を返す前に、ユーザーに情報の開示を承認するよう求められます。ユーザーが開示を承認しない場合、 が返されます。この機能は、仕事用プロファイルが設定された個人所有デバイスと 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 バイトであり、こちらで説明されているように、件名コードと理由コードを指定します。整数の最上位バイトはゼロに設定されます。たとえば、Subject Code が 8.11.1、Reason Code が 5.1 の場合、 では 0000 0000 1000 1011 0001 0000 0101 0001(2 進数)として表されます。これは 10 進数では 9113681 です。 |
OPERATION_HTTP |
詳しくは、EuiccManager.OPERATION_HTTP をご覧ください。 |
ErrorCodeDetail
に対応するエラーコードの詳細。errorCode
列挙型 | |
---|---|
ERROR_CODE_DETAIL_UNSPECIFIED |
エラーコードの詳細は指定されていません。 が Android Management API で認識されない。ただし、 を参照してください。 |
ERROR_TIME_OUT |
詳しくは、EuiccManager.ERROR_TIME_OUT をご覧ください。 |
ERROR_EUICC_MISSING |
詳しくは、EuiccManager.ERROR_EUICC_MISSING をご覧ください。 |
ERROR_UNSUPPORTED_VERSION |
詳しくは、EuiccManager.ERROR_UNSUPPORTED_VERSION をご覧ください。 |
ERROR_ADDRESS_MISSING |
詳しくは、EuiccManager.ERROR_ADDRESS_MISSING をご覧ください。 |
ERROR_INVALID_CONFIRMATION_CODE |
詳しくは、EuiccManager.ERROR_INVALID_CONFIRMATION_CODE をご覧ください。 |
ERROR_CERTIFICATE_ERROR |
詳しくは、EuiccManager.ERROR_CERTIFICATE_ERROR をご覧ください。 |
ERROR_NO_PROFILES_AVAILABLE |
詳しくは、EuiccManager.ERROR_NO_PROFILES_AVAILABLE をご覧ください。 |
ERROR_CONNECTION_ERROR |
詳しくは、EuiccManager.ERROR_CONNECTION_ERROR をご覧ください。 |
ERROR_INVALID_RESPONSE |
詳しくは、EuiccManager.ERROR_INVALID_RESPONSE をご覧ください。 |
ERROR_CARRIER_LOCKED |
詳しくは、EuiccManager.ERROR_CARRIER_LOCKED をご覧ください。 |
ERROR_DISALLOWED_BY_PPR |
詳しくは、EuiccManager.ERROR_DISALLOWED_BY_PPR をご覧ください。 |
ERROR_INVALID_ACTIVATION_CODE |
詳しくは、EuiccManager.ERROR_INVALID_ACTIVATION_CODE をご覧ください。 |
ERROR_INCOMPATIBLE_CARRIER |
詳しくは、EuiccManager.ERROR_INCOMPATIBLE_CARRIER をご覧ください。 |
ERROR_OPERATION_BUSY |
詳しくは、EuiccManager.ERROR_OPERATION_BUSY をご覧ください。 |
ERROR_INSTALL_PROFILE |
詳しくは、EuiccManager.ERROR_INSTALL_PROFILE をご覧ください。 |
ERROR_EUICC_INSUFFICIENT_MEMORY |
詳しくは、EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY をご覧ください。 |
ERROR_INVALID_PORT |
詳しくは、EuiccManager.ERROR_INVALID_PORT をご覧ください。 |
ERROR_SIM_MISSING |
詳しくは、EuiccManager.ERROR_SIM_MISSING をご覧ください。 |
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 |