マイページに戻る
連携サービス
設定ファイル
API一覧
ver.1.0でのみ使用できるAPI
© Newphoria Corporation Inc. All rights reserved.
従来のGPSに加えて、Wi-FiやBeaconなどの電波を用いたジオフェンシングも統一的に提供する機能です。使用するには別途サービスへのお申し込みが必要です。
※ジャンル・・・複数のジオポイントで構成されるグルーピングです。このジャンル指定単位でジオポイント群の取得が実行できます。※メッシュ・・・現在位置に応じたジオポイントを取得します。
applican.geopla.init(Object callbacks, Function successCallback, Function errorCallback)
モジュールを初期化します。
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);
applican.geopla.showTermsOfService(Function<boolean> successCallback, Function errorCallback)
注意事項ダイアログを表示する。
function showTermsOfServiceSuccessCallback(agree) { dumpApi("* showTermsOfService: Success(" + (agree ? "Allow" : "Deny") + ")"); } function showTermsOfServiceErrorCallback(error) { dumpApi("* showTermsOfService: ERROR(" + error + ")"); } applican.geopla.showTermsOfService(showTermsOfServiceSuccessCallback, showTermsOfServiceErrorCallback);
applican.geopla.getTermOfServiceVersion(Function<string> successCallback, Function errorCallback)
利用規約のバージョンを取得します。
function getTermsOfServiceVersionSuccessCallback(version) { dumpApi("* getTermOfServiceVersion: Success(" + version + ")"); } function getTermsOfServiceVersionErrorCallback(error) { dumpApi("* getTermOfServiceVersion: ERROR(" + error + ")"); } applican.geopla.getTermOfServiceVersion(getTermsOfServiceVersionSuccessCallback, getTermsOfServiceVersionErrorCallback);
applican.geopla.sendLog(Function successCallback, Function errorCallback)
現在端末内に保存されているログをすべて送信します。
function sendLogSuccess() { dumpApi("* sendLog: Success()"); } function sendLogError(error) { dumpApi("* sendLog: ERROR(" + error + ")"); } applican.geopla.sendLog(sendLogSuccess, sendLogError);
applican.geopla.getClientId(Function<string> successCallback)
GeoplaSDKが発行するクライアント識別子を取得します。
function clientIdSuccessCallback(clientId) { dumpApi("* getClientId: Success(" + clientId + ")"); } applican.geopla.getClientId(clientIdSuccessCallback);
applican.geopla.getVersion(Function<string> successCallback)
GeoplaSDKのバージョン番号を返します。
function versionSuccessCallback(version) { dumpApi("* getVersion: Success(" + version + ")"); } applican.geopla.getVersion(versionSuccessCallback);
applican.geopla.getGenres(Function<Genre[]> successCallback, Function errorCallback)
登録されたジャンルの一覧を取得します。
function genresSuccessCallback(genres) { dumpApi("* getGenres: Success(" + genres + ")"); } function genresErrorCallback(error) { dumpApi("* getGenres: ERROR(" + error + ")"); } applican.geopla.getGenres(genresSuccessCallback, genresErrorCallback);
applican.geopla.getSSID(Function<string[]> successCallback, Function errorCallback)
サーバに登録されたSSIDの一覧を取得します。
function ssidSuccessCallback(ssid) { dumpApi("* getSSID: Success(" + ssid + ")"); } function ssidErrorCallback(error) { dumpApi("* getSSID: ERROR(" + error + ")"); } applican.geopla.getSSID(ssidSuccessCallback, ssidErrorCallback);
applican.geopla.getSSID(Object parameters, Function successCallback, Function errorCallback)
静的ログに任意の文字列データを追加します。 引数は2個までの設定可能であり、パラメータ名は、parameterAとparameterBで固定です。文字列は50文字までとなっており、50文字を超えるものは自動的に50文字に省略されます。
function setParametersSuccessCallback() { dumpApi("* setExternalParameters: Success"); } function setParametersErrorCallback(error) { dumpApi("* changeLocationService: ERROR(" + error + ")"); } var parameters = {}; parameters.parameterA = "..."; parameters.parameterB = "...; applican.geopla.setExternalParameters(parameters, setParametersSuccessCallback, setParametersErrorCallback);
applican.geopla.clearCache(Function successCallback, Function errorCallback)
キャッシュを削除します。
function clearCacheSuccessCallback() { dumpApi("* clearCache: Success()"); } function clearCacheErrorCallback(error) { dumpApi("* clearCache: ERROR(" + error + ")"); } applican.geopla.clearCache(clearCacheSuccessCallback, clearCacheErrorCallback);
applican.geopla.startGpsMeshGeofencing(Object parameters, Function successCallback, Function errorCallback)
メッシュベースのGPSによるジオフェンシングサービスを開始します。
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);
applican.geopla.stopGpsMesGeofencing(Function successCallback, Function errorCallback)
実行中のstartGpsMeshGeofencing処理をを停止します。
function successCallback() { dumpApi("* stopGpsMeshGeofencing: Success()"); } function errorCallback(error) { dumpApi("* stopGpsMeshGeofencing: ERROR(" + error + ")"); } applican.geopla.stopGpsMeshGeofencing(successCallback, errorCallback);
applican.geopla.startGpsGenreGeofencing(Object parameters, Function successCallback, Function errorCallback)
ジャンルベースのGPSによるジオフェンシングサービスを開始します。
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);
applican.geopla.stopGpsGenreGeofencing(Function successCallback, Function errorCallback)
実行中のstartGpsGenreGeofencing処理を停止します。
function successCallback() { dumpApi("* stopGpsGenreGeofencing: Success()"); } function errorCallback(error) { dumpApi("* stopGpsGenreGeofencing: ERROR(" + error + ")"); } applican.geopla.stopGpsGenreGeofencing(successCallback, errorCallback);
applican.geopla.startWifiGenreGeofencing(Object parameters, Function successCallback, Function errorCallback)
ジャンルベースのWiFiによるジオフェンシングサービスを開始します。
parameters = {}; parameters.interval = WifiGeofencingSettings.GFPWifiGeofencingScanIntervalHigh; function successCallback() { dumpApi("* startWifiGenreGeofencing: Success"); } function errorCallback(error) { dumpApi("* startWifiGenreGeofencing: ERROR"); } applican.geopla.startWifiGenreGeofencing(parameters, successCallback, errorCallback);
applican.geopla.stopWifiGenreGeofencing(Function successCallback, Function errorCallback)
実行中のstartWifiGenreGeofencing処理を停止します。
function successCallback() { dumpApi("* stopWifiGenreGeofencing: Success()"); } function errorCallback(error) { dumpApi("* stopWifiGenreGeofencing: ERROR(" + error + ")"); } applican.geopla.stopWifiGenreGeofencing(successCallback, errorCallback);
applican.geopla.startWifiNearbyGeofencing(Object parameters, Function successCallback, Function errorCallback)
Wi-Fiを検知したタイミングでサーバからジオポイントを取得し、それを元にチェックイン/アウト判定を行うジオフェンシング処理を開始します。
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);
applican.geopla.stopWifiNearbyGeofencing(Function successCallback, Function errorCallback)
実行中のstartWifiNearbyGeofencing処理を停止します。
function successCallback() { dumpApi("* stopWifiNearbyGeofencing: Success()"); } function errorCallback(error) { dumpApi("* stopWifiNearbyGeofencing: ERROR(" + error + ")"); } applican.geopla.stopWifiNearbyGeofencing(successCallback, errorCallback);
applican.geopla.startBeaconGenreGeogfencing(Object parameters, Function successCallback, Function errorCallback)
ジャンルベースのビーコンによるジオフェンシングサービスを開始します。(Android専用)
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);
applican.geopla.stopBeaconGenreGeogfencing(Function successCallback, Function errorCallback)
実行中のstartBeaconGenreGeogfencing処理を停止します。(Android専用)
function successCallback() { dumpApi("* stopBeaconGenreGeogfencing: Success()"); } function errorCallback(error) { dumpApi("* stopBeaconGenreGeogfencing: ERROR(" + error + ")"); } applican.geopla.stopBeaconGenreGeogfencing(successCallback, errorCallback);
applican.geopla.startIBeaconGenreGeogfencing(Object parameters, Function successCallback, Function errorCallback)
ジャンルベースのビーコンによるジオフェンシングサービスを開始します。(iOS専用)
parameters = {}; function successCallback() { dumpApi("* startIBeaconGenreGeogfencing: Success"); } function errorCallback(error) { dumpApi("* startIBeaconGenreGeogfencing: ERROR"); } applican.geopla.startIBeaconGenreGeogfencing(parameters, successCallback, errorCallback);
applican.geopla.stopIBeaconGenreGeogfencing(Function successCallback, Function errorCallback)
実行中のstartBeaconGenreGeogfencing処理を停止します。(iOS専用)
function successCallback() { dumpApi("* stopIBeaconGenreGeogfencing: Success()"); } function errorCallback(error) { dumpApi("* stopIBeaconGenreGeogfencing: ERROR(" + error + ")"); } applican.geopla.stopIBeaconGenreGeogfencing(successCallback, errorCallback);
{ "id": long "name": string "timestamp": string }
ジャンルのパラメータ
{ "GPSEvent": { "timestamp": string "id": long "name": string "latitude": double "longitude": double "tags": string[] "isTracked": boolean "radius": int } }
GPSポイントのパラメータ
{ "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ポイントのパラメータ
{ "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ポイントのパラメータ
{ "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 } }
ユビキタスポイントのパラメータ
{ "IBeaconEvent": { "type": string, "timestamp": string "rssis": int[] "txPower": int "id": long "name": string "latitude": double "longitude": double "tags": string[] "isTracked": boolean "trackRId": string } }
TrackRポイントのパラメータ
GPSによるジオフェンシングのスキャン間隔のミリ秒
Wi-Fiによるジオフェンシングのスキャン間隔のミリ秒
ビーコンによるジオフェンシングのスキャン間隔のミリ秒
ビーコンによるジオフェンシングのモニタリング対象