Quick Tracking:App H5 Data Reporting

1 H5 bridging scenario

How do 1.1 report H5 data to H5 applications and App applications at the same time?

Scenario example:

A "Spring Day" activity H5 is embedded in multiple App terminals and operated in the current mode to meet the following analysis requirements:

• App operation needs to see the complete link data before and after the customer participates in H5 activities in App.

• H5 activity operation needs to see the activity data of H5 in all App terminals.

Operation instructions:

1. Create two applications:

• An App application that has its own Appkey_app

• A Web/H5 application that has its own Appkey_h5

2. Call the attach interface in the app to perform H5 bridging

Reporting logs:

1. App reports a log:

   1. Appkey is the App's "Appkey_app"

   2. The user account is the user account for the app

   3. Device ID is the device ID of the app

   4. System properties are the app's system properties

   5. Global properties are global properties of the tracking in the app

   6. The event code and the event property are the tracking in H5

2. H5 reports a log:

   1. Appkey is "Appkey_h5" of H5

   2. A user account whose user account is H5

   3. The ID of the device whose device ID is H5

   4. System properties of H5

   5. The global property is the global property of the tracking in H5

   6. The event code and the event property are the tracking in H5

How do 1.2 report H5 data only to the unique App application?

Scenario example:

Due to the technical architecture, some pages are H5 technical structures. Operating in the current mode can meet the following analysis requirements:

• App business, operation, and PD can see complete full-link data in App Data.

Operation description:

1. Create an app with only one Appkey_app

2. Call the attach interface in the app to perform H5 bridging

3. H5 Appkey is set to null and the call aplus-jsbridge-only is equal to true to disable H5 data reporting

Report logs.

1. Only the app reports a log:

   1. Appkey is the App's "Appkey_app"

   2. The user account is the user account for the app

   3. Device ID is the device ID of the app

   4. System properties are the app's system properties

   5. Global properties are global properties of the tracking in the app

   6. The event code and the event property are the tracking in H5

1.3 if H5 data is only reported to H5 applications?

Scenario example:

1. App business, operation and PD do not want to see H5 data in App

Operation description:

1. Create two applications:

• An App application that has its own Appkey_app

• A Web/H5 application that has its own Appkey_h5

2. Do not make any API calls

Report logs.

1. Only H5 reports one log:

   1. Appkey is "Appkey_h5" of H5

   2. A user account whose user account is H5

   3. The ID of the device whose device ID is H5

   4. System properties of H5

   5. The global property is the global property of the tracking in H5

   6. The event code and the event property are the tracking in H5

2 H5 Bridging Principle

The above method is based on the following prerequisites:

1. App integration QuickTrackingApp SDK

2. And in-app H5 integration QuickTracking H5 SDK

The following figure shows that when a user triggers button2 on the h5 page in the app, two logs are reported at the same time:

1. Reporting through App SDK: In the reported logs, the appkey is the appkey of the app, the global property is the global property of the app, and the event code and event property are the code and property of the tracking in h5. (Green arrow in the figure)

2. Reporting through H5 SDK: In the reported logs, the appkey is the appkey of h5, the global property is the global property of h5, and the event code and event property are the code and property of the buried point in h5. (Yellow arrow in the figure)

3 App Bridge H5 Open Interface

By default, this parameter is disabled. You can enable this parameter only when you call the following API operations of the app SDK.

// This interface needs to be called in the onCreate function of the WebView control host Activity to mark the beginning and end of the h5 page
SpmAgent.attach(WebView);
SpmAgent.detach();

The H5 bridging feature of the Privatized Statistics SDK is only supported for Android 4.2 (and later). Bridging is not supported on Android OS versions earlier than 4.2.

SpmAgent.attach(WebView);

This interface needs to be called in the onCreate function of the WebView control host activity

public class WebviewAnalytic extends Activity {
    private static final String TAG = "WebviewAnalytic";

    WebView mWebView;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_webview);
        QtTrackAgent.skipMe(this, TAG); // The WebView host activity does not need to count native page PV events.
        WebView webView = findViewById(R.id.webview);
        mWebView = webView;
        
        // Bind the WebView control to the SPM plug-in SDK. Access QuickTracking Web JS SDK in H5 pages in this WebView can be used with
        // Use the SPM plug-in SDK to send the tracking statistics of H5 pages through the Native Statistics SDK. 
        SpmAgent.attach(mWebView);
        
        webView.loadUrl("file:///android_asset/index.html");
    }

   // ......

SpmAgent.detach();

This interface needs to be called in the onDestroy function of the WebView control host activity

Examples:

@Override
protected void onDestroy() {
    super.onDestroy();
    SpmAgent.de tach(); // Unbind when the WebView host activity is destroyed
}

QtTrackAgent.skipMe(this, pageName);

