Configuration bd75f5

Data collection / Apple / Getting started / Configuration

Foreword

To facilitate integration of your tag, the Tag Composer application allows you to configure and download our SDK.

These configuration variables are listed in the tracker’s DefaultConfiguration.plist file.

You may specify different configurations by type of device by creating .plist files and adding the type of device to the file name (e.g. DefaultConfigurationipad.plist, DefaultConfigurationiphone.plist…).

We recommend setting the configuration secure to true, since OS can block non-secure requests.

Editing the configuration

At any moment, you may change your tag’s configuration.

When creating a tracker:

• Swift
• Objective-C

let myConfiguredTracker = ATInternet.sharedInstance.tracker("myConfiguredTracker", configuration: ["log":"YOURLOG", "logSSL":"YOURSSLLOG", "domain":"YOURDOMAINLOG", "pixelPath":"/hit.xiti", "site":"YOURSITEID", "secure":"true", "identifier":"uuid", "plugins":"", "enableBackgroundTask":"true", "storage":"required", "hashUserId":"false", "persistIdentifiedVisitor":"true", "campaignLastPersistence": "false", "campaignLifetime": "30", "sessionBackgroundDuration": "60"])

Tracker* myConfiguredTracker = [[ATInternet sharedInstance] tracker:@"myConfiguredTracker" configuration:@{@"log":@"YOURLOG", @"logSSL":@"YOURSSLLOG", @"domain":@"YOURDOMAINLOG", @"pixelPath":@"/hit.xiti", @"site":@"YOURSITEID", @"secure":@"true", @"identifier":@"uuid", @"plugins":@"", @"enableBackgroundTask":@"true", @"storage":@"required", @"hashUserId":@"false", @"persistIdentifiedVisitor":@"true", @"campaignLastPersistence": @"false", @"campaignLifetime": @"30",@"sessionBackgroundDuration": @"60"}];

Via use of the tracker’s setConfig method:

Please note, the setConfig method is an asynchronous method. To ensure that the configuration was successfully applied, a callback indicating that the configuration was successfully applied is available.

1. Modification of a configuration key:

   • Swift
   • Objective-C

tracker.setConfig("secure", value: "true") { (isSet) -> Void in
    print("Tracker is now using SSL")
}

[self.tracker setConfig:@"secure" value:@"true" sync:NO completionHandler:^(BOOL isSet) {
    NSLog(@"%@", @"Tracker is now using SSL");
}];

2. Replacement of certain configuration keys:

   Only keys passed as parameters will be modified or added to the existing configuration

   • Swift
   • Objective-C

tracker.setConfig(["secure": "true", "site": "YOURSITEID", "hashUserId": "true"], override: false) { (isSet) -> Void in
    print("Configuration is now set")
}

[self.tracker setConfig:@{@"secure": @"true", @"site": @"YOURSITEID", @"hashUserId": @"true"} override: NO sync:NO completionHandler:^(BOOL isSet) {
    NSLog(@"%@", @"Configuration is now set");
}];

Since 2.2.0 version, it’s possible to use helpers and constants to simplify configuration management.

1. Samples to use helpers

   • Swift
   • Objective-C

// Log
ATInternet.sharedInstance.defaultTracker.setLog("YOURLOG") { (isSet) -> Void in
    print("Your new log is set")
}
        
// Secured Log
ATInternet.sharedInstance.defaultTracker.setSecuredLog("YOURSSLLOG") { (isSet) -> Void in
    print("Your new secured log is set")
}
        
// Site id
ATInternet.sharedInstance.defaultTracker.setSiteId(YOURSITEID) { (isSet) -> Void in
    print("Your new site id is set")
}

// Log
[[[ATInternet sharedInstance]defaultTracker]setLog:@"YOURLOG" sync:NO completionHandler:^(BOOL isSet) {
    NSLog(@"Your new log is set");
}];
    
// Secured Log
[[[ATInternet sharedInstance]defaultTracker]setSecuredLog:@"YOURSSLLOG" sync:NO completionHandler:^(BOOL isSet) {
    NSLog(@"Your new secured log is set");
}];
    
// Site id
[[[ATInternet sharedInstance]defaultTracker]setSiteId:YOURSITEID sync:YES completionHandler:nil];

2. Samples to use constants (all constants are available in TrackerConfigurationKeys in Swift, prefixed by AT_CONF_ in Objective-C)

   • Swift
   • Objective-C

// Log
ATInternet.sharedInstance.defaultTracker.setConfig(TrackerConfigurationKeys.Log, value: "YOURLOG", completionHandler: { (isSet) -> Void in
    print("Your new log is set")
})
            
// Secured Log
ATInternet.sharedInstance.defaultTracker.setConfig(TrackerConfigurationKeys.LogSSL, value: "YOURSSLLOG", completionHandler: { (isSet) -> Void in
    print("Your new secured log is set")
})
        
// Site id
ATInternet.sharedInstance.defaultTracker.setConfig(TrackerConfigurationKeys.Site, value: "YOURSITEID", completionHandler: { (isSet) -> Void in
    print("Your new site id is set")
})

// Log
[[[ATInternet sharedInstance]defaultTracker]setConfig:TrackerConfigurationKeys.Log value:@"YOURLOG" sync:NO completionHandler:^(BOOL isSet) {
    NSLog(@"Your new log is set");
}];
    
// Secured Log
[[[ATInternet sharedInstance]defaultTracker]setConfig:TrackerConfigurationKeys.LogSSL value:@"YOURSSLLOG" sync:NO completionHandler:^(BOOL isSet) {
    NSLog(@"Your new secured log is set");
}];
    
// Site id
[[[ATInternet sharedInstance]defaultTracker]setConfig:TrackerConfigurationKeys.Site value:@"YOURSITEID" sync:NO completionHandler:^(BOOL isSet) {
    NSLog(@"Your new site id is set");
}];