Iframe Events
Advertisers are able to track events in their Ads. These events are programmatically managed directly in the client browser with the help of JavaScript.
Events
creativeDisplayed
Note: This is only available for Desktop Fullpage Interstitial and Mobile Fullpage Interstitial (DFI/MFI) Ad Format campaigns with iframe URL variation.
When the ad is displayed to the user, a message is sent into the iframe called creativeDisplayed
.
You can track this event inside your iframe by using the script below, which adds an event listener to catch the sent message once the ad is displayed to the user.
<script>
function readMessage(event) {
console.log("readMessage event");
console.log("origin: " + event.origin);
console.log("data: " + event.data);
}
if (window.addEventListener) {
// For standards-compliant web browsers
window.addEventListener("message", readMessage, false);
} else {
window.attachEvent("onmessage", readMessage);
}
</script>
Example - Fullpage Interstitial
<!DOCTYPE html>
<html>
<head>
<!-- EVENT PART -->
<script>
function readMessage(event) {
console.log("readMessage event");
console.log("origin: " + event.origin);
console.log("data: " + event.data);
var message = "We got message: '" + event.data + "' from '" + event.origin + "' (we are on advertiser iframe now)";
console.log(message);
document.getElementById("received-message").innerHTML = message; // ie advertiser wants to update some element
}
if (window.addEventListener) {
// For standards-compliant web browsers
window.addEventListener("message", readMessage, false);
} else {
window.attachEvent("onmessage", readMessage);
}
</script>
<!-- END OF EVENT PART -->
</head>
<body>
<h1>My test iframe heading</h1>
<p>My test iframe paragraph</p>
<p id="received-message">Waiting for the message</p>
</body>
</html>