Quick Tracking:iOS SDK

1. Code integration details

The A/B Testing SDK depends on the iOS SDK v1.6.0 or later. Before you can use the A/B Testing SDK, you must integrate and initialize the QuickTracking Analytics SDK. For more information, see Import and configure the SDK.

2. Programmatic experiments

2.1 Integrate and initialize the SDK

First, initialize the QuickTracking Analytics SDK synchronously. After the QuickTracking Analytics SDK is initialized, you can initialize the QuickTracking A/B Testing SDK. When you initialize the QuickTracking A/B Testing SDK, you must pass the URL for requesting diversion experiments. You can obtain this URL from your operations personnel.

Integrate the QuickTracking SDK

SDK initialization

/** Initializes the QuickTracking ABTest iOS SDK.
 @param configOptions The initialization configurations.
 */
+ (void)startWithConfigOptions:(QTABTestConfigOptions *)configOptions;

The QTABTestConfigOptions class

#import <Foundation/Foundation.h>

typedef void (^OnABTestPropertyChangedBlock)(NSArray * _Nonnull result);

NS_ASSUME_NONNULL_BEGIN

@interface QTABTestConfigOptions : NSObject

/// The URL to get experiment results.
@property (nonatomic, copy) NSURL *baseURL;

/// The interval at which the SDK actively polls for the latest experiment results. Unit: seconds. The default value is 10 minutes. The minimum value is 10 seconds and the maximum value is 30 minutes. If the value is outside this range, the default value is used.
@property (nonatomic) NSTimeInterval updateInterval;

/// The callback for changes in locally cached experiment result data.
@property (nonatomic, copy) OnABTestPropertyChangedBlock onABTestPropertyChangedBlock;

- (instancetype)init NS_UNAVAILABLE;

/** The initialization method.
 @param urlString The URL string.
 @return An instance object.
 */
- (instancetype)initWithURL:(NSString *)urlString NS_DESIGNATED_INITIALIZER;

@end

NS_ASSUME_NONNULL_END

Example:

#import <QTABTestSDK/QTABTestSDK.h>

QTABTestConfigOptions *configOptions = [[QTABTestConfigOptions alloc] initWithURL:@"your_data_collection_endpoint/abtest_results?appkey=xxxxx"];
// Actively poll for the latest experiment results every 30 seconds.
configOptions.updateInterval = 30;
// Callback for changes in locally cached experiment result data.
// Method 1: Set in the initialization configuration.
configOptions.onABTestPropertyChangedBlock = ^(NSArray * _Nonnull result) {
    NSLog(@"---------result: %@",result);
    /** Example of returned result data
        [
          {"gid": xxx, "expid": xxx,}, 
          {"gid": xxx, "expid": xxx,},
          ...
        ]
    **/
};
[QTABTest startWithConfigOptions:configOptions];

Enable logging

/// Specifies whether to print the SDK log information in the console.
/// @param enable Specifies whether to enable or disable debug log output. YES: enable. NO: disable. The default value is NO.
+ (void)setLogEnabled:(BOOL)enable;

Example:

 [QTABTest setLogEnabled:YES];

2.1.1 Set the callback API for data changes in the local cache

Usage example

#import <QTABTestSDK/QTABTestSDK.h>

// Callback for changes in locally cached experiment result data.
// Method 2: Set by the developer.
[[QTABTest sharedInstance] setAbPropertyChangedBlock:^(NSArray * _Nonnull result) {
    NSLog(@"---------result: %@",result);
    /** Example of returned result data
        [
          {"gid": xxx, "expid": xxx,}, 
          {"gid": xxx, "expid": xxx,},
          ...
        ]
    **/
}];

2.2 Get experiment variables

After you initialize the QuickTracking ABTest SDK, you can use an API to retrieve the variable values for a specific experiment. You can use one of the following three policies to retrieve experiment variable values:

• fetchABTestFromCache: Reads data from the local cache. If the cache is empty, the default value is returned.

• fetchABTestFromServer: Ignores the local cache and retrieves data from the server-side.

• fetchABTestFromCacheThenServer: Reads data from the local cache first. If the cache is empty, it retrieves data from the server-side.

Scenario descriptions

2.3 API introduction

fetchABTestFromCache

// Reads the local cache to get the experiment. If the cache does not exist, the default value is used.
/// @param paramName The name of the experiment parameter.
/// @param defaultValue The default result.
/// @return The experiment value.
- (nullable id)fetchABTestFromCacheWithParamName:(NSString*)paramName
                                   defaultValue:(id)defaultValue;

Request parameters

Return value

Usage example

#import "QTABTest.h"

// Request a parameter of the NSString type. 
NSString *result = [[QTABTest sharedInstance] fetchABTestFromCacheWithParamName:@"ios_test_string" defaultValue:@"111"];

// Request a parameter of the Boolean type. 
BOOL result = [[QTABTest sharedInstance] fetchABTestFromCacheWithParamName:@"ios_test_bool" defaultValue:@(YES)];

// Request a parameter of the Number type. 
NSNumber result = [[QTABTest sharedInstance] fetchABTestFromCacheWithParamName:@"ios_test_number" defaultValue:@1];

// Request a parameter of the NSDictionary type.
NSDictionary *dict = @{
    @"param1" : @"1"
    };
NSDictionary *result = [[QTABTest sharedInstance] fetchABTestFromCacheWithParamName:@"ios_test_json" defaultValue:dict];

fetchABTestFromServer

// Ignores the local cache and gets data from the server-side. Asynchronously gets the latest experiment results from the server-side.
/// @param paramName The name of the experiment parameter.
/// @param defaultValue The default result.
/// @param timeoutInterval The timeout period. Unit: seconds.
/// @param completionHandler The callback on the main thread, which returns the experiment result.
- (void)fetchABTestFromServerWithParamName:(NSString*)paramName
                             defaultValue:(id)defaultValue
                          timeoutInterval:(NSTimeInterval)timeoutInterval
                        completionHandler:(void (^)(id _Nullable result))completionHandler;

Request parameters

Callback description:

typedef void (^QTABCompletionHandler)(id _Nullable result);

Return parameters:

Return value

Usage example

NSDictionary *dict = @{
    @"param1" : @"1"
    };
NSString *paramName = @"ios_test_json";

[[QTABTest sharedInstance] fetchABTestFromServerWithParamName:paramName defaultValue:dict timeoutInterval:10 completionHandler:^(id  _Nullable result) {

    if (result) {

        NSLog(@"======result:%@", result);
    }
}];

fetchABTestFromCacheThenServer

// Reads the local cache first. If the cache does not exist, it gets data from the server-side.
/// @param paramName The name of the experiment parameter.
/// @param defaultValue The default value.
/// @param timeoutInterval The timeout period. Unit: seconds.
/// @param completionHandler The callback on the main thread, which returns the experiment result.
- (void)fetchABTestFromCacheThenServerWithParamName:(NSString*)paramName
                                      defaultValue:(id)defaultValue
                                   timeoutInterval:(NSTimeInterval)timeoutInterval
                                 completionHandler:(void (^)(id _Nullable result))completionHandler;

Request parameters

Return value

Usage example

NSString *defaultValue = @"111";
NSString *paramName = @"ios_test_string";
[[QTABTest sharedInstance] fetchABTestFromCacheThenServerWithParamName:paramName defaultValue:defaultValue timeoutInterval:10 completionHandler:^(id  _Nullable result) {

    if (result) {

        NSLog(@"======result:%@", result);

    }
}];

3. Debug experiments

After you start an experiment:

When logging is enabled, a list of your experiments is printed.