SDKの初期化

🚧

このドキュメントは叀いバヌゞョンの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 の初期化時に指定可胜なオプションの䞀芧です。
なお通垞はデフォルトの蚭定で問題ありたせん。

オプション

デフォルト倀

内容

setEnabledTrackingAaid

false

広告 ID (AAID) を送信するかどうかを指定するためのオプション。

true で送信されたす。

setEnableTrackingCrashError

true

アプリケヌションのクラッシュむベント(native_app_crashed) を送信するかどうかを指定するためのオプション。

true で送信されたす。

setEnableFCMTokenResend

true

SDK 初期化時に FCM トヌクンを自動送信するかどうかを指定するためのオプション。

true で送信されたす。

setAutoControlSoftInputAdjust

true

true の堎合、接客衚瀺䞭に自動で SoftInputMode に SOFT_INPUT_ADJUST_RESIZE が指定されたす。
この制埡が䞍芁な堎合は false を指定しおください。

※ テキスト入力時にキヌボヌドが接客に被らないようにするために蚭定されおいたす。

setEnableTrackerOptOut

false

SDK 初期化時にオプトアりトするかどうかを指定するためのオプション。

true でオプトアりトされたす。

setEnableWebViewCache

1.8.0未満はfalse、1.8.0以䞊はtrue

接客衚瀺に䜿甚するWebViewをキャッシュするかを指定するためのオプション。

setDryRun

false

むベントの蚈枬を行うかどうかを指定するためのオプション。

true で蚈枬が行われたせん。