SDKを導入する
前提条件
SDKを導入するためには、以下が必要となります
- Cordova 9 以上
- Cordova Android 8 以上
- Cordova iOS 5 以上
なお各プラットフォーム毎に導入条件が定められております。
導入手順
STEP1: SDKをアプリに追加する
cordova plugin add cordova-plugin-karte
STEP2: SDKの初期化コードを追加する
次にアプリケーションにSDKの初期化コードを追加します。
Androidの場合
- アプリケーションクラスを追加
android.app.Application
を継承したアプリケーションクラスをplatforms/android
配下のAndroidプロジェクト内に配置します。
multidex を有効にする場合
minSdkVersion が21未満プロジェクトの場合は、
android.support.multidex.MultiDexApplication
を継承したアプリケーションクラスをプロジェクトに追加してください。
- アプリケーションクラスにインポート宣言を追加
ファイルの先頭にインポート宣言を追加します。
import io.karte.android.KarteApp;
- アプリケーションクラスにSDKの初期化コードを追加
onCreate
メソッド内に初期化コードを追加します。
public class YourApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
KarteApp.setup(this, "アプリケーションキー");
}
}
KarteApp.setupの設置場所
Activity
内のonCreate
に設置してしまうと正しく動作しないため、ステップ1で追加したアプリケーションクラス内のonCreate
に設置をしてください。
- AndroidManifest.xml を修正
AndroidManifest.xml を開き、<application>
タグにandroid:name
属性を追加します。
属性値には手順1で追加したアプリケーションクラスの名前を指定します。
クラス名が YourApplication
の場合は、属性値は .YourApplication
となります。
iOSの場合
-
AppDelegate.m を開く
platforms/ios/<プロジェクト名>/Classes/AppDelegate.m
を任意のエディタで開きます。 -
SDKのインポート宣言を追加
ファイルの先頭にインポート宣言を追加します。
@import KarteCore;
- SDKの初期化コードを追加
application(_:didFinishLaunchingWithOptions:)
メソッド内に初期化コードを追加します。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[KRTApp setupWithAppKey:@"アプリケーションキー" configuration:KRTConfiguration.defaultConfiguration];
...
}
アプリケーションキーについて
初期化時に指定するアプリケーションキー(Application Key)は、KARTE管理画面に記載されているAPIキーとは異なります。取得方法はアプリケーションキーの確認方法をご確認ください。
Updated about 2 months ago