SDKの初期化

Suggest Edits

🚧

このドキュメントは古いバージョンのAndroid SDK v1について記載しています

Android SDK v1は 2021/05/11でサポート終了となります。
SDK v1 からのアップグレードについては、まず SDK v1からv2のアップグレード方法 をご覧ください。

SDK を利用するためには、アプリ起動時に初期化を行う必要があります。

SDK を初期化する

オプションを指定せず初期化する

Application の onCreate() で Tracker.init(this, "YOUR_APP_KEY") を呼び出してください。

import android.app.Application
import io.karte.android.tracker.Tracker

class SampleApp : Application() {

  override fun onCreate() {
    super.onCreate()
    Tracker.init(this, "YOUR_APP_KEY")
  }
}

import android.app.Application;
import io.karte.android.tracker.Tracker;

public class SampleApp extends Application {
  
  @Override
  public void onCreate() {
    super.onCreate();
    Tracker.init(this, "YOUR_APP_KEY");
  }
}

🚧

Application Key について

初期化時に指定する Application Key は、KARTE管理画面に記載されている API_KEY とは異なります。
キーは営業担当よりお送りしているメールに記載されておりますので、こちらをご確認ください。

❗️

初期化について

初期化メソッドは必ず Application.onCreate() で呼び出してください。Activity.onCreate() で呼び出した場合は正常に動作しません。

オプションを指定して初期化する

初期化時にオプションを指定することで、一部 SDK の挙動を変更することが可能です。
なお利用可能なオプションについては、ページ下部の初期化オプション一覧をご覧ください。

import android.app.Application
import io.karte.android.tracker.Tracker
import io.karte.android.tracker.TrackerConfig

class SampleApp : Application() {

  override fun onCreate() {
    super.onCreate()
    val config = TrackerConfig.Builder()
       .setEnableTrackingAaid(false)
       .build()
    Tracker.init(this, "YOUR_APP_KEY", config)
  }
}

import android.app.Application;
import io.karte.android.tracker.Tracker;
import io.karte.android.tracker.TrackerConfig;

public class SampleApp extends Application {
  
  @Override
  public void onCreate() {
    super.onCreate();
    TrackerConfig config = new TrackerConfig.Builder()
        .setEnableTrackingAaid(false)
        .build();
    Tracker.init(this, "YOUR_APP_KEY", config);
  }
}

URLスキームをハンドルする

KARTE で独自に定義したURLスキームを処理するために、AndroidManifest.xml にURLスキームの指定が必要です。
これは管理画面に表示したQRコードを利用して、SDKの特定の機能を呼び出す際に必要となります。

なお <アプリ毎に定義したスキーム名>://karte.io/find_myself でアプリが起動できる場合は、以下の対応は不要です。

<activity
          android:name=".XxxActivity"
          android:theme="@style/Theme.AppCompat.NoActionBar">
  <intent-filter>
    <action android:name="android.intent.action.MAIN" />
    <category android:name="android.intent.category.LAUNCHER" />
    
    <!-- 任意のActivityに対して、以下の指定を行なってください -->
    <data android:scheme="<アプリ毎に定義したスキーム名を指定>" android:host="karte.io" /> 
  </intent-filter>
</activity>

初期化オプション一覧

SDK の初期化時に指定可能なオプションの一覧です。
なお通常はデフォルトの設定で問題ありません。

オプションデフォルト値内容
setEnabledTrackingAaidfalse広告 ID (AAID) を送信するかどうかを指定するためのオプション。

true で送信されます。
setEnableTrackingCrashErrortrueアプリケーションのクラッシュイベント(native_app_crashed) を送信するかどうかを指定するためのオプション。

true で送信されます。
setEnableFCMTokenResendtrueSDK 初期化時に FCM トークンを自動送信するかどうかを指定するためのオプション。

true で送信されます。
setAutoControlSoftInputAdjusttruetrue の場合、接客表示中に自動で SoftInputMode に SOFT_INPUT_ADJUST_RESIZE が指定されます。
この制御が不要な場合は false を指定してください。

※ テキスト入力時にキーボードが接客に被らないようにするために設定されています。
setEnableTrackerOptOutfalseSDK 初期化時にオプトアウトするかどうかを指定するためのオプション。

true でオプトアウトされます。
setEnableWebViewCache1.8.0未満はfalse、1.8.0以上はtrue接客表示に使用するWebViewをキャッシュするかを指定するためのオプション。
setDryRunfalseイベントの計測を行うかどうかを指定するためのオプション。

true で計測が行われません。

Updated 5 months ago

What’s Next