Integrate Impression-Level Revenue Data
Before you begin
- Make sure you have integrated OpenMediation Cocos Package v2.1.0 or higher.
- Make sure you have integrated OpenMediation Android or iOS SDK v2.1.0 or higher.
ILRD Data
The ILRD Data is returned as part of the ImpressionData object. Here’s a list of the relevant data fields, including description and type.
Field Name | Datatype | Description |
---|---|---|
impression_id | String | A unique ID for each impression |
instance_id | String | Identifier per network, this includes the ad network’s instanceID/placement/zone/etc. |
instance_name | String | The ad network instance name as defined on the platform |
instance_priority | Integer | The instance priority in mediation rule |
ad_network_name | String | The ad network name that served the ad |
ad_network_unit_id | String | The ad unit displayed (Rewarded Video/Interstitial/Banner/Native/Splash/Cross Promote) |
mediation_rule_id | String | The id of mediation rule |
mediation_rule_name | String | The name of mediation rule |
mediation_rule_type | String | The type of mediation rule: Manual or Auto |
mediation_rule_priority | Integer | The priority of mediation rule |
placement_id | String | Ad Placement ID |
placement_name | String | Ad Placement Name |
placement_ad_type | String | Ad Placement Type: Banner/Native/Rewarded Video/Interstitial/Splash/CrossPromote |
scene_name | String | Scene Name, null for Banner/Native/Splash |
currency | String | Is always "USD" |
revenue | Double | The revenue generated for the impression (USD). The revenue value is either estimated or exact, according to the precision (see precision field description) |
precision | String | The source value of the revenue field: undisclosed - non-public data, for example, FAN requires not to store revenue data exact - exact value, generally the benefit brought by in-app bidding type instance estimated - estimated value, estimated from the historical income data of ordinary instance |
ab_group | String | Indication if A/B test was activated via platform |
lifetime_value | Double | The accumulated value of the user ad revenue |
Implement the ImpressionData Listener
The OpenMediation SDK fires post backs to inform you about the displayed ad. The ImpressionData listener is an optional listener that you can implement to receive impression data. This listener will provide you with information about all ad units, and you’ll be able to identify the different ads using the ILRD data itself.
If you want to add the ImpressionData listener to your application, make sure you declare the listener before initializing the OpenMediation SDK, to avoid any loss of information.
The OpenMediation SDK will notify your listener of the success post-backs, related to impression data. The onImpressionDataCallback is described below:
onLoad: function () {
OpenMediation.Ads.setListener({
onImpressionDataError: function (msg) {
self.log('OpenMediation onImpressionDataError:' + msg);
},
onImpressionData: function (msg) {
self.log('OpenMediation onImpressionData:' + msg);
},
}
}
Note: You need to enable the ILRD function in the OpenMediation dashboard before you can receive the onImpressionData event, otherwise you will receive the onImpressionDataError event.
Comments
Please sign in to leave a comment.