When statistics are collected on the h5 layer in an activity, if you need to avoid repeated reporting of page PV events at the native layer and the h5 layer, you need to call this function in the onCreate function of the WebView control host activity.

After this function is called, the SDK does not count and report page PV events at the native layer on the current activity page. This prevents duplicate reporting of page PV events at the H5 layer.

@Override
protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
     setContentView(R.layout.activity_webview);
        
     // The WebView host activity does not need to count native page PV events.
     MobclickAgent.skipMe(this, "WebviewAnalytic"); 
        
     WebView webView = findViewById(R.id.webview);
     mWebView = webView;
     // Bind the WebView control to the SPM plug-in SDK. Access QuickTracking Web JS SDK in H5 pages in this WebView can be used with
     // Use the SPM plug-in SDK to send the tracking statistics of H5 pages through the Native Statistics SDK. 
     SpmAgent.attach(mWebView);
     webView.loadUrl("file:///android_asset/index.html");
}

4 App Bridge H5 Open Interface (Tencent X5 Webview Adaptation)

SpmAgent.attachX5(WebView);

This interface is only used by developers to use Tencent X5Webview three-party control scenarios. You must call the onCreate function of the Tencent X5WebView host activity.

import android.app.Activity;
import android.os.Bundle;

import com.tencent.smtt.sdk.WebSettings;
import com.tencent.smtt.sdk.WebSettings.LayoutAlgorithm;
import com.tencent.smtt.sdk.WebView;

import com.umeng.analytics.MobclickAgent;
import com.umeng.spm.SpmAgent;

public class X5WebviewAnalytics extends Activity {
    private static final String TAG = "X5WebviewAnalytics";

    com.tencent.smtt.sdk.WebView mWebView;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_x5webview);
        MobclickAgent.skipMe(this, TAG); // The WebView host activity does not need to count native page PV events.
        com.tencent.smtt.sdk.WebView webView = findViewById(R.id.webview);
        mWebView = webView;

        // For the following settings, refer to the official demo configuration of X5Webview Tencent. For specific settings, developers should configure them according to their own App requirements.
        WebSettings webSettings = mWebView.getSettings();
        webSettings.setJavaScriptEnabled(true);
        webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
        webSettings.setAllowFileAccess(true);
        webSettings.setLayoutAlgorithm(LayoutAlgorithm.NARROW_COLUMNS);
        webSettings.setAppCacheEnabled(true);
        webSettings.setDomStorageEnabled(true);
        webSettings.setAppCacheMaxSize(Long.MAX_VALUE);
        webSettings.setPluginState(WebSettings.PluginState.ON_DEMAND);
        webSettings.setCacheMode(WebSettings.LOAD_NO_CACHE);

        // Bind the WebView control to the SPM plug-in SDK. Access QuickTracking Web JS SDK in H5 pages in this WebView can be used with
        // Use the SPM plug-in SDK to send the tracking statistics of H5 pages through the Native Statistics SDK. 
        SpmAgent.attachX5(mWebView);
        
        webView.loadUrl("file:///android_asset/index.html");
    }
}

5 H5 SDK reporting log switch

If you want the logs reported by H5 in-app SDK to include custom app information, such as the name of the application where H5 is located and the channel name, you can pass the app information to H5 by using UA information transmission, and then use the global properties of H5 SDK for reporting.

By default, tracking events on the H5 page in the app must be reported through the H5 SDK. If you need to prevent the H5 SDK from reporting tracking events, you can call the following H5 SDK API in H5.

aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['aplus-jsbridge-only', true]
});

If H5 aplus-jsbridge-only set to true, H5 SDK is prohibited from reporting tracking events. Be sure to check H5 code that is not in App and do not set it!

6 H5 global property synchronization API

If you disable the following API operation in H5, the global properties that are configured by using the globalproperty parameter in aplus.appendMetaInfo or aplus.setMetaInfo in H5 do not take effect in the native app. (This interface defaults to true.)

Note that this interface is supported in qt_web_v2.0.12 and must be used with android 1.4.3.PX and above and iOS 1.4.0.PX and above.

aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['aplus-globalproperty-sync-enable', false] // Disable synchronization
});

For example, by default, if you set the global property "Current City: Beijing" in the app and set the global property "Current City: Shanghai" in the app H5, the global property of events triggered in H5 and app native will be "Current City: Shanghai". If you turn off this switch, the global properties set in H5 are not synchronized to the native app.

The following logic is used to apply the global properties of an H5 embedded app:

If the aplus-globalproperty-sync-enable is set to true or not set, the global property of H5 and the global property of app will be reported. The same key will be overwritten and different keys will be added. The global property set by H5 with aplus.setMetaInfo will also be the logic of appending the global property of app.

If aplus-globalproperty-sync-enable is set to false, H5 global properties will not be reported, and events will only carry app global properties.