🍄Custom Ad Attribution Parameters (CAAP)

If you have a use case where you want granular reporting of revenue data — beyond what you get from our standard reports, you can use our Custom Ad Attribution Parameters to meet that use case.

Why do I need this?

Let's take a look at some use cases:

• You operate an ad network and backfill your remnant inventory with Gamezop banners. With thousands of publishers under you, it's not feasible for us to create a separate Property ID for each one. So how can you view revenue breakdowns per publisher?

• You promote Gamezop across multiple sections within your product and want to track revenue metrics separately for each placement. How can you do that efficiently?

Enter CAAP.

CAAP enables you to segment your revenue data using hundreds or even thousands of traffic sources — without requiring Gamezop to generate individual Property IDs for each case.

This document explains how CAAP works and how you can get started.

---

Get started

Follow these steps to get started:

Step 1: Make a string with your tracking parameters

You may have one or more traffic sources you want to track.

Let's take the same ad network example above. You have 5 publishers that monetise with your demand. You also have multiple ad sizes / placements per publisher. You may want us to provide revenue breakdown by each of your publishers + ad placements. Or you may want a breakdown by page route / domain. Whatever you want to track, make a string out of it.

For this example, let's say our string is publisher-example.com_placement-homePageATF

Ensure you do not use any of the following characters within your string:

Character	Description
"	Double quotes
'	Single quotes
=	Equal sign
!	Exclamation point
+	Plus sign
#	Pound or hash sign
*	Asterisk
~	Tilde
;	Semi-colon
^	Caret
()	Parentheses
<>	Angle brackets
[]	Square brackets
,	Comma
&	Ampersand

Step 2: Base64URL encode the string

If you encode the above string (publisher-example.com_placement-homePageATF) as Base64URL, you get: cHVibGlzaGVyLWV4YW1wbGUuY29tX3BsYWNlbWVudC1ob21lUGFnZUFURg

Ensure you are using Base64URL encoding, and not regular Base64 encoding. Base64URL encoding will not contain == at the end of the encoded value.

Step 3: Send the encoded value in the cust-params URL paramter with your Unique Link

Take the Unique Link of the product you are integrating and add a URL parameter cust-params. Pass the encoded value from Step 2 in this parameter.

For example, if your Gamezop Unique Link is 1234.play.gamezop.com and you want to pass publisher-example.com_placement-homePageATF as your tracking value, your final URL will look like this:

https://1234.play.gamezop.com/?cust-params=cHVibGlzaGVyLWV4YW1wbGUuY29tX3BsYWNlbWVudC1ob21lUGFnZUFURg

Step 4: Get all values whitelisted for reporting

The values that you pass as cust-params with your Unique Link need to be whitelisted by our team so that they can be made available to you on the Gamezop Business Dashboard and on the Ad Revenue Reports API.

Make a list of all the possible values you may send in the cust-params URL parameter, and send it to your Gamezop Account Manager so that they can be whitelisted.

Keep in mind that you will need to send the decoded values to our team for whitelisting.

---

Tracking revenue

After your tracking values have been whitelisted by our team, you can start sending traffic to your Unique Links with the cust-params URL parameter.

We allow you to track your revenue numbers in 2 ways:

• Ad Revenue Reports API: Ensure you use the caap breakdown while making the API request.

• Gamezop Business Dashboard: In the Revenue Reports section, you can apply CAAP as a breakdown to your revenue data.

---

Product compatibility

CAAP works seamlessly with all Zop products.

---

Important caveat

We use a mix of several different sources for ad-monetisation. For CAAP to work, each of these ad networks would need to support such granular reporting, which is not the case. As a result, the total revenue you make on your Property ID may be greater than the total revenue attributed to your CAAP values.

This difference arises from those revenue sources of ours which do not support such granular reporting. We suggest that you do a pro-rata distribution of this difference amount among your CAAP values in the proportion of their attributed revenues.