In-App アップデーター (In-App Updater)
最終更新
最終更新
In-App アップデーター プラグインは、アプリの再ビルド・再パッケージ化を行わずに、アプリで使用している HTML5 アセットを更新するためのプラグインです。
In-App アップデーター プラグインを使用する場合は、別途、更新ファイルをホストする Web サーバーが必要になります (アプリから、これらのファイルへアクセスできること )。
このプラグインを使用するためには、対応するプランへの加入が必要となります。詳細は、 料金プラン をご確認ください。
このプラグインは、カスタムビルドデバッガーでは利用できません。 動作検証を行う場合は、デバッグビルドを行い、実機で確認する必要があります。
Cordova 9 以降
iOS 11 以降
Android 5.1 以降 (6.0以降を推奨)
Monaca クラウド IDE から設定 → Cordova プラグインの管理
を選択します。
利用可能なプラグイン 項目の InAppUpdater
プラグインにカーソルを置き、有効
ボタンをクリックします。
3. 次に、有効なプラグイン 項目へ行き、先ほど追加したプラグイン上に、カーソルを置き、設定
ボタンをクリックします。
CheckUpdate URL と Download URL 欄を適宜入力して、OK
ボタンをクリックします。
Monaca クラウド IDE から、
ビルド → Androidアプリのビルド → リリース向けビルド → In-App Updater用更新ファイル
ビルド → iOSアプリのビルド → リリース向けビルド → In-App Updater用更新ファイル
を選択し、ビルドを開始する
ボタンをクリックします。
In-App アップデーター プラグインは、対象アプリのバージョンに対して、HTML5 アセットを更新します。 HTML5 アセットを更新する場合は、Web サーバー側の更新ファイルに新しい更新番号の設定を行います。
Web サーバー側の更新ファイルについては、CheckUpdate URL を参照ください。
※ Android 9以降ではhttp通信が禁止されているため、通信プロトコルについてこちらを確認ください。
本プラグインを利用するためには、CheckUpdate URL と Download URL の二つのWeb API(URL)が必要となります。
更新ファイル情報を提供する Web API の URL を指定します。更新ファイル情報は、以下のように JSON 形式で作成します。
更新ファイル情報は、getServerVersion() メソッドの Promise によって返される JSON オブジェクトの updateInfo
パラメータによって取得できます。
更新用 HTML5 アセットファイル ( ZIP 形式 ) の URL を指定します。
download() メソッドでダウンロード URL を設定すると、この設定を省略できます。
このプラグインの最もシンプルな使用方法は、autoUpdate() を使用して、更新ファイルのダウンロード ( プラグインの設定 を参照のこと ) とアプリの更新を自動で行うことです。
getServerVersion()、download()、updateAndRestart() などのメソッドを組わせて使用すれば、更新処理をカスタマイズすることもできます。
このプラグインが提供しているメソッドは次のとおりです。
メソッド | 解説 |
更新ファイルの情報をサーバー側から取得します。 | |
getServerVersion() の処理を中断します。 | |
現在のアプリの更新番号を確認します。 | |
更新用ファイルをダウンロードします。 | |
download() の処理を中断します。 | |
ダウンロードした更新用ファイルを展開し、アプリを再起動します。 | |
プラグインの状態を確認します。 | |
ダイアログ ( タイトルとメッセージ ) を表示します。 | |
警告ダイアログを閉じます。 | |
進捗表示用ダイアログを表示します。 | |
進捗表示用ダイアログを更新します。 | |
進捗表示用ダイアログを閉じます。 | |
ネットワークの状態 ( Wifi、3G/LTE、接続なし など ) を確認します。 | |
アプリを強制終了します。 | |
更新ファイルのダウンロードとアプリの更新を自動的に行います。 |
更新ファイルの情報をサーバー側から取得します。
パラメーター ( JSON オブジェクト)
プロパティ | 型 | 解説 |
| 数値 | サーバー接続を開始するまでの待機時間 ( ミリ秒単位 ) |
| 数値 | ( Android 専用 ) サーバー接続時に適用するタイムアウト時間 ( ミリ秒単位 ) |
| 数値 | ( Android 専用 ) サーバーからのレスポンス受信時に適用するタイムアウト時間 ( すべてのレスポンスを受け取るまでの時間、ミリ秒単位 ) |
| 数値 | ( iOS 専用 ) サーバーへのリクエスト送信時に適用するタイムアウト時間。タイムアウトが発生した場合でも、リクエストは自動的に再送信されます。エラーは出力されません。 |
| 数値 | ( iOS 専用 ) サーバーからのレスポンス受信時に適用するタイムアウト時間 ( すべてのレスポンスを受け取るまでの時間、ミリ秒単位 ) |
戻り値 (Promise)
成功時のコールバックには、次のような内容の JSON オブジェクトが渡されます。
プロパティ | 型 | 解説 |
| 真偽値 | 現在のアプリのバージョンを更新する必要があるかを示します。 |
| 真偽値 | 現在のアプリのバージョンに適用できる更新ファイルがあるかを示します。 |
| 文字列 | アプリの最新バージョン |
| 文字列 | 現在のアプリのバージョン |
| 文字列 | 現在のアプリのバージョンに適用できる最新の更新番号 |
| 文字列 | 現在のアプリのバージョンが使用している更新番号 |
| JSON オブジェクト | サーバー側の設定が、次のようになっている場合、
|
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
getServerVersion()
の処理を中断します。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
現在のアプリの更新番号を確認します。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
更新用ファイルをダウンロードします。
パラメーター ( JSON オブジェクト)
プロパティ | 型 | 解説 |
| 数値 | 対象のアプリのバージョン |
| 数値 | 更新番号 |
| 数値 | ( Android 専用 ) バッファーサイズ ( バイト単位 )。デフォルト値は |
| 文字列 | 設定された URL から Zip ファイルをダウンロードします。この値を設定しない場合には、Download URL の値 ( |
| 数値 | サーバー接続を開始するまでの待機時間 ( ミリ秒単位 ) |
| 数値 | ( Android 専用 ) サーバー接続時に適用するタイムアウト時間 ( ミリ秒単位 ) |
| 数値 | ( Android 専用 ) サーバーからのレスポンス受信時に適用するタイムアウト時間 ( すべてのレスポンスを受け取るまでの時間、ミリ秒単位 ) |
| 数値 | ( iOS 専用 ) サーバーへのリクエスト送信時に適用するタイムアウト時間。タイムアウトが発生した場合でも、リクエストは自動的に再送信されます。エラーは出力されません。 |
| 数値 | ( iOS 専用 ) サーバーからのレスポンス受信時に適用するタイムアウト時間 ( すべてのレスポンスを受け取るまでの時間、ミリ秒単位 ) |
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
進捗表示コールバックには、ダウンロードの進捗状況を示す、次のような JSON オブジェクトが渡されます。
名前 | 型 | 解説 |
| 数値 | これまでにダウンロードされたファイルのサイズ |
| 数値 | ダウンロードされるファイルの予想サイズ |
例
download()
の処理を中断します。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
ダウンロードした更新用ファイルを展開し、アプリを再起動します。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
進捗表示コールバックには、展開処理の進捗状況を示す、次のような JSON オブジェクトが渡されます。
名前 | 型 | 解説 |
| 数値 | Zip ファイルを展開して得られた、現在までのファイル数 |
| 数値 | 展開予定の更新ファイル数 |
例
プラグインの状態を確認します。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、次のような内容の JSON オブジェクトが渡されます。
名前 | 型 | 解説 |
| 真偽値 | プラグインが処理中の場合、 |
| 文字列 | 処理に関する情報が格納されています。 |
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
ダイアログ ( タイトルとメッセージ ) を表示します。
パラメーター ( JSON オブジェクト)
プロパティ | 型 | 解説 |
| 文字列 | ダイアログのタイトル |
| 文字列 | メッセージ本文 |
| JSON オブジェクト | ボタンは、次の 2 つの要素で構成されます。
例 :
|
| JSON オブジェクト | キャンセルボタンは、次の 2 つの要素で構成されます。
例 :
|
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
警告 ( Alert ) ダイアログを閉じます。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
進捗表示 ( Progress ) 用ダイアログを表示します。こちらのダイアログでは、更新の進捗状況が表示されます。
パラメーター ( JSON オブジェクト)
プロパティ | 型 | 解説 |
| 文字列 | ダイアログのタイトル |
| 文字列 | メッセージ本文 |
| 数値 | カウンターの最大値です。ファイルをダウンロードする場合には、ファイル総数となります。 |
| 数値 | 進捗を示す値です。ファイルをダウンロードする場合には、ダウンロード済みのファイル総数となります。 |
| JSON オブジェクト | キャンセルボタンは、次の 2 つの要素で構成されます。
例 :
|
| コールバック関数 | ダイアログを閉じたときに呼ばれる関数です。 |
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
進捗表示 ( Progress ) 用ダイアログを更新します。
パラメーター ( JSON オブジェクト)
プロパティ | 型 | 解説 |
| 数値 | 進捗を示す値 |
戻り値 (Promise)
成功時にも引数は渡しません。
失敗時のコールバックはありません。
例
進捗表示 ( Progress ) 用ダイアログを閉じます。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
ネットワークの状態 ( Wifi、3G/LTE、接続なし など ) を確認します。
パラメーター
なし
戻り値 (Promise)
成功時のコールバックには、次のような内容の JSON オブジェクトが渡されます。
名前 | 型 | 解説 |
| 真偽値 | 通信事業者のネットワークが利用できる場合には、 |
| 真偽値 | WiFi が利用できる場合には、 |
| 真偽値 | ネットワーク接続 ( 通信事業者のネットワークまたは WiFi ) を利用できる場合には |
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
アプリを強制終了します。
このメソッドは、旧 InAppUpdater
( Cordova 5 向けの v2.0.4 ) との互換性を維持するために提供されているメソッドです。
こちらはクラッシュに相当するので、iOS での使用は推奨しません。Apple 側から申請をリジェクトされる可能性があります。
パラメーター
なし
戻り値 (Promise)
なし
例
更新ファイルのダウンロードとアプリの更新を自動的に行います。
パラメーター ( JSON オブジェクト)
プロパティ | 型 | 解説 |
| 数値 | サーバー接続を開始するまでの待機時間 ( ミリ秒単位 ) |
| JSON オブジェクト | アプリの更新時に表示されるダイアログ。次の変数が使用できます。
例 :
|
| コールバック関数 | 更新成功時に呼ばれる関数 |
| コールバック関数 | 更新失敗時に呼ばれる関数 |
戻り値 (Promise)
なし
例
Android 9 以降では、http プロトコルでの通信が原則禁止されています。
そのため、アップデートファイルを https
プロトコルで取得するように修正する必要があります。
動作テストなどで http プロトコルでの通信が必要となる場合は、以下のように、config.xml
の widget
タグに andorid 名前空間
設定を追加し、usesCleartextTraffic
設定を追加する必要があります。
カスタムスキームは、Cordova 10以降 および 本プラグインのバージョン 6.1.0以降で設定いただけます。
本プラグインは、iOSの場合、単体でschemeとhostnameを設定することが可能です。(アプリロジック暗号化プラグインとは共通です。)
まず、デフォルトのschemeとhostnameの下記設定を削除します。これが指定されている場合、ビルドエラーとなります。
次にconfig.xml
に以下のようにschemeとhostnameを設定していきます。この例では、schemeをmonacax-app
、hostnameをmonacax.io
としています。
schemeは,小文字で始まる文字列で構成されます。 小文字で始まり,その後に、次の任意の組合せが続く小文字の文字列です。
文字
数字
プラス ("+")
ピリオド (".")
ハイフン ("-")
また、monaca:scheme
と moanca:hostname
を省略 した場合、それぞれ monaca-plugin
と monaca.plugin
になります。
バージョン | 変更点 |
---|---|
7.1.1 | cordova-ios 7.1.0対応 |
6.2.3 | 大文字のスキーム、ホスト名を自動で小文字して認識 |
6.2.2 | 外部サイトからjsonファイルを取得するときの不具合を修正 |
6.2.1 | プログレスバースタイルの修正 |
6.2.0 | cordova-android10系以降に対応 (cordova-android 9系サポート終了) |
6.1.0 | CustomSchemeに対応 |
6.0.0 | Cordova10サポート (Cordova9 サポート終了) |
このプラグインで必要となるプライバシーマニフェストは以下のようになります。(cordova-ios 7.1.0以上)
マニフェストの記述方法について詳しくは https://ja.docs.monaca.io/release_notes/ios-privacy-manifest#puraibashmanifesutono を参照して下さい。