AIR API Overview
What is AIR?
Aggregated Impression Revenue (AIR) provides you with aggregated data on impression performance, allowing you to better understand different cohorts of impressions. The API provides the information you need to measure ROAS (Return on Ad Spend).
You must be using Audience Network SDK version 6.2 or later to use AIR API. If you are using an earlier version of the SDK, consult with your mediation partner to see if they support AIR.
How Does it Work?
AIR API provides a new Audience Network field: encrypted CPM. The diagram above illustrates the process of gathering Encrypted CPMs, and how the AIR API is called. As a publisher:
- You store the encrypted CPM against a chosen identifier. This can be any identifier that you can create or access, for example gender, country, campaign level and so on.
- An aggregated set of encrypted CPMs is created at impression event callback, and the AIR API is called. This step requires a minimum of 500 different valid impressions.
- Audience Network responds with aggregated revenue result (in USD) corresponding to the list of encrypted CPMs passed in the AIR API request.
You need to subscribe to Audience Network impression events to access the API. Go to Client Side Integration for details.
Constraints
- Minimum 500 encrypted CPMs which resulted in impressions.
- Maximum 3000 encrypted CPMs which resulted in impressions.
- A single encrypted CPM can only be queried 10 times in total.
- All encrypted CPMs in a request must be within one 24 hour window (it doesn’t have to be the last 24 hours).