Guides

SDKを導入する

Suggest Edits

前提条件

SDKを導入するためには、以下が必要となります

  • Cordova 9 以上
  • Cordova Android 8 以上
  • Cordova iOS 5 以上

なお各プラットフォーム毎に導入条件が定められております。

導入手順

STEP1: SDKをアプリに追加する

cordova plugin add cordova-plugin-karte

STEP2: SDKの初期化コードを追加する

次にアプリケーションにSDKの初期化コードを追加します。

Androidの場合

  1. SDKの初期化に必要な値（アプリケーションキーなど）が定義された設定ファイルをプロジェクトに追加します。
    1. 管理画面から設定ファイルをダウンロードする
      設定ファイルのダウンロード方法についてはサポートサイトをご覧ください。
    2. 設定ファイルをプロジェクトに配置する
      設定ファイルをプロジェクトのリソースに追加します。
      該当するビルドバリアントの res/values ディレクトリに配置してください。
  2. アプリケーションクラスを追加
    android.app.Application を継承したアプリケーションクラスをplatforms/android 配下のAndroidプロジェクト内に配置します。

🚧

multidex を有効にする場合

minSdkVersion が21未満プロジェクトの場合は、android.support.multidex.MultiDexApplication を継承したアプリケーションクラスをプロジェクトに追加してください。

  1. アプリケーションクラスにインポート宣言を追加
    ファイルの先頭にインポート宣言を追加します。
import io.karte.android.KarteApp;
  1. アプリケーションクラスにSDKの初期化コードを追加
    onCreate メソッド内に初期化コードを追加します。
public class YourApplication extends Application {
  
  @Override
  public void onCreate() {
    super.onCreate();
    KarteApp.setup(this);
  }
}

🚧

KarteApp.setupの設置場所

Activity内のonCreateに設置してしまうと正しく動作しないため、ステップ1で追加したアプリケーションクラス内のonCreateに設置をしてください。

  1. AndroidManifest.xml を修正
    AndroidManifest.xml を開き、<application> タグに android:name 属性を追加します。
    属性値には手順1で追加したアプリケーションクラスの名前を指定します。

クラス名が YourApplication の場合は、属性値は .YourApplication となります。

iOSの場合

  1. platforms/ios以下をXCodeで開きます。
  2. SDKの初期化に必要な値（アプリケーションキーなど）が定義された設定ファイルをプロジェクトに追加します。
  3. AppDelegate.m を開く
    platforms/ios/<プロジェクト名>/Classes/AppDelegate.m を任意のエディタで開きます。
  1. SDKのインポート宣言を追加
    ファイルの先頭にインポート宣言を追加します。
@import KarteCore;
  1. SDKの初期化コードを追加
    application(_:didFinishLaunchingWithOptions:) メソッド内に初期化コードを追加します。

🚧

設定ファイルによるSDKの初期化について

※設定ファイルによるSDK初期化は iOS SDK v2.12.0 以上から利用できます。
古いSDKを利用している場合は KarteApp.setup(appkey:)メソッドを利用して初期化してください。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [KRTApp setupWithConfiguration:KRTConfiguration.default_];
  ...
}

🚧

アプリケーションキーについて

初期化時に指定するアプリケーションキー（Application Key）は、KARTE管理画面に記載されているAPIキーとは異なります。取得方法はアプリケーションキーの確認方法をご確認ください。

Updated 9 days ago