Overview

Introduction

Criteo serves personalized ads to mobile app users that have a high probability of clicking through and either installing your app or making an in-app purchase. Criteo technology is based on real-time product recommendation optimization and prediction engines.

In order to enable its technology, Criteo needs:

• App Events - App events and relevant data correctly captured on your mobile app
• Catalog Feed - A CSV or XML file (called a Catalog Feed) containing product information of a large portion of your mobile app’s offers
• (For Retargeting) Deeplink and Universal Link capability - Product level deep link capabilities in app to take users to the products they clicked on

About this Guide

This document provides detailed information on the following integration stages:

• App events and parameters
• Kochava dashboard configuration, including postbacks
• Generation of tracking links
• Catalog feed integration (for product-level ads)
• Deeplinking & Universal Linking (for Retargeting)
• Testing process

Integration Steps

The table below describes the steps to follow during this integration.

App Events & Data

If you already have Kochava events configured, please skip this section.

To integrate the Kochava SDK and events from scratch, or add additional ones, please expand this section.

NSDictionary *identityLinkDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
                                        @"TEST_USER_ID", @"myInternalUserID",
                                        @"1235467890123456", @"service ID",
                                        @"en", @"language",
                                        @"6589e68c2a242271e56710100222ff83", @"email_md5",
                                        nil];
NSDictionary *initDict = [NSDictionary dictionaryWithObjectsAndKeys:
                              @"REPLACE_WITH_YOUR_KOCHAVA_APP_ID", @"kochavaAppId",
                              @"USD", @"currency", // optional - usd is default
                              @"0", @"limitAdTracking", // optional - 0 is default
                              @"1", @"enableLogging", // optional - 0 is default
                              identityLinkDictionary, @"identityLink", // optional
                              nil];
kochavaTracker = [[KochavaTracker alloc] initKochavaWithParams:initDict];

[delegate.kochavaTracker trackEvent:@"SessionBegin":@"{}"];

NSMutableDictionary * viewListing = [[NSMutableDictionary alloc] init];
[viewListing setObject:[NSArray arrayWithObjects:@"1", @"2", nil] forKey: @"product"];

jsonData = [NSJSONSerialization dataWithJSONObject:viewListing options:0 error:nil];

[delegate.kochavaTracker trackEvent: @"viewListing": [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]];

NSDictionary * viewProduct = @{@"product": @"1"};
jsonData = [NSJSONSerialization dataWithJSONObject:viewProduct options:0 error:nil];
[delegate.kochavaTracker trackEvent: @"View": [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]];

NSDictionary * viewBasket = @{
                @"currency": @"USD",
                @"product": @[
                    @{@"id": @"1",@"price": @"2.95",@"quantity": @"5"},
                    @{@"id": @"2",@"price": @"19.99",@"quantity": @"1"}
                ],
                @"din": @"2015-09-07",@"dout": @"2015-09-10" // optional for Travel, Hotel
            };

jsonData = [NSJSONSerialization dataWithJSONObject:viewBasket options:0 error:nil];
[delegate.kochavaTracker trackEvent: @"viewBasket": [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]];

NSDictionary * trackTransaction = @{
                @"nc": @"1",
                @"id": @"someid",
                @"currency": @"USD",
                @"product": @[
                    @{@"id": @"1",@"price": @"2.95",@"quantity": @"5"},
                    @{@"id": @"2",@"price": @"19.99",@"quantity": @"1"}
                ],
                @"din": @"2015-09-07",@"dout": @"2015-09-10" // optional for Travel, Hotel
            };

jsonData = [NSJSONSerialization dataWithJSONObject:trackTransaction options:0 error:nil];
[delegate.kochavaTracker trackEvent: @"Purchase": [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]];

NSDictionary * userLevel = @{@"ui_level": 5};
jsonData = [NSJSONSerialization dataWithJSONObject:userLevel options:0 error:nil];
[delegate.kochavaTracker trackEvent: @"userLevel": [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]];

NSDictionary * userStatus = @{@"ui_status": @"subscriber"};
jsonData = [NSJSONSerialization dataWithJSONObject:userStatus options:0 error:nil];
[delegate.kochavaTracker trackEvent: @"userStatus": [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]];

NSDictionary * userAchievement = @{@"ui_achievement": @"Gold_Medal"};
jsonData = [NSJSONSerialization dataWithJSONObject:userAchievement options:0 error:nil];
[delegate.kochavaTracker trackEvent: @"achievementUnlocked": [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]];

Hashed Email for Cross-Device Targeting (Recommended)

Clients have the option of sending Criteo the email address of app users when available. This will enable the cross-device Criteo targeting feature.

kTracker = new Feature(getApplicationContext(), datamap);
NSDictionary *identityLinkDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
                          @"CriteoKochavaTest", @"myInternalUserID",
                          @"1235467890123456", @"service ID",
                          @"en", @"language",
                          @"6589e68c2a242271e56710100222ff83", @"email_md5",
                          nil];

NSDictionary *initDict = [NSDictionary dictionaryWithObjectsAndKeys:
                          @"komobile-in--app-events5565020f2e19b",
                          @"kochavaAppId",
                          @"USD", @"currency", // optional - usd is default
                          @"0", @"limitAdTracking", // optional - 0 is default
                          @"1", @"enableLogging", // optional - 0 is default
                          identityLinkDictionary, @"identityLink",
                          nil];

