ビジュアルトラッキングを利用する

🚧

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

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

KARTE の管理画面上に送信した操作ログから、イベント発火条件を作成できます。
これによりアプリをリリースすることなく、イベント発火をコントロール可能です。

ビジュアルトラッキングの設定

デバイスとペアリングを行い、計測したい操作を行ってください。
イベント発火条件に利用したい操作ログを選択して、イベント定義を保存します。

アプリ側の実装

Gradle Pluginの適用

ビジュアルトラッキングを有効化するには、SDKのセットアップに加えてKARTEのGradle Pluginを利用する必要があります。
ルートプロジェクトのbuild.gradlebuildscriptブロックに以下の記述を追加してください。Gradle Pluginと本体のSDKは同じバージョンを使用してください。

buildscript {
  ext.karteVersion = '1.7.0'
  // ...
  repositories {
    maven { url 'http://plaidev.github.io/karte-tracker-android/maven-repo' } 
    // ...
  }
  dependencies {
    classpath "io.karte.android:karte-gradle-plugin:$karteVersion"
    //...
  }
}

次にアプリのbuild.gradleを修正し、apply plugin: 'com.android.application'の下にapply plugin: 'io.karte.android'を追記してください。

apply plugin: 'com.android.application'
apply plugin: 'io.karte.android'

このプラグインはAndroid Gradle Plugin(com.android.tools.build:gradle)のバージョン3.1.0以上4.0.0以下に対応してます。

🚧

Instant Run対応

Instant Runには対応していません。開発時にビジュアルトラッキングを有効にする際はInstant Runを無効化してください。

カスタムURLスキームの設定

ペアリングのために、カスタムURLスキームの指定が必要です。
既にカスタムURLスキームがある(intent-filter要素にアプリ固有のスキームが指定されたActivityがAndroidManifest.xmlに存在する)場合、以下の手順は不要です。

カスタムURLスキームの設定が無い場合、ペアリング用のURLスキームに任意の文字列を指定可能です。
name属性に"io.karte.android.Tracker.PairingUrlScheme"を指定したmeta-data要素を追加し、値にURLスキームを設定してください。

<application android:label="SampleApp" ...>
    <meta-data android:name="io.karte.android.Tracker.PairingUrlScheme" android:value="sampleapp"/>
    ...
</application>

ペアリングを維持するため、一定間隔でポーリングが行われます。アプリのプロセスが終了した場合はペアリングも終了します。