Tracking WebView

🚧

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

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

There are currently two ways to track user behavior within WebView.

• Place a measurement tag in the web page and track it (recommended)
• Tracking using native app SDK

It is recommended to mount it here because “Measuring tag is placed in the web page and tracking” requires less time for mounting and much information volume that can be acquired.

Webページ内に計測タグを設置してトラッキングを行う（WebView連携）

If you place measurement tags in a web page and perform tracking, follow the steps below for implementation.

1. Install measurement tags in the web page
2. Implement linking process of Web and App users
3. Operation verification

1. ページ内に計測タグを設置する

About setting method of measurement tag Here Please refer to.

If you already subscribed to KARTE and a measurement tag has been installed on the Web page, please skip this step.

2. WebとAppのユーザーの紐付け処理を実装する

If you just set up a measurement tag, the information tracked by the native app SDK and the information tracked by the measurement tag will be treated as different user actions.
Therefore, it is necessary to implement user tying processing in order to integrate user behavior in WebView before and after tying and behavior in native app.

What can be done by tying process

• User behavior in WebView before and after linking is linked with activity in native app (Actions in WebView after binding and in native app are treated as the same session)
• 計測タグが発行する全イベントの _source フィールドに native_app_webview が付く
• 計測タグが発行する全イベントのmetadataフィールド内に app_info フィールドが付与される

🚧

Things to keep in mind when using multi-domain options

Web and app user linking is not covered by cross-domain user integration with multidomain options

Implementation method of tying process
Currently, there are two connection methods available, and please use one of the methods.

• スクリプトを利用した紐付け（Android 4.4 以降で利用可能）
• Linking using query parameters

Linking using script

URLに余計なクエリパラメータを付与したくない場合は、JavaScriptを利用して紐付けを行うことが可能です。
SDKが用意しているヘルパーメソッドに WebView インスタンスを渡すことで、スクリプトの設定が行われます。

onPageStarted が呼び出されたタイミングでスクリプトを設定することで、紐付けが行われた状態でトラッキングが行われます。

override fun onCreate(savedInstanceState: Bundle?) {
  ...
  webView.webViewClient = object : WebViewClient() {
    override fun onPageStarted(view: WebView?, url: String?, favicon: Bitmap?) {
      super.onPageStarted(view, url, favicon)
      if (view == null) return
      TrackerJsUtil.setUserSyncScript(view.context, view)
    }
  }
  ...
}

@Override
public void onCreate(Bundle savedInstanceState) {
  ...
  webView.setWebViewClient(new WebViewClient() {
    @Override
    public void onPageStarted(WebView view, String url, Bitmap favicon) {
      super.onPageStarted(view, url, favicon);
      TrackerJsUtil.setUserSyncScript(view.getContext(), view);
    }
  });
  ...
}

Linking using query parameters

By passing the URL of the page to be loaded into the helper method provided by the SDK, you can add the query parameters necessary for the stringing process.

By loading the URL with the query parameters for stringing in the WebView, tracking is performed with the stringing done.

url = TrackerJsUtil.appendUserSyncQueryParameter(this, "YOUR_APP_KEY", url)
webView.loadUrl(url)

url = TrackerJsUtil.appendUserSyncQueryParameter(this, "YOUR_APP_KEY", url);
webView.loadUrl(url);

🚧

About query parameter expiration

The query parameter has an expiration date of 1 minute, and if the expiration date has expired, it will not be linked.
Therefore, when loading the page, be sure to add query parameters to the URL each time.

3. 動作検証

On the user details screen of the KARTE administration screen, check if the action on the web page is treated as an action on the native app.

計測タグ経由でトラッキングされた閲覧イベントに APP アイコンが付いていれば、ネイティブアプリ上での行動として扱われております。

ネイティブアプリSDKを利用してトラッキングを行う

When tracking using the native app SDK, tracking is basically triggered by page transitions in WebView.

val url = "https://plaid.co.jp"
webView.loadUrl("$url?_karte_tracker_deactivate=true")
webView.webViewClient = object : WebViewClient() {
  override fun onPageFinished(view: WebView?, url: String?) {
    view?.let {
      try {
        Tracker.getInstance(it.context).view("webview", it.title, JSONObject().put("url", url))
      } catch (e: JSONException) {
        e.printStackTrace()
      }
    }
  }
}

String URL = "https://plaid.co.jp";
webView.loadUrl(URL + "?_karte_tracker_deactivate=true");
webView.setWebViewClient(new WebViewClient() {
  @Override
  public void onPageFinished(WebView view, String url) {
    try {
      Tracker.getInstance(view.getContext(), APP_KEY)
        .view("webview", view.getTitle(), new JSONObject().put("url", url));
    } catch (JSONException e) {
      e.printStackTrace();
    }
  }
});

If measurement tags are installed in the web page, tracking will be performed as separate user actions on the web and the app.
To prevent this, it is necessary to add an implementation that disables measurement tags in the web page.

WebView で開くページの URL にクエリパラメータとして _karte_tracker_deactivate=true を付加してください。