Jump to: Collecting Cost Data when Measuring Clicks | Collecting Cost Data when Measuring Impressions | Macros for Dynamic Insertion or Manually Set | Costing Scenarios | Case 1 | Case 2 | Case 3 | Case 4 | Case 5 | Case 6 | Case 7 | Case 8 | Case 9
The TUNE Measurement API supports two required parameters when measuring ads to collect cost data dynamically. Working with us to collect cost data is a requirement by our clients. Cost data enables us to provide cost reconciliation and return-on-investment (ROI) analysis.
Collecting Cost Data when Measuring Clicks
When measuring clicks, these are the required parameters that need to be included:
- cost_model – predefined values of one of these supported models that you use to bill clients for their marketing campaigns:
- cpc – Cost per Click
- cpi – Cost per Install
- cpa – Cost per Action
- cpo – Cost per Open
- cost – Amount of cost formatted as float. Supports 5 decimal places. Must be in USD.
Example Measurement URL for a Click when you charge client on CPC basis at a rate (bid won) of $0.01 per click:
http://publisher_id.api-01.com/serve?action=click&publisher_id=19228&site_id=15284&cost_model=cpc&cost=0.01
Collecting Cost Data when Measuring Impressions
When measuring impressions, these are the required parameters that need to be included:
- cost_model – predefined values of one these supported models you use to bill clients for their marketing campaigns:
- cpv – Cost per View (Impression)
- cpm – Cost per 1000 Impressions
- cpi – Cost per Install
- cpa – Cost per Action
- cpo – Cost per Open
- cost – Amount of cost formatted as float. Supports 5 decimal places. Must be in USD.
Example Measurement URL for an Impression when you charge client on CPM basis at rate (bid won) of $0.15 per 1000 impressions:
http://publisher_id.api-01.com/serve?action=impression&publisher_id=19228&site_id=15284&cost_model=cpm&cost=0.15
Macros for Dynamic Insertion or Manually Set
The values of the cost_model
and cost
parameters can both by set dynamically using macros. If you platform doesn’t support macros, then you can manually set the parameters.
For example, your platform supports the macro %cost_model% for our cost_model parameter and %cost% for the amount of the cost. Our platform would generate a measurement URL for clicks mapping your macros to our parameters:
http://publisher_id.api-01.com/serve?action=click&publisher_id=19228&site_id=15284&cost_model=%cost_model%&cost=%cost%
If the cost model was CPC and the amount you charged client for click was $0.01 then you’d actually notify the URL with your macros replaced:
http://publisher_id.api-01.com/serve?action=click&publisher_id=19228&site_id=15284&cost_model=cpc&cost=0.01
If you don’t have a macro for the cost model and you only have one model for all clients you work with, then you can manually set the value as part of the integration.
For example, if you only work on a CPI basis, then our cost_model parameter could be hardcoded to cost_model=cpi while the cost amount could still be set dynamically with your macro:
http://YOUR_PUBLISHER_ID.api-01.com/serve?action=click&publisher_id=19228&site_id=15284&cost_model=cpi&cost=%cost%
Costing Scenarios
To provide further insight on how we calculate cost based on the values set with cost_model and cost, consider the following scenarios.
Case 1
If the Measurement API responded to the following requests:
Measure | cost_model | cost |
impression | cpm | 2.00 |
The Measurement API calculates cost accordingly:
Measure | Cost |
Impressions | $0.002 |
Case 2
If the Measurement API responded to the following requests:
Measure | cost_model | cost |
impression | cpv | 0.05 |
The Measurement API calculates cost accordingly:
Measure | Cost |
Impressions | $0.05 |
Case 3
Publisher setting of Impression Attribution View Percentage of 50%. If the Measurement API responded to the following requests:
Measure | cost_model | cost | view_percent |
impression | cpv | 0.05 | 75 |
Since the view_percent of 75% is greater than equal to 50%, the Measurement API calculates cost accordingly:
Measure | Cost |
Impressions | $0.05 |
Case 4
Publisher setting of Impression Attribution View Percentage of 50%. If the Measurement API responded to the following requests:
Measure | cost_model | cost | view_person |
impression | cpv | 0.05 | 25 |
Since the view_percent of 25% is less than equal to 50%, the Measurement API calculates cost accordingly:
Measure | Cost |
Impressions | $0.00 |
No cost since user didn't reach impression attribution view percentage.
Case 5
If the Measurement API responded to the following requests:
Measure | cost_model | cost |
click | cpc | 0.50 |
The Measurement API calculates cost accordingly:
Measure | Cost |
Clicks | $0.50 |
Case 6
If the Measurement API responded to the following requests:
Measure | cost_model | cost |
impression | ||
click | cpi | 2.50 |
install |
The Measurement API calculates cost accordingly since cost from click applied to install due to click-through conversion:
Measure | Cost |
Impressions | $0.00 |
Clicks | $0.50 |
Installs | $2.50 |
Case 7
If the Measurement API responded to the following requests:
Measure | cost_model | cost |
impression | ||
click | cpa | 2.50 |
install |
Since CPA functions the same as CPI, the Measurement API calculates cost accordingly:
Measure | Cost |
Impressions | $0.00 |
Clicks | $0.50 |
Installs | $2.50 |
Case 8
If the Measurement API responded to the following requests:
Measure | cost_model | cost |
impression | cpi | 1.50 |
click | ||
install |
The Measurement API calculates cost accordingly since cost from impression applied to install due to view-through conversion:
Measure | Cost |
Impressions | $0.00 |
Clicks | $0.50 |
Installs | $1.50 |
Case 9
If the Measurement API responded to the following requests:
Measure | cost_model | cost |
impression | ||
click | cpo | 0.75 |
open |
The Measurement API calculates cost accordingly since cost from click applied to open due to click-through conversion:
Measure | Cost |
Impressions | $0.00 |
Clicks | $0.50 |
Opens | $2.50 |