リファレンス | アプリカン | アプリ開発支援プラットフォーム

beacon-config.xml

アプリカンランタイムVersion1.12.0から外部に設定したxmlファイルの読み込みが可能となりました。設定はapplican-config.xmlで可能です。

ビーコンの設定情報を記述するbeacon-config.xmlの詳細は以下の通りです。

プロパティ

beacon-config	ビーコン定義の開始します。
beacons	監視対象ビーコン群の定義。複数の<beacon>を含めることができます。20個まで設定可能です。
beacon @uuid=[UUID] @major=[メジャー番号] @minor=[マイナー番号]	監視対象ビーコンの定義を開始します。majorおよびminorは省略可能です。
local-notification	ローカル通知の配送定義を行います。
retry-count	ローカル通知配送後にユーザーがポップアップ経由で開かない場合、ここで指定した回数だけローカル通知を繰り返します。
retry-interval-minutes	ローカル通知配送後にユーザーがポップアップ経由で開かない場合、ローカル通知を繰り返す間隔を指定します。
reset-time	ローカル通知のリトライ回数を元に戻す時刻を指定します。<reset-interval-minutes>も指定してされていた場合は、早く条件を満たした方が優先されます。
reset-interval-minutes	ローカル通知のリトライ回数を元に戻す間隔を指定します。<reset-time>も指定してされていた場合は早い方が優先されます。
conditions	ローカル通知配送条件定義。複数の<condition>を指定できます。ただし、ビーコン発見範囲が重複している場合は、先に定義されている条件が優先されます。
condition @major=[メジャー番号] @minor=[マイナー番号]	ローカル通知を行うビーコンの条件を指定します。majorおよびminorは<beacon>で指定したビーコンをさらに絞り込む場合に使用します。majorおよびminor省略可能です。
monitoring-range-meters @from=[開始] @to=[終了]	ビーコンまで距離の範囲を指定します。fromおよびtoの単位はメートルを使用する。fromおよびtoは省略可能です。
message	ローカル通知ポップアップ時に表示されるメッセージを定義します。
url	ローカル通知ポップアップを開くと表示されるURLを指定します。通知されるURLには以下のようなクエリーパラメーターが付加されます。 ?uuid=<UUID>&major=<MAJOR>&minor=<MINOR>&accuracy=<ACC>&rssi=<RSSI>&proximity=<PROX>&datetime=<DATE> その他にも、下記サンプルの様に自由にパラメータを渡すことが出来ます。ローカルファイルを開くときは、URLの開始を「local://」としてください。
history	ビーコン履歴設定を定義します。
max-history	ビーコン履歴最大保持数を指定します。
interval-seconds	ビーコン履歴を記録する間隔を秒で指定します。
expired-days	ビーコン履歴を保持する期間を日数で指定します。

beacon-config.xml初期設定

サンプルコード

<?xml version="1.0" encoding="utf-8" ?>
<beacon-config>
	<beacons>
		<beacon uuid="00000000-ABCD-1234-ABCD-012345678901">
			<local-notification>
				<retry-count>3</retry-count>
				<retry-interval-minutes>5</retry-interval-minutes>
				<reset-time>23:59</reset-time>
				<reset-interval-minutes>360</reset-interval-minutes>
				<conditions>
					<condition major="1">
						<monitoring-range-meters to="1" />
						<message lang="ja">目の前にお買い得商品があります。。</message>
						<url>local://coupon1.html</url>
					</condition>
					<condition>
						<monitoring-range-meters from="3" to="4" />
						<message lang="ja">近くに特典の受けられる商品があります。</message>
						<url>local://coupon2.html</url>
					</condition>
				</conditions>
			</local-notification>
			<history>
				<max-history>100</max-history>
				<interval-seconds>60</interval-seconds>
				<expired-days>90</expired-days>
			</history>
		</beacon>
		<beacon uuid="11111111-BCDE-4567-BCDE-109876543210" major="1" minor="2">
			<local-notification>
				<retry-count>3</retry-count>
				<retry-interval-minutes>2</retry-interval-minutes>
				<reset-time>23:59</reset-time>
				<reset-interval-minutes>10</reset-interval-minutes>
				<conditions>
					<condition>
						<monitoring-range-meters to="5" />
						<message lang="ja">いらっしゃいませ！</message>
						<url>local://coupon.html</url>
					</condition>
				</conditions>
			</local-notification>
			<history>
				<max-history>100</max-history>
				<interval-seconds>30</interval-seconds>
				<expired-days>90</expired-days>
			</history>
		</beacon>
	</beacons>
</beacon-config>