SDKを導入する
前提条件
本SDKは、Flutter 2.0.0 以上、Dart 2.12.0 以上で動作することを確認しております。
なお各プラットフォーム毎に導入条件が定められております。
導入手順（共通）
パッケージをインストールする
アプリケーションの pubspec.yaml の dependencies にパッケージを記入し、 pub get コマンドでインストールしてください。
dependencies:
karte_core: ^0.2.0
flutter pub get
パッケージのインストールが完了したら、対応するプラットフォーム毎の導入手順に従い設定を進めてください。
利用可能なパッケージについて
karte_core パッケージはイベントトラッキング機能のみを提供します。
アプリ内メッセージ・プッシュ通知受信などのその他機能については、別途パッケージを導入する必要があります。
利用可能なパッケージについては、利用可能なパッケージ一覧 をご覧ください。
導入手順（iOS）
STEP1: SDKの初期化コードを追加する
アプリケーションにSDKの初期化コードを追加します。
- SDKのインポート宣言を追加
UIApplicationDelegateを実装したクラスがあるファイルの先頭にインポート宣言を追加します。
@import KarteCore;
import KarteCore
- SDKの初期化コードを追加
application(_:didFinishLaunchingWithOptions:)メソッド内に初期化コードを追加します。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[KRTApp setupWithAppKey:@"アプリケーションキー" configuration:KRTConfiguration.defaultConfiguration];
...
}
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
KarteApp.setup(appKey: "アプリケーションキー")
...
}
アプリケーションキーについて
初期化時に指定するアプリケーションキーは、KARTE管理画面に記載されているAPIキーとは異なります。
アプリケーションキーは営業担当よりお送りするメールに記載されておりますので、そちらをご確認ください。
STEP2: URLスキームハンドラを追加する
KARTEで独自に定義したURLスキームを処理するために、application(_:open:options:) メソッド内にハンドラを追加します。
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
return [KRTApp application:app openURL:url];
}
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
return KarteApp.application(app, open: url)
}
なお iOS13 から利用可能な UISceneDelegate を実装している場合は、scene(_:willConnectTo:options:) および scene(_:openURLContexts:) メソッド内にハンドラを追加します。
- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {
UIOpenURLContext *URLContext = connectionOptions.URLContexts.anyObject;
if (URLContext) {
[KRTApp application:[UIApplication sharedApplication] openURL:URLContext.URL];
}
}
- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
UIOpenURLContext *URLContext = URLContexts.anyObject;
if (URLContext) {
[KRTApp application:[UIApplication sharedApplication] openURL:URLContext.URL];
}
}
func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
if let context = connectionOptions.urlContexts.first {
KarteApp.application(app, open: context.url)
}
}
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
if let context = URLContexts.first {
KarteApp.application(app, open: context.url)
}
}
Objective-C から SDK を利用する
Objective-C から SDK を利用した場合、ビルド時にエラーが発生する場合があります。
エラーが発生した場合は、こちら の記事を参考にしてください。
導入手順（Android）
STEP1: SDKの初期化コードを追加する
- SDKのインポート宣言を追加
android.app.Applicationクラスを継承したクラスがあるファイルの先頭にインポート宣言を追加します。
import io.karte.android.KarteApp;
import io.karte.android.KarteApp
- SDKの初期化コードを追加
onCreateメソッド内に初期化コードを追加します。
public class YourApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
KarteApp.setup(this, "アプリケーションキー");
}
}
class YourApplication : Application() {
override fun onCreate() {
super.onCreate()
KarteApp.setup(this, "アプリケーションキー")
}
}
STEP2: 暗黙的インテントを解決するための設定を追加する（オプション）
一部の機能 *1 を利用するためには、暗黙的インテントを解決するための設定を AndroidManifest.xml に追加する必要があります。
*1. 管理画面に表示したQRコードを読み込みによるSDK機能の呼び出し
<activity android:name=".XxxActivity">
<!-- 任意のActivityに対して、以下の指定を行なってください -->
<intent-filter >
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="<アプリ毎に定義したスキーム名を指定>" android:host="karte.io" />
</intent-filter>
</activity>
利用可能なパッケージ一覧
KARTE Flutter SDKでは機能毎にパッケージを提供しております。
利用する機能に応じて、部分的にパッケージを導入することが可能です。
なお karte_core パッケージの導入は必須です。
Updated about 2 months ago