SDKを導入する (Android)

前提条件

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

  • Visual Studio for Mac 8.7.4 以上
  • Android SDK

導入手順

STEP1: パッケージをインストールする

  1. Karte.Android.Core パッケージのインストール
    Visual Studio のサイドバーから Packages を右クリックし Manage NuGet Packages... をクリックします。検索バーに Karte を入力して Karte.Android.Core パッケージをインストールしてください。また、インストール時にSDKの依存パッケージ(Xamarin.Kotlin.StdLib等)のライセンス確認アラートが表示されますので Accept をクリックしてインストールしてください。

🚧

利用可能なパッケージについて

Karte.Android.Core はイベントトラッキング機能のみを提供します。
アプリ内メッセージ・プッシュ通知受信などのその他機能については、別途パッケージを導入する必要があります。
利用可能なパッケージについては、利用可能なパッケージ一覧 をご覧ください。

  1. 依存パッケージのインストール
    Nugetの依存解決だけではKotlinのStdLibが参照に追加されないため、同様の手順でXamarin.Kotlin.StdLib および Xamarin.Kotlin.StdLib.Jdk7 パッケージをインストールしてください。

🚧

依存パッケージのインストールについて

Kotlinに関する依存パッケージを追加でインストールしないと、実行時にクラッシュする恐れがあります。

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

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

  1. Coreパッケージのusingディレクティブを追加
    Android.App.Application を実装したクラスがあるファイルの先頭に using ディレクティブを追加します。
using IO.Karte.Android;
  1. SDKの初期化コードを追加
    OnCreate() メソッド内に初期化コードを追加します。
public override void OnCreate()
{
    base.OnCreate();
    KarteApp.Setup(this, "アプリケーションキー");
}

🚧

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

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

STEP3: URLスキームハンドラを追加する

KARTEで独自に定義したURLスキームを処理するために、任意のActivityに IntentFilter を追加します。

[Activity(Label = "MainActivity", MainLauncher = true)]
[IntentFilter(new string[] {Intent.ActionView}, DataScheme = "krt-${APIキー}")]
public partial class MainActivity : AppCompatActivity
{
}

生成されるAndroidManifest.xmlやAPIキーについては カスタムURLスキームを設定する をご覧ください。

利用可能なパッケージ一覧

KARTE Xamarin SDKでは機能毎にパッケージを提供しております。
利用する機能に応じて、部分的にパッケージを導入することが可能です。

Karte.Android.Core パッケージの導入は必須です。

パッケージ名説明
Karte.Android.Coreイベントトラッキング機能を提供します。
Karte.Android.InAppMessagingアプリ内メッセージ機能を提供します。(導入手順)
Karte.Android.Notificationsプッシュ通知の受信および効果測定機能を提供します。(導入手順)
Karte.Android.Variables設定値配信機能を提供します。(導入手順)