OneTrust Consent Management for iOS

The RudderStack iOS SDK lets you specify the user’s consent during initialization.

The RudderStack iOS SDK supports OneTrust consent management from version 1.9.0.

This guide lists the steps to develop a consent interceptor for the iOS SDK and use the interceptor to initialize the SDK once the user gives their consent.

Overview

The consent management is designed to be a filter for the event destinations and the natively added factories. Since the SDK initializes the native integration factories during the startup, you must capture the user’s consent to the cookie categories by then.

You can add only one consent filter to the iOS SDK.

For filtering, RudderStack uses the getConsentStatus(forCategory categoryId: String) method from the OneTrust SDK.

Installing OneTrust consent

This setup assumes the iOS SDK and the OneTrust SDK are already added to your application.

1. Install RudderOneTrustConsentFilter by adding the following line to your Podfile:

pod 'RudderOneTrustConsentFilter', '~> 1.0.0'

2. Import the iOS SDK:

@import RudderOneTrustConsentFilter;

import RudderOneTrustConsentFilter

3. Finally, add the imports to your AppDelegate file under the didFinishLaunchingWithOptions method, as shown:

@interface AppDelegate ()<OTEventListener>

@end

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [[OTPublishersHeadlessSDK shared] startSDKWithStorageLocation:STORAGE_LOCATION domainIdentifier:DOMAIN_IDENTIFIER languageCode:@"en" params:nil loadOffline:NO completionHandler:^(OTResponse *response) {
        if (response.status) {
        
        }
    }];
    
    [[OTPublishersHeadlessSDK shared] addEventListener:self];
}

- (void)initializeRudderSDK {
    RSConfigBuilder *builder = [[RSConfigBuilder alloc] init];
    [builder withLoglevel:RSLogLevelDebug];
    [builder withDataPlaneUrl:DATA_PLANE_URL];
    [builder withConsentFilter:[[RudderOneTrustConsentFilter alloc] init]];

    [RSClient getInstance:rudderConfig.WRITE_KEY config:builder.build];
}

- (void)onPreferenceCenterConfirmChoices {
    [self initializeRudderSDK];
}

class AppDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        OTPublishersHeadlessSDK.shared.startSDK(
            storageLocation: STORAGE_LOCATION,
            domainIdentifier: DOMAIN_IDENTIFIER,
            languageCode: "en"
        ) { response in
            if response.status {
        
            }
        }
        
        OTPublishersHeadlessSDK.shared.addEventListener(self)
    }
    
    func initializeRudderSDK() {
        let builder: RSConfigBuilder = RSConfigBuilder()
            .withLoglevel(RSLogLevelDebug)
            .withDataPlaneUrl(DATA_PLANE_URL)
            .withConsentFilter(RudderOneTrustConsentFilter())

        RSClient.getInstance(rudderConfig.WRITE_KEY, config: builder.build())
    }
}

extension AppDelegate: OTEventListener {
    func onPreferenceCenterConfirmChoices() {
        initializeRudderSDK()
    }
}

Make sure you load the SDK only if the user provides their consent.

Creating a custom consent filter

#import <Foundation/Foundation.h>
#import <Rudder/Rudder.h>
NS_ASSUME_NONNULL_BEGIN
@interface CustomConsentFilter : NSObject<RSConsentFilter>
@end
NS_ASSUME_NONNULL_END

#import "CustomConsentFilter.h"

@implementation CustomConsentFilter

- (NSDictionary <NSString *, NSNumber *> * __nullable)filterConsentedDestinations:(NSArray <RSServerDestination *> *)destinations {
    NSDictionary <NSString *, NSNumber *> *filteredConsentedDestinations;
    // Do someting
    return filteredConsentedDestinations;
}

@end

@objc
open class OneTrustInterceptor: NSObject, RSConsentFilter {
    @objc
    public override init() {
        super.init()
    }

    public func filterConsentedDestinations(_ destinations: [RSServerDestination]) -> [String: NSNumber]? {
        let filteredConsentedDestinations: [String: NSNumber]
        // Your code
        return filteredConsentedDestinations
    }
}

Registering consent filter with iOS SDK

You can register CustomConsentFilter with the iOS SDK during its initialization, as shown:

RSConfigBuilder *builder = [[RSConfigBuilder alloc] init];
[builder withLoglevel:RSLogLevelDebug];
[builder withDataPlaneUrl:DATA_PLANE_URL];
[builder withConsentInterceptor:[[CustomConsentFilter alloc] init]];
[RSClient getInstance:WRITE_KEY config:builder.build];

let builder: RSConfigBuilder = RSConfigBuilder()
    .withLoglevel(RSLogLevelDebug)
    .withDataPlaneUrl(DATA_PLANE_URL)
    .withConsentFilter(CustomConsentFilter())
RSClient.getInstance(rudderConfig.WRITE_KEY, config: builder.build())

Additional settings for cloud mode

RudderStack supports OneTrust integration in cloud mode from iOS SDK v1.12.0 onwards and RudderOneTrustConsentFilter 1.1.0.

You can specify your OneTrust cookie categories when sending events from your iOS source via the cloud mode. Follow these steps:

1. Set up your iOS source in the RudderStack dashboard.
2. Connect it to a new or existing destination.
3. In the destination’s connection settings, enter the OneTrust category ID in the Category ID field:

When sending events via the cloud mode, make sure you enter the category ID corresponding to the OneTrust cookie category. Specifying the category name will not work.

You can find the category IDs in your OneTrust dashboard under Preference & Consent Management > Cookie Compliance > Categorizations > Categories.

Questions? Contact us by email or on Slack