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

ペアリングしたデバイスから管理画面に対して送信した操作ログを利用して、イベントの発火条件を定義できます。

定義したイベント発火条件は各デバイスに反映されるため、アプリケーションをリリースすることなく、イベントの発火をコントロールすることが可能になります。

導入手順

  1. Karte Gradle Plugin の適用
    ビジュアルトラッキングを有効化するには、Gradle Plugin の設定が必要です。
    ルートプロジェクトの build.gradlebuildscript ブロックに以下の記述を追加してください。
    Karte Gradle Plugin は 最新バージョンの使用を推奨します。
buildscript {
  // ...
  repositories {
    // ...
    mavenCentral()
    // ...
  }
  dependencies {
    classpath "io.karte.android:gradle-plugin:2.4.0"
    //...
  }
}

次にアプリの 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の動作確認済みバージョン

このプラグインは Android Gradle Plugin(com.android.tools.build:gradle)のバージョン 3.1.0 ~ 7.0.0 においてビルドおよび動作の確認をしています。

🚧

Instant Run 対応

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

  1. visualtracking モジュールの追加
    アプリの build.gradle (app) を任意のエディタで開き、dependencies ブロックに visualtracking モジュールを追加します。
dependencies {
  implementation 'io.karte.android:visualtracking:2.+'
}

実装手順

カスタム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>

動作確認

2点の動作が確認できれば問題なく動作していることが確認できます。

  1. ペアリングの確認
  2. 定義に基づいたイベントの送信が行われているか確認

ペアリングをはじめとした各種操作方法については、サポートサイトの ビジュアルトラッキング をご覧ください。

📘

ペアリングの動作について

ペアリング開始後、SDKはペアリングを維持するために一定間隔で通信を行います。
なおアプリケーションのプロセスが終了した場合は、ペアリングは解除されます。