SDKのセットアップ(iOS)

前提条件

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

  • Xcode 11.0 以上
  • CocoaPods 1.10.1 以上

またプロジェクトは、以下の条件を満たす必要があります。

  • プロジェクトのビルドターゲットが iOS 10 以上

🚧

ビルドターゲットに iOS 9 を指定する際の注意点

現時点でiOS 9でのビルド及び計測は可能ですが、動作保証の対象外となります。
また、今後 iOS 9 に対して計画的な接客の配信停止・イベントの計測停止及びビルド対象からの除外が実施されます。

導入手順

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

SDK導入には、CocoaPods を利用します。

  1. Podfile の編集
    プロジェクトディレクトリにある Podfile を任意のエディタで開き、利用する Pod を指定します。
pod 'KarteCocos2dx'
  1. Pod のインストール
    プロジェクトディレクトリで下記コマンドを実行し、Pod をインストールします。
pod install
  1. プロジェクトに設定を追加する
    アプリの xcworkspace を開き、アプリターゲットの Other Linker Flags に $(inherited) を追加します。

  2. 空のSwiftファイルを追加する
    Swiftのファイルがまだプロジェクトに存在しない場合、空のSwiftファイルを追加して Swift の標準ライブラリをリンクするようにプロジェクトを構成します。この対応の詳細についてはリンク時の問題についてをご確認ください。

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

次にアプリケーションにSDKの初期化コードを追加します。初期化コードは C++ ではなく Objective-C でKARTE iOS SDK を直接呼び出す方式での実装が必要です。

  1. SDKのインポート宣言を追加
    UIApplicationDelegate を実装したクラスがあるファイルの先頭にインポート宣言を追加します。
#import <KarteCore/KarteCore-Swift.h>
  1. SDKの初期化コードを追加
    application(_:didFinishLaunchingWithOptions:) メソッド内に初期化コードを追加します。
[KRTApp setupWithAppKey:@"アプリケーションキー" configuration:KRTConfiguration.defaultConfiguration];

🚧

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

初期化時に指定するアプリケーションキーは、KARTE管理画面に記載されているAPIキーとは異なります。
アプリケーションキーは営業担当よりお送りするメールに記載されておりますので、そちらをご確認ください。


What’s Next