Quick Tracking:Android SDK

1. Integration code details

The A/B Testing SDK depends on Android SDK V1.6.4 or later. Before you use the Quick Tracking SDK, make sure that you have successfully integrated the Quick Tracking SDK and initialized the SDK. For more information, see Introduction and configuration of the SDK.

2. Programming experiment

2.1 integration and initialization

You must initialize the Quick Tracking SDK in synchronous mode. After you initialize the QuickTracking statistics SDK, initialize the QuickTracking A/B Testing SDK. When you initialize the Quick Tracking A/B Testing SDK, you must specify the URL of the request diversion test. Contact the operation personnel to obtain the URL.

2.1.1 Synchronous introduction method

Add the QT A/B Testing SDK dependency to the build.gradle module in the file:

Online package:

dependencies {
    implementation fileTree(include:['*.jar'], dir:'libs')

    // QuickTracking statistical analysis SDK 
    implementation 'com.lydaas.qtsdk:qt-px-common:1.8.6.PX'
    // QuickTracking A/B Test SDK
    implementation 'com.lydaas.qtsdk:qt-ab-test:1.1.0'
  
}

Local package:

dependencies {
    implementation fileTree(include:['*.jar'], dir:'libs')
    // QuickTracking statistical analysis SDK 
    implementation files('libs/qt-px-common-1.8.6.PX.aar')
    // QuickTracking A/B Test SDK
    implementation files('libs/QTABTest-release.aar')

}

2.1.2 SDK initialization

To initialize the dependency ApplicationContext, specify the following parameters when appropriate:

import com.quicktracking.sdk.android.abtest.QTABTest;
import com.quicktracking.sdk.android.abtest.QTABTestConfigOptions;

try {
    // Initialize the QT A/B testing SDK --- Completely rely on the collection SDK to report data.
   QTABTestConfigOptions config=new QTABTestConfigOptions("Your receiving service address /abtest_results?appkey=xxxxx");
   // Initialization of QT A/B Testing SDK --- Incomplete dependency collection SDK reporting data, only AB experiment is used
   QTABTestConfigOptions config=new QTABTestConfigOptions("Your receiving service address /abtest_results?appkey=xxxxx",10 * 60 * 1000,"Custom device ID", new IQTABTestPropertyChanged() {
        @Override
        public void onPropertyChanged(JSONArray abParams) {
            Log.d("ABTest", "onPropertyChanged: " + abParams.toString());
        }
    });
  
    // You must specify the Context parameter for initialization.
   QTABTest.startWithConfigOptions(this.getApplicationContext(), config);
} catch (Exception e) {
    e.printStackTrace();
}

Configuration method:

public QTABTestConfigOptions(String url,int timeInterval)
public QTABTestConfigOptions(String url)
public QTABTestConfigOptions(String url,int timeInterval, String customDeviceId, IQTABTestPropertyChanged iQTABTestPropertyChanged)

import com.quicktracking.sdk.android.abtest;
/**
 * Defines an interface IQTABTestPropertyChanged that is used to listen to property change events. 
 * 
 * <p> This interface contains a method {@link #onPropertyChanged(JSONArray)}, which will be called when the property changes. 
 * 
 * @see JSONArray
 */
public interface IQTABTestPropertyChanged {

    /**
     * The callback method that is triggered when a property changes. 
     * 
     * @param abParams A JSON array that contains information about attribute changes. 
     * This parameter is usually used to pass the specific data or context information of the property change. 
     */
    void onPropertyChanged(JSONArray abParams);
}

2.1.3 Obfuscation configuration

If your application uses code obfuscation, add the following configurations to prevent the use of the Quick Tracking and A/B Testing SDKs from being incorrectly obfuscated.

-keep class com.umeng.** {*;}
-keep class org.repackage.** {*;}

-keep class com.quick.qt.** {*;}
-keep class rpk.quick.qt.** {*;}

# for AB
-keep class com.quicktracking.sdk.android.abtest.** {*;}

