Adding Ad Revenue Attribution Support

To add ad revenue attribution support in the Singular SDK:

1. If you haven't done so yet, contact your Singular Customer Success Manager to enable ad revenue attribution for your account.
2. Update to the latest version of the Singular SDK.
3. Add the appropriate code snippet to your Singular SDK integration, depending on the mediation platform you use for ad revenue data.

// The object received from AdMob's event: paidEventHandler
GADAdValue* impressionData;

// Admob Ad object
GADRewardedAd* rewardedAd;

SingularAdData* data = [[SingularAdData alloc] initWithAdPlatfrom:@"Admob" withCurrency:[impressionData currencyCode] withRevenue:[impressionData value]];

[data setAdUnitId:[rewardedAd adUnitID]];
[data setNetworkName:rewardedAd.responseInfo.adNetworkClassName];
[data setAdPlacementName:"AD_PLACEMENT_NAME"];
[data setAdType:"AD_TYPE"];

[Singular adRevenue:data];

// The object received from AppLovin MAX's event, didReceivedMessage
ALCMessage* message;

SingularAdData* data = [[SingularAdData alloc] initWithAdPlatfrom:@"AppLovin" withCurrency:@"USD" withRevenue:message.data[@"revenue"] doubleValue];

[data setAdUnitId:message.data[@"max_ad_unit_id"]];
[data setNetworkName:message.data[@"network_name"]];
[data setAdType:message.data[@"ad_format"]];

[Singular adRevenue:data];

// The object received from IronSoruce's event, impressionDataDidSucceed
ISImpressionData* impressionData;

SingularAdData* data = [[SingularAdData alloc] initWithAdPlatfrom:@"IronSource" withCurrency:@"USD" withRevenue:impressionData.revenue];

[data setAdUnitId:[impressionData instanceId]];
[data setAdUnitName:[impressionData instanceName]];
[data setImpressionId:[impressionData auctionId]];
[data setNetworkName:[impressionData adNetwork]];
[data setAdPlacementName:[impressionData placement]];
[data setAdType:[impressionData adUnit]];

[Singular adRevenue:data];

// The object received from Mopub's event, OnImpression
MPImpressionData* impressionData;

SingularAdData* data = [[SingularAdData alloc] initWithAdPlatfrom:@"Mopub" withCurrency:[impressionData currency] withRevenue:[impressionData publisherRevenue]];

[data setAdGroupId:[impressionData adGroupID]];
[data setAdGroupName:[impressionData adGroupName]];
[data setAdGroupType:[impressionData adGroupType]];
[data setAdGroupPriority:[impressionData adGroupPriority]];
[data setAdUnitId:[impressionData adUnitID]];
[data setAdUnitName:[impressionData adUnitName]];
[data setImpressionId:[impressionData impressionID]];
[data setNetworkName:[impressionData networkName]];
[data setAdPlacementName:"AD_PLACEMENT_NAME" ];
[data setAdType:"AD_TYPE"];

[Singular adRevenue:data];

// Initialize the SingularAdData object with the relevant data
SingularAdData* data = [[SingularAdData alloc] initWithAdPlatfrom:@"YOUR_AD_PLATFORM" withCurrency:@"CURRENCY_CODE" withRevenue:[NSNumber numberWithDouble:9.90]];

// The more ad data you add, the greater the granularity
[data setAdGroupId:@"AD_GROUP_ID"];
[data setNetworkName:@"AD_NETWORK_NAME"];

// Report the data to Singular
[Singular adRevenue:data];

Tracking Uninstalls

To let Singular track your app's uninstalls:

1. Make sure uninstall tracking is enabled for your app in Singular. See Setting Up iOS Install Tracking for instructions.
2. In the app, send Singular the device token returned from the Apple Push Notification Service (APNS). To pass the device token to Singular use the registerDeviceTokenForUninstall or registerDeviceToken method. Do this before the Singular StartSession call.

If your app doesn't support push notifications yet, see Apple's guide to implementing APNS.

- (void)application:(UIApplication*)application
 didRegisterForRemoteNotificationsWithDeviceToken:(NSData*)deviceToken {
 [Singular registerDeviceTokenForUninstall:deviceToken];
}

func application(_ application: UIApplication, 
 didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
 Singular.registerDeviceToken(forUninstall: deviceToken)
}

Adding Global Properties

The Singular SDK lets you define custom additional properties that you want to send to the Singular servers with every session and event sent from the app. These properties can represent any information you want about the user, the app mode or status, or anything else. Once you set these properties, they are available as dimensions in your reports and you can use them to break down your data.

For example, if you have a gaming app, you can define a property called "Level" and set it initially to "0". Any session and event sent from the app will be sent with "Level": "0". Once the user levels up you reset the property to "1" and so on. You can then get your stats for sessions, events, and revenue data, broken down by the player's game level.

Setting Global Properties through SingularConfig

To set global properties before initializing the SDK, use the setGlobalProperty method in SingularConfig.

