Quick Tracking:HarmonyOS Next SDK

Essential for using QuickTracking Android(A/B Testing).

Refer and initialize the SDK

sdk basic information

Integration code details

The A/B Testing SDK depends on the Quick Tracking 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 HarmonyOS HarmonyOS Next SDK.

Programming Experiment

Integrate and initialize the SDK

First, you need to initialize the QuickTracking statistics 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.

Synchronous introduction mode

Add the QT A/B Testing SDK dependency to the oh-package.json5 file of the main module. Currently, HarmonyOS next only supports local package access:

{
  ...
  "dependencies": {
    "@quicktracking/common": "file:./lib/common.har",
    "@quicktracking/analytics": "file:./lib/qt_tongji.har",
    "@quicktracking/abtesting": "file:./lib/abtesting.har"
  }
}

SDK storage address

Initialize the SDK

The SDK initializes the dependency @quicktracking/common and passes in the corresponding AB parameters.

import * as QT from '@quicktracking/analytics';
import { QTABTestPlugin,QTABTestConfigOptions } from '@quicktracking/abtesting';

QT.setLogEnabled(true);
QT.setTrackDomain("Receipt domain name", "Receipt domain name")

export default class MyAbilityStage extends AbilityStage {
  onCreate() {
    // Initialize the parameters of the AB experiment.
    let config: QTABTestConfigOptions =
      new QTABTestConfigOptions("Your service address /abtest_results?appkey=xxxxx", 5 * 60 * 1000);
    QT.preInit({
      appKey: 'Your appkey',
      context: this.context.getApplicationContext(),
      enableJSBridge: true,
      enableAutoTrackApplication: true,
      enableAutoTrackPage: false,
      plugins: [new QT.InternalPlugin()],
      newPlugins: [new QTABTestPlugin(this.context.getApplicationContext(), config)]
    });
    QT.init();
  }
}

Procedure:

// Quick AB test interface
export class QTABTestConfigOptions {
  mUrl: string = '';// AB experiment address --- must be passed
  mInterval?: number; // The time when the cache is updated. This value is optional.
}

The following table describes the parameters in the preceding statement.

Get experiment variables

After the initialization QuickTracking ABTest SDK, the variable value of the specific test is obtained through the API, which can be divided into the following two strategies according to the method of obtaining the value of the test variable:

// Quick AB test interface
export interface IQuickTrackABTestApi {
  // Obtain the AB test data from the cache.
  fetchABTestFromCache(param: QT_AB_API_PARAMS): void;

  // Obtain AB test data from the server.
  fetchABTestFromServer(param: QT_AB_API_PARAMS): void;
}

Scenarios

List of operations by function

QT_AB_API_PARAMS

export interface QT_AB_API_PARAMS {
  param_name: string; // request parameters
  value_type: QT_AB_EXPERIMENT_VARIABLE_TYPE; // The data format type.
  default_value: QT_AB_EXPERIMENT_VARIABLE_VALUE; // The default value.
  callback: OnABTestResultCallBack; // The callback.
  timeout_milliseconds?: number; // (Optional) The timeout period.
  update_interval_milliseconds?: number; //(Optional) The time when the cache was updated.
}

Request Param panel

Note: Please make sure that the default values used in the /B shunt API are handled normally in business logic!

The following table describes the response parameters.

Examples

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){
}

Use instances:

import { QTABTest, QT_AB_API_PARAMS, QT_AB_EXPERIMENT_VARIABLE_VALUE } from '@quicktracking/abtesting';

...
Button ('Request JSON')
  .controlSize(ControlSize.SMALL)
  .buttonStyle(ButtonStyleMode.EMPHASIZED)
  .onClick(() => {
    const param: QT_AB_API_PARAMS = {
      param_name: this.areaText,
      value_type: "JSON",
      default_value: new Object({
        "name": "test",
      }),
      callback: (result: QT_AB_EXPERIMENT_VARIABLE_VALUE) => {
        this.refreshLogText(JSON.stringify(result))
      }
    }
    QTABTest.sharedInstance.fetchABTestFromServer(param)
    QTABTest.sharedInstance.fetchABTestFromCache(param)
  })
...

Commissioning test

After opening the experiment

When log is enabled, the filter [abtest] will print out your corresponding experiment list.