applican

マイページに戻る

39Geopla

従来のGPSに加えて、Wi-FiやBeaconなどの電波を用いたジオフェンシングも統一的に提供する機能です。使用するには別途サービスへのお申し込みが必要です。

※ジャンル・・・複数のジオポイントで構成されるグルーピングです。このジャンル指定単位でジオポイント群の取得が実行できます。
※メッシュ・・・現在位置に応じたジオポイントを取得します。

メソッド

init

メソッド説明

applican.geopla.init(Object callbacks, Function successCallback, Function errorCallback)

モジュールを初期化します。

パラメータ

callbackList : Object コールバックは以下の通りです。
didEnterWithEvent: Function<Event>
チェックインイベントが発生した際に呼び出されます。(型についてはJSONデータ構造を参照)
didExitWithEvent: Function<Error>
レンジングイベントが発生した際に呼び出されます。
didFailWithError: Function<Error>
エラーが発生した際に呼び出されます。
didRangeWithBeaconEvent: Function<Event>
チェックアウトイベントが発生した際に呼び出されます。(型についてはJSONデータ構造を参照
successCallback : Function 初期化が完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

var callbacks = {};

callbacks.didEnterWithEvent = function(result) {
	dumpCallback("* CB: didEnterWithEvent:" + JSON.stringify(result, null, "    "));
};
callbacks.didExitWithEvent = function(result) {
	dumpCallback("* CB: didExitWithEvent:" + JSON.stringify(result, null, "    "));
};
callbacks.didFailWithError = function(error) {
	dumpCallback("* CB: didFailWithError(" + error + ")");
};
callbacks.didRangeWithBeaconEvent = function(result) {
    dumpCallback("* CB: didRangeWithBeaconEvent:" + JSON.stringify(result, null, "    "));
};

function successCallback() {
	dumpApi("* init: Success");
}

function errorCallback(error) {
	dumpApi("* init: ERROR(" + error + ")");
}

applican.geopla.init(callbacks, successCallback, errorCallback);

showTermsOfService

メソッド説明

applican.geopla.showTermsOfService(Function<boolean> successCallback, Function errorCallback)

注意事項ダイアログを表示する。

パラメータ

successCallback<boolean> : Function ダイアログが閉じた場合に承諾結果がCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function showTermsOfServiceSuccessCallback(agree) {
	dumpApi("* showTermsOfService: Success(" + (agree ? "Allow" : "Deny") + ")");
}

function showTermsOfServiceErrorCallback(error) {
	dumpApi("* showTermsOfService: ERROR(" + error + ")");
}

applican.geopla.showTermsOfService(showTermsOfServiceSuccessCallback,
	showTermsOfServiceErrorCallback);

getTermOfServiceVersion

メソッド説明

applican.geopla.getTermOfServiceVersion(Function<string> successCallback, Function errorCallback)

利用規約のバージョンを取得します。

パラメータ

successCallback<string> : Function 利用規約のバージョンがCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function getTermsOfServiceVersionSuccessCallback(version) {
	dumpApi("* getTermOfServiceVersion: Success(" + version + ")");
}

function getTermsOfServiceVersionErrorCallback(error) {
	dumpApi("* getTermOfServiceVersion: ERROR(" + error + ")");
}

applican.geopla.getTermOfServiceVersion(getTermsOfServiceVersionSuccessCallback,
	getTermsOfServiceVersionErrorCallback);

sendLog

メソッド説明

applican.geopla.sendLog(Function successCallback, Function errorCallback)

現在端末内に保存されているログをすべて送信します。

パラメータ

successCallback : Function ログを送信した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function sendLogSuccess() {
	dumpApi("* sendLog: Success()");
}

function sendLogError(error) {
	dumpApi("* sendLog: ERROR(" + error + ")");
}

applican.geopla.sendLog(sendLogSuccess, sendLogError);

getClientId

メソッド説明

applican.geopla.getClientId(Function<string> successCallback)

GeoplaSDKが発行するクライアント識別子を取得します。

パラメータ

successCallback<string> : Function クライアント識別子がCallbackされます。

Return

void

サンプルコード

function clientIdSuccessCallback(clientId) {
	dumpApi("* getClientId: Success(" + clientId + ")");
}

applican.geopla.getClientId(clientIdSuccessCallback);

getVersion

メソッド説明

applican.geopla.getVersion(Function<string> successCallback)

GeoplaSDKのバージョン番号を返します。

パラメータ

successCallback<string> : Function バージョン番号がCallbackされます。

Return

void

サンプルコード

function versionSuccessCallback(version) {
	dumpApi("* getVersion: Success(" + version + ")");
}

applican.geopla.getVersion(versionSuccessCallback);

getGenres

メソッド説明

applican.geopla.getGenres(Function<Genre[]> successCallback, Function errorCallback)

登録されたジャンルの一覧を取得します。

パラメータ

successCallback<Genre[]> : Function ジャンルの一覧がCallbackされます。(型についてはJSONデータ構造を参照)
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function genresSuccessCallback(genres) {
	dumpApi("* getGenres: Success(" + genres + ")");
}

function genresErrorCallback(error) {
	dumpApi("* getGenres: ERROR(" + error + ")");
}

applican.geopla.getGenres(genresSuccessCallback, genresErrorCallback);

getSSID

メソッド説明

applican.geopla.getSSID(Function<string[]> successCallback, Function errorCallback)

サーバに登録されたSSIDの一覧を取得します。

パラメータ

successCallback<string[]> : Function SSIDの一覧がCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function ssidSuccessCallback(ssid) {
	dumpApi("* getSSID: Success(" + ssid + ")");
}

function ssidErrorCallback(error) {
	dumpApi("* getSSID: ERROR(" + error + ")");
}

applican.geopla.getSSID(ssidSuccessCallback, ssidErrorCallback);

setExternalParameters

メソッド説明

applican.geopla.getSSID(Object parameters, Function successCallback, Function errorCallback)

静的ログに任意の文字列データを追加します。 引数は2個までの設定可能であり、パラメータ名は、parameterAとparameterBで固定です。文字列は50文字までとなっており、50文字を超えるものは自動的に50文字に省略されます。

パラメータ

parameters : Object パラメータは以下の通りです。
parameterA: String
任意の文字列データ。
parameterB: String
任意の文字列データ。
successCallback : Function 任意の文字列データを追加した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function setParametersSuccessCallback() {
	dumpApi("* setExternalParameters: Success");
}

function setParametersErrorCallback(error) {
	dumpApi("* changeLocationService: ERROR(" + error + ")");
}

var parameters = {};
parameters.parameterA = "...";
parameters.parameterB = "...;

applican.geopla.setExternalParameters(parameters,
	setParametersSuccessCallback, setParametersErrorCallback);

clearCache

メソッド説明

applican.geopla.clearCache(Function successCallback, Function errorCallback)

キャッシュを削除します。

パラメータ

successCallback : Function キャッシュを削除した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function clearCacheSuccessCallback() {
	dumpApi("* clearCache: Success()");
}

function clearCacheErrorCallback(error) {
	dumpApi("* clearCache: ERROR(" + error + ")");
}

applican.geopla.clearCache(clearCacheSuccessCallback, clearCacheErrorCallback);

startGpsMeshGeofencing

メソッド説明

applican.geopla.startGpsMeshGeofencing(Object parameters, Function successCallback, Function errorCallback)

メッシュベースのGPSによるジオフェンシングサービスを開始します。

パラメータ

parameters : Object パラメータは以下の通りです。
interval: long
取得間隔のミリ秒
maxCacheCount: int
キャッシュの最大蓄積数
successCallback : Function 開始できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

parameters = {};
parameters.interval = GpsGeofencingSettings.LOCATION_REQUEST_INTERVAL_HIGH_ACCURACY_IN_MILLIS;
parameters.maxCacheCount = 50;

function successCallback() {
	dumpApi("* startGpsMeshGeofencing: Success");
}

function errorCallback(error) {
	dumpApi("* startGpsMeshGeofencing: ERROR");
}

applican.geopla.startGpsMeshGeofencing(parameters, successCallback, errorCallback);

stopGpsMesGeofencing

メソッド説明

applican.geopla.stopGpsMesGeofencing(Function successCallback, Function errorCallback)

実行中のstartGpsMeshGeofencing処理をを停止します。

パラメータ

successCallback : Function 停止できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function successCallback() {
	dumpApi("* stopGpsMeshGeofencing: Success()");
}

function errorCallback(error) {
	dumpApi("* stopGpsMeshGeofencing: ERROR(" + error + ")");
}

applican.geopla.stopGpsMeshGeofencing(successCallback, errorCallback);

startGpsGenreGeofencing

メソッド説明

applican.geopla.startGpsGenreGeofencing(Object parameters, Function successCallback, Function errorCallback)

ジャンルベースのGPSによるジオフェンシングサービスを開始します。

パラメータ

parameters : Object パラメータは以下の通りです。
interval: long
取得間隔のミリ秒
successCallback : Function 開始できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

parameters = {};
parameters.interval = GpsGeofencingSettings.LOCATION_REQUEST_INTERVAL_HIGH_ACCURACY_IN_MILLIS;

function successCallback() {
	dumpApi("* startGpsGenreGeofencing: Success");
}

function errorCallback(error) {
	dumpApi("* startGpsGenreGeofencing: ERROR");
}

applican.geopla.startGpsGenreGeofencing(parameters, successCallback, errorCallback);

stopGpsGenreGeofencing

メソッド説明

applican.geopla.stopGpsGenreGeofencing(Function successCallback, Function errorCallback)

実行中のstartGpsGenreGeofencing処理を停止します。

パラメータ

successCallback : Function 停止できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function successCallback() {
	dumpApi("* stopGpsGenreGeofencing: Success()");
}

function errorCallback(error) {
	dumpApi("* stopGpsGenreGeofencing: ERROR(" + error + ")");
}

applican.geopla.stopGpsGenreGeofencing(successCallback, errorCallback);

startWifiGenreGeofencing

メソッド説明

applican.geopla.startWifiGenreGeofencing(Object parameters, Function successCallback, Function errorCallback)

ジャンルベースのWiFiによるジオフェンシングサービスを開始します。

パラメータ

parameters : Object パラメータは以下の通りです。
interval: long
スキャン間隔のミリ秒
successCallback : Function 開始できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

parameters = {};
parameters.interval = WifiGeofencingSettings.GFPWifiGeofencingScanIntervalHigh;

function successCallback() {
	dumpApi("* startWifiGenreGeofencing: Success");
}

function errorCallback(error) {
	dumpApi("* startWifiGenreGeofencing: ERROR");
}

applican.geopla.startWifiGenreGeofencing(parameters, successCallback, errorCallback);

stopWifiGenreGeofencing

メソッド説明

applican.geopla.stopWifiGenreGeofencing(Function successCallback, Function errorCallback)

実行中のstartWifiGenreGeofencing処理を停止します。

パラメータ

successCallback : Function 停止できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function successCallback() {
	dumpApi("* stopWifiGenreGeofencing: Success()");
}

function errorCallback(error) {
	dumpApi("* stopWifiGenreGeofencing: ERROR(" + error + ")");
}

applican.geopla.stopWifiGenreGeofencing(successCallback, errorCallback);

startWifiNearbyGeofencing

メソッド説明

applican.geopla.startWifiNearbyGeofencing(Object parameters, Function successCallback, Function errorCallback)

Wi-Fiを検知したタイミングでサーバからジオポイントを取得し、それを元にチェックイン/アウト判定を行うジオフェンシング処理を開始します。

パラメータ

parameters : Object パラメータは以下の通りです。
interval: long
スキャン間隔のミリ秒
duration: long
キャッシュの有効期間のミリ秒
maxCacheCount: int
キャッシュの最大蓄積数
successCallback : Function 開始できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

parameters = {};
parameters.interval = WifiGeofencingSettings.GFPWifiGeofencingScanIntervalHigh;
parameters.maxCacheCount = 50;

function successCallback() {
	dumpApi("* startWifiNearbyGeofencing: Success");
}

function errorCallback(error) {
	dumpApi("* startWifiNearbyGeofencing: ERROR");
}

applican.geopla.startWifiNearbyGeofencing(parameters, successCallback, errorCallback);

stopWifiNearbyGeofencing

メソッド説明

applican.geopla.stopWifiNearbyGeofencing(Function successCallback, Function errorCallback)

実行中のstartWifiNearbyGeofencing処理を停止します。

パラメータ

successCallback : Function 停止できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function successCallback() {
	dumpApi("* stopWifiNearbyGeofencing: Success()");
}

function errorCallback(error) {
	dumpApi("* stopWifiNearbyGeofencing: ERROR(" + error + ")");
}

applican.geopla.stopWifiNearbyGeofencing(successCallback, errorCallback);

startBeaconGenreGeogfencing（Android専用）

メソッド説明

applican.geopla.startBeaconGenreGeogfencing(Object parameters, Function successCallback, Function errorCallback)

ジャンルベースのビーコンによるジオフェンシングサービスを開始します。（Android専用）

パラメータ

parameters : Object パラメータは以下の通りです。
interval: long
スキャン間隔のミリ秒
targettype: BeaconGenreBulkFetchGeofencing
モニタリング対象(iBeacon, TrackR, ユビキタス)
successCallback : Function 開始できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

parameters = {};
parameters.interval = BeaconGeofencingSettings.GFPBLEBeaconGeofencingScanIntervalHigh;
parameters.targettype = BeaconGenreBulkFetchGeofencing.TARGET_IBEACON
										| BeaconGenreBulkFetchGeofencing.TARGET_UBIQUITOUS;

function successCallback() {
	dumpApi("* startBeaconGenreGeogfencing: Success");
}

function errorCallback(error) {
	dumpApi("* startBeaconGenreGeogfencing: ERROR");
}

applican.geopla.startBeaconGenreGeogfencing(parameters, successCallback, errorCallback);

stopBeaconGenreGeogfencing（Android専用）

メソッド説明

applican.geopla.stopBeaconGenreGeogfencing(Function successCallback, Function errorCallback)

実行中のstartBeaconGenreGeogfencing処理を停止します。（Android専用）

パラメータ

successCallback : Function 停止できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function successCallback() {
	dumpApi("* stopBeaconGenreGeogfencing: Success()");
}

function errorCallback(error) {
	dumpApi("* stopBeaconGenreGeogfencing: ERROR(" + error + ")");
}

applican.geopla.stopBeaconGenreGeogfencing(successCallback, errorCallback);

startIBeaconGenreGeogfencing（iOS専用）

メソッド説明

applican.geopla.startIBeaconGenreGeogfencing(Object parameters, Function successCallback, Function errorCallback)

ジャンルベースのビーコンによるジオフェンシングサービスを開始します。（iOS専用）

パラメータ

parameters : Object パラメータは以下の通りです。
successCallback : Function 開始できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

parameters = {};

function successCallback() {
	dumpApi("* startIBeaconGenreGeogfencing: Success");
}

function errorCallback(error) {
	dumpApi("* startIBeaconGenreGeogfencing: ERROR");
}

applican.geopla.startIBeaconGenreGeogfencing(parameters, successCallback, errorCallback);

stopIBeaconGenreGeogfencing（iOS専用）

メソッド説明

applican.geopla.stopIBeaconGenreGeogfencing(Function successCallback, Function errorCallback)

実行中のstartBeaconGenreGeogfencing処理を停止します。（iOS専用）

パラメータ

successCallback : Function 停止できた場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

function successCallback() {
	dumpApi("* stopIBeaconGenreGeogfencing: Success()");
}

function errorCallback(error) {
	dumpApi("* stopIBeaconGenreGeogfencing: ERROR(" + error + ")");
}

applican.geopla.stopIBeaconGenreGeogfencing(successCallback, errorCallback);

JSONデータ構造

Genre

{
	"id": long
	"name": string
	"timestamp": string
}

ジャンルのパラメータ

id : string ジャンルID
name : string ジャンル名
update : string 最終更新日

GPSEvent

{
	"GPSEvent": {
		"timestamp": string
		"id": long
		"name": string
		"latitude": double
		"longitude": double
		"tags": string[]
		"isTracked": boolean
		"radius": int
	}
}

GPSポイントのパラメータ

timestamp : string タイムスタンプ
id : long ポイントID
name : string ポイント名
latitude : double 緯度
longitude : double 経度
tags : string[] タグ
isTracked : boolean 注視対象フラグ
radius : int 半径(メートル)

WifiEvent

{
	"WifiEvent": {
		"timestamp": string
		"rssi": string
		"id": long
		"name": string
		"latitude": double
		"longitude": double
		"tags": string[]
		"isTracked": boolean
		"ssid": string
		"bssid": string
		"key": string
		"isHidden": boolean
	}
}

Wi-Fiポイントのパラメータ

timestamp : string タイムスタンプ
rssi : string 電波強度
id : long ポイントID
name : string ポイント名
latitude : double 緯度
longitude : double 経度
tags : string[] タグ
isTracked : boolean 注視対象フラグ
ssid : string SSID
bssid : string BSSID
key : string キー
isHidden : boolean 秘匿状態

IBeaconEvent(IBeacon)

{
	"IBeaconEvent": {
		"type": string,
		"timestamp": string
		"rssis": int[]
		"txPower": int
		"id": long
		"name": string
		"latitude": double
		"longitude": double
		"tags": string[]
		"isTracked": boolean
		"uuid": string
		"major": int
		"minor": int
	}
}

iBeaconポイントのパラメータ

type : string "IBeacon"
timestamp : string タイムスタンプ
rssis : int[] 受信した電波の受信強度
txPower : int 電波の送信強度
id : long ポイントID
name : string ポイント名
latitude : double 緯度
longitude : double 経度
tags : string[] タグ
isTracked : boolean 注視対象フラグ
uuid : string UUID
major : int メジャー番号
minor : int マイナー番号

IBeaconEvent(Ubiquitous)

{
	"IBeaconEvent": {
		"type": string,
		"timestamp": string
		"rssis": int[]
		"txPower": int
		"id": long
		"name": string
		"latitude": double
		"longitude": double
		"tags": string[]
		"isTracked": boolean
		"sendCount": int
		"sendInterval": int
		"version": int
		"isLowBattery": string
		"ucode": boolean
	}
}

ユビキタスポイントのパラメータ

type : string "Ubiquitous"
timestamp : string タイムスタンプ
rssis : int[] 受信した電波の受信強度
txPower : int 電波の送信強度
id : long ポイントID
name : string ポイント名
latitude : double 緯度
longitude : double 経度
tags : string[] タグ
isTracked : boolean 注視対象フラグ
sendCount : int 送信回数
sendInterval : int 送信間隔
version : int ユビキタスの仕様バージョン
isLowBattery : boolean バッテリー低下状態
ucode : string UCODE

IBeaconEvent(TrackR)

{
	"IBeaconEvent": {
		"type": string,
		"timestamp": string
		"rssis": int[]
		"txPower": int
		"id": long
		"name": string
		"latitude": double
		"longitude": double
		"tags": string[]
		"isTracked": boolean
		"trackRId": string
	}
}

TrackRポイントのパラメータ

type : string "TrackR"
timestamp : string タイムスタンプ
rssis : int[] 受信した電波の受信強度
txPower : int 電波の送信強度
id : long ポイントID
name : string ポイント名
latitude : double 緯度
longitude : double 経度
tags : string[] タグ
isTracked : boolean 注視対象フラグ
trackRId : string TrackR ID

型注釈

GpsGeofencingSettings

GPSによるジオフェンシングのスキャン間隔のミリ秒

プロパティ名値
LOCATION_REQUEST_INTERVAL_HIGH_ACCURACY_IN_MILLIS60000
LOCATION_REQUEST_INTERVAL_MIDDLE_ACCURACY_IN_MILLIS300000
LOCATION_REQUEST_INTERVAL_LOW_ACCURACY_IN_MILLIS900000

WifiGeofencingSettings

Wi-Fiによるジオフェンシングのスキャン間隔のミリ秒

プロパティ名値
GFPWifiGeofencingScanIntervalHigh10
GFPWifiGeofencingScanIntervalMiddle60
GFPWifiGeofencingScanIntervalLow300

BeaconGeofencingSettings

ビーコンによるジオフェンシングのスキャン間隔のミリ秒

プロパティ名値
GFPBLEBeaconGeofencingScanIntervalHigh1.5
GFPBLEBeaconGeofencingScanIntervalMiddle60
GFPBLEBeaconGeofencingScanIntervalLow300

BeaconGenreBulkFetchGeofencing

ビーコンによるジオフェンシングのモニタリング対象

プロパティ名値内容
TARGET_IBEACON1iBeacon
TARGET_UBIQUITOUS2ユビキタス
TARGET_TRACKR4TrackR