kTracker = new Feature(getApplicationContext(), datamap);
NSDictionary *identityLinkDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
                          @"CriteoKochavaTest", @"myInternalUserID",
                          @"1235467890123456", @"service ID",
                          @"en", @"language",
                          @"kochava_ios@criteo.com", @"email_raw",
                          nil];

NSDictionary *initDict = [NSDictionary dictionaryWithObjectsAndKeys:
                          @"komobile-in--app-events5565020f2e19b",
                          @"kochavaAppId",
                          @"USD", @"currency", // optional - usd is default
                          @"0", @"limitAdTracking", // optional - 0 is default
                          @"1", @"enableLogging", // optional - 0 is default
                          identityLinkDictionary, @"identityLink",
                          nil];

Kochava Dashboard Configuration

Adding the ‘Criteo New’ Publisher Network

To add ‘Criteo New’ as a partner on Kochava’s dashboard:

1. Login to Kochava Dashboard.
2. Select the App
3. Under the left menu bar, click the Partner Configuration tab, and then click Add Configuration button.

Configuring Criteo Postbacks

Once the partner is configured, postbacks can be setup for each event type.

1. Open the ‘Criteo New’ module’s menu and click Postbacks

   

2. Install is automatically listed and its status is Configured postback, however it still needs additional setup (please see step 4 below for details). SessionBegin and the other post install events will be listed once received by Kochava. All the events (except install) are initially in status Active Event, meaning the postback is available but is not sending to Criteo yet. Once a postback is configured its Status becomes Configured postback.

   

3. On the menu on the next to the event select Create.
   
   The postbacks need to configured for: Install, SessionBegin, and all other relevant events available for the campaign such as post-install KPI events.
   
   For Retargeting, it’s highly recommended to also postback the key stages of the purchase funnel (for a retail app this would be events similar to SessionBegin, Search/Category Results, Item Details, Basket Add/View, Purchase Confirmation).

   

4. All the following settings are required for postbacks to function well:
   

   • CRITEO BUNDLE ID: Unique bundle ID of the app (this uniquely identifies the app to Criteo)

   • SEND ALL EVENT DATA: Check the box to send all data to Criteo. Essential for harnessing Criteo’s machine learning at its full potential (both user bidding and product recommendation), and useful for other use casees such as audience segmentation and custom reporting.

   • DELIVERY DELAY: Select Realtime Delivery

   • DELIVERY METHOD: Select All to send attributed, unattributed and organic events to Criteo. Essential for the same machine learning purposes mentioned above, and also to better suppress installed users from your App Install campaigns.

   Then, click Save.

   For Install, there is no Send All Event Data box to check.

   

Attribution Settings - Partner Level

1. Select Apps & Assets
2. Select Partner Configuration
3. To the right of ‘Criteo New - iOS’, select the three-dots menu
4. Select Reconciliation

5. Configure the windows below according to your attribution model, or these suggested defaults:

   

   

Tracking Links

Install Tracking

Retargeting Tracking

Catalog Feed

A catalog feed is an XML or a CSV file containing product information (name, price, deep link, image link…) that allows Criteo to dynamically generate product-level banners tailored to each user. Therefore, it is important to keep this file up to date in order for Criteo to show the right data in your banners.

The following points need to be kept in mind:

• Each product must have a unique ID that must be identical to the one passed in the events.
• The catalog feed must contain all or at least most of your apps’ products for Retail apps, and hotels/airline routes for Travel apps.
• Recommended image resolution is 300x300 pixels to 400x400 pixels.

Note: In some instances (i.e live campaigns on mobile web or desktop), Criteo will already have the catalog feed.

For more information, please request the dedicated guide from your contact.

Universal Links & Deeplinks

Deep linking consists of a hyperlink that links to a specific, generally searchable, or indexed piece of content on an App.

Criteo requires custom native deeplinks to run a App campaign utilizing dynamic creative. These deeplinks use a custom protocol (e.g. sampleadvertiser:// ) and, in most cases, optional parameters. The optional parameters may consist of a path and/or query parameters. (e.g. sampleadvertiser://product/sku123 or sampleadvertiser://product?sku=123).

For iOS, we also strongly recommend Advertisers use Universal Links. For Universal Links, when users click a banner, they’ll be seamlessly redirected to your app without going through Safari. If the app isn’t installed, clicking the App banner will take them to your mobile website in Safari. For more information on Universal Links, please see Apple’s Supporting Universal Links article.

Criteo requires two kinds of Universal Links & custom native deeplinks:

1. Opens to the homepage of the App.
2. Opens to each product-details page.

Pass deep link events to Kochava using this method. After receiving the URI from your application via openURL:(NSURL *)url sourceApplication: in your application delegate, just pass the url and sourceApplication parameters to the sendDeepLink method. You can learn more about deep linking for iOS here.

Following is the sample code to capture and forward deeplink to Kochava:

-(BOOL)application:(UIApplication *)app openURL:(NSURL *)url sourceApplication:(nullable NSString *)sourceApplication annotation:(nonnull id)annotation {
    [KochavaTracker.shared sendDeepLinkWithOpenURL:url sourceApplicationString:sourceApplication];

    return YES;
}

Note that you will also need to register your URL scheme. Information can be found here.

Testing process

Once all events and postbacks have been implemented, you should contact your Criteo representative to begin the testing phase.

Criteo requires the following elements:

• App build to test the collection of events on Criteo side.
• If testing remotely, the IDFA of the test device.
• (For Retargeting) Deeplink and Universal Link examples - homepage & product details page.