Ad Events
Ad events are used to track player interactions with ads (e.g. impressions, clicks) and include placement, format and performance data. These events are essential for analyzing ad engagement and performance.
info
These events must be manually implemented. Refer to the SDK Documentation for code examples specific to your platform (Unity, Unreal, Roblox, iOS, Android, etc.).
Ad Event Fields
| Field | Description | Type | Possible Values | Required |
|---|---|---|---|---|
| category | Event category | string | ads | Yes |
| ad_sdk_name | Name of the ad provider | string | Any string, lowercase with no spaces or underscores (e.g. applovin, admob) | Yes |
| ad_placement | Placement/identifier of the ad within the game | string | Any string, max 64 characters (e.g. end_of_game) | Yes |
| ad_type | Type of ad | string | video, rewarded_video, playable, interstitial, offer_wall, banner | Yes |
| ad_action | The action made in relation to the ad | string | clicked, show, failed_show, reward_received | Yes |
| ad_fail_show_reason | The reason why the ad failed to show | string | unknown, offline, no_fill, internal_error, invalid_request, unable_to_precache | No |
| ad_duration | The duration in milliseconds that the ad was shown for | long | Example: 3500 (in milliseconds = 3.5 seconds) | No |
| ad_first | The field can be added if this is the first ad to be shown for the user | boolean | true, false | No |
Ad Event Examples
| Field | Example A A user is shown an interstitial ad for the first time | Example B A user clicks a rewarded video ad | Example C A banner ad failed to show |
|---|---|---|---|
| category | ads | ads | ads |
| ad_sdk_name | admob | fyber | ironsource |
| ad_placement | end_of_level | ad_for_coins | during_level |
| ad_type | interstitial | rewarded_video | banner |
| ad_action | show | clicked | failed_show |
| ad_fail_show_reason | – | – | no_fill |
| ad_duration | 5000 | 6000 | – |
| ad_first | true | – | - |