-keepclassmembers class * {
   public <init> (org.json.JSONObject);
}
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

2.2 acquisition of experimental variables

Initialize the QuickTracking ABTest SDK, through the API to obtain a specific test variable value, according to the test variable value of the way, can be divided into the following three strategies:

• fetchABTestFromCache: Read the local cache. If the cache does not exist, the default value is used.

• fetchABTestFromServer: Ignore local cache and get data from server

• fetchABTestFromCacheThenServer: First read the local cache, cache does not exist from the server to obtain data

2.2.1 Scenarios

2.3API Introduction

fetchABTestFromCache

/**
* Get test results from the cache
*
* @param paramName The name of the parameter.
* @param defaultValue The default value.
* @param <T> The type of the return value.
* @return the t
*/
<T> T fetchABTestFromCache(String paramName, T defaultValue);

request parameters

Return Result

Usage example

import com.quicktracking.sdk.android.abtest.QTABTest;

// The request returns a String parameter. 
String result = QTABTest.shareInstance().fetchABTestFromCache("param_string", "test");

// The Boolean parameter returned for the request. 
Boolean result = QTABTest.shareInstance().fetchABTestFromCache(getTextValue(), false);

// The number parameter returned by the request. 
Integer result = QTABTest.shareInstance().fetchABTestFromCache(getTextValue(), 1);

// The request returns the JSONObject parameter.
try{
  JSONObject result = QTABTest.shareInstance().fetchABTestFromCache(getTextValue(), null);
}catch (Exception e){
}

fetchABTestFromServer

/**
 * Request test results from the network
 *
 * @param <T> The default value type.
 * @param paramName The name of the parameter.
 * @param The timeoutMillSeconds timeout period (in milliseconds).
 * @param defaultValue The default value.
 * @param callback The callback operation.
 */
<T> void fetchABTestFromServer(String paramName, int timeoutSeconds, T defaultValue, OnABTestResultCallBack<T> callback);

Request Parameters

Callback description:

import com.quicktracking.sdk.android.abtest.OnABTestResultCallBack;

public interface OnABTestResultCallBack<T> {
    /**
     * Request callback
     *
     * @param result <T> Default value type
     */
    void onResult(T result);
}

Return parameters:

Return Result

Usage example

import com.quicktracking.sdk.android.abtest.OnABTestResultCallBack;
import com.quicktracking.sdk.android.abtest.QTABTest;

QTABTest.shareInstance().fetchABTestFromServer("", 10 * 1000, null, new OnABTestResultCallBack<JSONObject>() {
    @Override
    public void onResult(JSONObject result) {
        refreshLogView(result.toString());
    }
});

fetchABTestFromCacheThenServer

 /**
     * If there is a local cache, the cached data is returned; otherwise, the latest test data is requested from the network, and the timeout period can be customized.
     *
     * @param <T> The default value type.
     * @param paramName The name of the parameter.
     * @param timeout The timeout period.
     * @param defaultValue The default value.
     * @param callback The callback operation.
     */
    <T> void fetchABTestFromCacheThenServer(String paramName, int timeout, T defaultValue, OnABTestResultCallBack<T> callback);

request parameters

Callback description:

import com.quicktracking.sdk.android.abtest.OnABTestResultCallBack;

public interface OnABTestResultCallBack<T> {
    /**
     * Request callback
     *
     * @param result <T> Default value type
     */
    void onResult(T result);
}

Return parameters:

Return Result

Usage example

import com.quicktracking.sdk.android.abtest.OnABTestResultCallBack;
import com.quicktracking.sdk.android.abtest.QTABTest;

QTABTest.shareInstance().fetchABTestFromCacheThenServer("param_json", 10 * 1000, null, new OnABTestResultCallBack<JSONObject>() {
    @Override
    public void onResult(JSONObject result) {
    }
});

3. Debug the experiment

After opening the experiment

When log is enabled, the corresponding experiment list will be printed out.