This document will outline how to track mobile applications within CAKE. This document will assume that you have not integrated the CAKE SDK.
We will cover two scenarios:
1) In App Advertising: Advertising traffic that originates within a native app.
2) Out of App Advertising: Advertising that originates in a web browser, email or other non app traffic source.
In App Advertising
This process will walk you through the scenario where the consumer is in an application and clicks on an advertisement.
CAKE Unique Link
Similar to web tracking, a CAKE Unique Link will be used to track the click.
The above URL is an example of a standard tracking link.
Mobile Tracking Parameters
In App Advertising allows an Affiliate to extract a unique value from the consumer's phone depending on the device the consumer is using.?The unique devide ID can be passed on s2, s3, s4 or s5.
The example above shows the Mac Address being passed on the s5 parameter of the tracking link.
Offer Setup In CAKE
Offers in CAKE that are intended to track Application Installs will require a unique setup.?To set your Offer up to handle Application Installs, click on the Redirect Tab within the Offer Card.
Session Regeneration Seconds: This is the "window of opportunity" where a Conversion can be tracked. This "window" is from the moment a consumer clicks the CAKE Unique Link to the moment the Application is opened on their phone and the Conversion Postback is sent to CAKE. Today, the maximum time CAKE will track this event is 86,400 seconds, or 24 hours.
Session Regeneration Type: This defines the unique tracking key you intend to use on the Unique Link and the Postback URL. Note :: Some Session Regeneration Types are recommended for app tracking where others are not.
IP Only: Selecting IP Only means that CAKE is only going to track consumers based on the IP of the click and the IP collected on the Postback URL. If the IP on the click does not match the IP on the Postback URL, a Conversion will not be tracked.
IP + User Agent: CAKE must match the IP Address of the click and on the Postback URL. In addition, the User Agent of the consumer's phone must also match. The User Agent is the unique thumb print of the consumer's device which includes OS, Browser and more. (Not recommended as the User Agent in the mobile browser is not the same as the User Agent from the App.)
IP + Device:
IP + Device/User-Agent:
IP + Sub ID: CAKE must match the IP Address of the click and on the Postback URL. In addition, a unique tracking key must be passed in on Sub ID 2, 3, 4, or 5 and must be passed back into CAKE on the Postback URL. CAKE will only track a Conversion if BOTH match.
Sub ID only: CAKE ignores the IP Address of the consumer's phone and only looks at a unique tracking key being passed in on the click and then returned on the Postback URL.
Sub ID 5 Only Fallback to IP Only: CAKE will attempt to track a Conversion based on a unique tracking key being passed in on the s5 parameter of the Unique Link. If CAKE is UNABLE to track based on s5, we will attempt to match the IP Address of the click with the IP Address passed in on the Postback URL. (Highly recommended for app tracking)
Sub ID 5 Only Fallback to IP + Device:
Sub ID 5 Only Fallback to IP + Device Fallback to IP Only:
CAKE is able to track when the consumer opens the Application when the Advertiser makes a Server Call to CAKE. This Server Call is a Postback URL. Contrary to traditional Server Tracking in CAKE, the Postback URL for Mobile includes a k= parameter as opposed to a reqid= parameter. Additionally, the Postback URL will need to include f=pb which let's CAKE know that the pixel is a Postback URL. By default, CAKE recognizes a Postback URL if it contains reqid=
If the Affiliate is unable to extract a unique tracking ID from the consumer's device, CAKE can track the conversion using the consumer's IP Address.? CAKE tracks the IP Address of the consumer on the initial click and does not require the Affiliate to customize the format of their Unique Link.
The Advertiser who is responsible for making the Server Call to CAKE will need to include the IP Address of the consumer's device on the Postback URL.? If the Server Call is coming from the app directly and NOT from the Advertiser's server, the IP Address is NOT required on the Postback URL.
An example of this is shown above.
Postback URL Parameters
Here is a complete list of all of the parameters that can be used on a Postback URL used on a Mobile Application Offer.
o= This is the Offer ID. In the example above, o=1 which is referring to Offer ID 1 in your system.
k= This is the Unique Tracking Key. This can be any unique ID that is specific to the consumer's phone. With iOS, the Mac Address is very popular but can be any other unique ID as well. It's important to note that you can use multiple k= values as well. (example: &k=mac_address&k=IDFA)
ip= This is intended to be the IP Address that the consumer's phone was on when they opened the Application.
f= This is the format of the Pixel.
pb tells CAKE that this pixel is formatted as a Postback URL. THIS IS REQUIRED WHEN R= IS NOT PRESENT.?
t= This is an OPTIONAL parameter that allows the Advertiser to pass a unique ID per Conversion. This is often an Order ID or a Receipt of sorts.
The above is an example of the XML response you will receive upon a Postback URL call to CAKE.
It's important to note that your Advertiser is able to retrieve the unique Request ID within the response, which can be used for subsequent Events.
Out Of App Advertising
CAKE can track Application Installs when the consumer clicks on an Advertisement outside of the Application.
This may be an Email or a Banner the consumer clicks on in their mobile browser.
CAKE Unique Link
The Affiliate will be issued a standard CAKE Unique Link to track the consumer and to redirect them to the store where they will download the Application.? The Affiliate can place optional tracking parameters, such as a Sub ID, on the S parameters. For example, the Affiliate can place their Sub ID on s1 and the Media Source in s2:
Mobile Tracking Parameters
The only tracking parameter CAKE can use when the consumer clicks on an Advertisement outside of an Application is the IP Address.? You are only able to take advantage of unique tracking IDs, such as the Mac Address, when the consumer clicks on an Advertisement from within an Application.
The Affiliate does not need to customize their Unique Link to accomodate the IP Address. CAKE will track this naturally.
Offer Setup In CAKE
Offers in CAKE that are intended to track Application Installs will require a unique setup.?To set your Offer up to handle Application Installs, click on the Redirect Tab within the Offer card.
Session Regeneration Seconds: The "window of opportunity" where a Conversion can be tracked. This "window" is from the moment a consumer clicks the CAKE Unique Link to the moment the Application is opened on their phone. Today, the maximum time CAKE will track this event is 86,400 seconds, or 24 hours.
Session Regeneration Type: The unique tracking key that CAKE will use to track a Conversion. For Application Installs where a consumer clicks on an Advertisement outside of an Application, you can ONLY track via IP Address.
The Postback URL
Once the consumer opens the Application, the Advertiser will make a Server Call to CAKE using a Postback URL.
The IP Address of the Consumer's Phone will need to be placed on the Postback URL UNLESS a pixel is placed directly on the Application itself. In this case, the Pixel will carry the IP Address of the Consumer's device naturally.
If CAKE matches the IP Address on the Postback URL to the IP Address on the original click, within the Session Regeneration time frame, a Conversion will be tracked.