Note that since global properties and their values persist between app runs, the property that you are setting may already be set to a different value. Use the overrideExisting parameter to tell the SDK whether to override an existing property with the new value or not.

SingularConfig* config = [[SingularConfig
                    alloc] initWithApiKey:apiKey andSecret:secretKey];
                    [config setGlobalProperty:@“example_key” withValue:@“example_value”
                    overrideExisting:NO];

                    [config setGlobalProperty:@“test_key” withValue:@“test_value”
                    overrideExisting:YES];
                    [Singular start:config];

var config = SingularConfig(
                        apiKey: apiKey,
                        andSecret: secretKey)
                        
                        config.setGlobalProperty(
                        "example_key"),
                        withValue: "example_value",
                        overrideExisting: false)

                        config.setGlobalProperty(
                        "test_key",
                        withValue: "test_value",
                        overrideExisting: true)

Setting Global Properties After Initialization

Use the following methods to set, unset, and retrieve global properties at any time in the app's run.

BOOL result = [Singular setGlobalProperty:@“test_key” 
withValue:@“test_value” overrideExisting:YES];

NSDictionary* props = [Singular getGlobalProperties];

[Singular unsetGlobalProperty:“@test_key”];

[Singular clearGlobalProperties];

Using the Singular SDK JavaScript Interface

Singular provides a JavaScript interface that you can use in order to call Singular from within javaScript code in your app.

For example, if you set up the JavaScript interface, you can send events to Singular from JavaScript code as follows:

Singular.event('event'); 
            Singular.event('test', JSON.stringify({"a1":"bar",
    "a2":"boo", "a3":"baz"})); 

The interface supports the following SDK methods:

• setCustomUserID
• unsetCustomUserID
• event
• revenue

Enabling the JavaScript Interface

To enable the JavaScript interface when using WKWebView , you need to add some code to the webView method of the WKNavigationDelegate protocol (this protocol helps you implement custom behaviors triggered when a web view handles a navigation request).

Swift:

extension ViewController: WKNavigationDelegate { 
                func webView(_: WKWebView, decidePolicyFor: WKNavigationAction, 
    decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) { 
                    
                    // Singular handler 
                    let js = "typeof(Singular)" 
                    webView.evaluateJavaScript(js) { (result, error) -> Void in 
                        if let resultString = result as? String { 
                            if resultString.isEqual("undefined") { 
                                do { 
                                    let contents = try String(contentsOfFile: 
                 Bundle.main.path(forResource: "Singular", ofType: "js")!) 
                                    self.webView.evaluateJavaScript(contents, 
             completionHandler: nil) 
                                } catch { 
                                } 
                            } 
                            else { 
                                print(decidePolicyFor.request) 
                                Singular.processJSRequestWK(self.webView, 
                         withURL:decidePolicyFor.request) 
                            } 
                        }  
                    } 
                    
                    // rest of your code goes here   
                } 

If you are using the older UIWebView (deprecated in iOS 8.0), update the method webView:shouldStartLoadWithRequest:navigationType: in your UIWebViewDelegate file as follows:

Objective-C:

- (BOOL)webView:(UIWebView *)webView 
    shouldStartLoadWithRequest:(NSURLRequest *)request
    navigationType:(UIWebViewNavigationType)navigationType{ 
                    if([[webView stringByEvaluatingJavaScriptFromString:@"typeof(Singular)"] isEqualToString:@"undefined"]) { 
                        
                        // Inject Singular.js into the HTML 
                        [webView stringByEvaluatingJavaScriptFromString:[NSString
       stringWithContentsOfFile:[[NSBundle mainBundle] 
       pathForResource:@"Singular" ofType:@"js"] usedEncoding:nil error:nil]]; 
                    } else { 
                        // process request in Singular.js 
                        [Singular processJSRequest:webView withURL:request]; 
                    } 
                    
                    // The rest of your code goes here 
                    
                    return true; 
                }

Complying with Data Privacy Laws

Singular provides privacy-safeguarding functionality to help you cooperate with any partners who may be complying with consumer privacy laws such as GDPR and CCPA (California Consumer Privacy Act). These partners want to be notified if the end-user has consented to share their private information.

If you have implemented a way to ask users for consent to share their information, use the limitDataSharing method to notify Singular of the user's choice:

• Use limitDataSharing:NO to indicate that the user consented (opted in) to share their information.
• Use limitDataSharing:YES if the user did not consent.

Singular will pass this information on to partners who require it in order to comply with relevant regulations.

// User has opted into sharing data
[Singular limitDataSharing:NO];

Additional Methods for GDPR Compliance

The Singular SDK provides several methods to help you comply with GDPR policies and let Singular know about user consent or non-consent for tracking.

[Singular trackingOptIn];

Singular.trackingOptIn()

[Singular stopAllTracking];

Singular.stopAllTracking()

[Singular resumeAllTracking];

Singular.resumeAllTracking()

[Singular isAllTrackingStopped]; // returns true/false

Singular.isAllTrackingStopped() // returns true/false