Ad Builder User Guide

Ad Builder Introduction

The AdServing Factory Ad Builder is designed to help graphic designers, HTML coders and ad operations professionals prepare HTML5 creatives to be ad served into AdUnity/AdServing Factory/SSP/AUX systems.

The main purpose of this document is to describe the features and templates available in the AdServing Factory Ad Builder. Within the Ad Builder we have also included the AdServing Factory JavaScript Bridge feature which is a JavaScript library that makes available a wide set of accessors, events and methods for programmatically determined ad control and interaction.

This document assumes an intermediate understanding of HTML and JavaScript.

Before You Start

Before the AdServing Factory Ad Builder is used several important issues need to be considered to avoid common user errors. To make things easier we have created a check list to avoid these common mistakes. In addition we have also provided special guidance on file naming, ads with multiple components and ads with external resources. AdServing Factory also recommends that Ad Builder users read the Glossary of Advanced Features to get the most out of the Ad Builder.

IMPORTANT: Basic Checklist

Before starting the integration process please check the following:

  1. Make sure the ad HTML file renders properly in your browser.
  2. Make sure all the resources included in the ad HTML file (stylesheets, scripts, images, fonts etc.) are present.
  3. Always validate the HTML code (e.g. https://validator.w3.org/) and make sure there aren’t any unsupported HTML5 features or non-cross-browser scripts/techniques used in the code.
  4. Read the File Naming section below if a third-party tool is used to create the ad and is being imported into the AdServing Factory Ad Builder.
  5. If you are creating an ad with multiple components read the Ads With Multiple Components? section below.
  6. If you are creating an ad utilising external resources read the External Resources? section below.
  7. Make sure you are not importing resources that are not used within the ad (e.g. the .psd file from which the adwas generated or the __MACOSX folder). Try to minimize each resource file and keep the HTML code as simple as possible, up to at most 10,000 characters.
  8. Please note that if using window.clickTag in your creative as the variable containing the landing page (i.e. as instructed in Google Web Designer), the ad will work without any other modification. Otherwise, the minimum change needed will be the usage of the AUTHML5.Click() method for setting the landing page.

IMPORTANT: File Naming

(Only applies when importing archive from third-party ad creator tool. e.g. Adobe Animate, Google Web Designer, etc.)

If user is using the AdServing Factory Ad Builder to create the ad from scratch, this section can be skipped.

If user is using a third-party tool and wants to import an ad (that consists of multiple resources) into the Ad Builder through the means of an archive then please follow the naming rules below.

Before archiving the ad files and resources, to automatically read and load the banner HTML code into the appropriate control in the AdServing Factory Ad Builder, make sure that the ad HTML file is named index.html. If the ad consists of multiple components (i.e. a three-component branding banner or an in-page banner with an over-the-page component), the main component file must be named index.html and the rest index1.html, index2.html etc. (e.g. top component – index.html, left component – index1.html and right component – index2.html). However, if the naming convention is not used, the html component file(s) will be present in the “Additional files” section in the ad page, after importing the archive.

For a faster and more convenient integration, there is an option of importing the whole ad (including all its resources and folders, if any) as a zip archive.

Ads With Multiple Components?

If the ad consists of multiple components (e.g. a three-component branding ad or an in-page ad with an over-the-page component), check each individual file to follow all the rules in this section. If interaction between components is intended (i.e. synchronous animation between all components), make sure that there’s an initiating function of said interaction that can be called in each component (i.e. a JavaScript function startAnimation).

Ads With External Resources?

If resources are being loaded from external sources (e.g. the jQuery library from https://code.jquery.com/jquery-1.12.3.min.js), make sure those sources are reliable and they provide a minified version, if possible. Also, to prevent protocol mismatch, make sure the external source is available on both http and https protocols and include the resource using the Uri scheme as in the adiacent example:

Include the external resource using the Uri scheme:


<script src="//code.jquery.com/jquery-1.12.3.min.js"></script>
            

If the external source is unreliable or does not support both http and https protocols, download it and add it directly in the ad “Additional files” and include it in your HTML code from a relative path.

Glossary of Advanced Features

Viewability Tools and Measurement: In-View and In-View Activation

The AdServing Factory Ad Builder has some of the industry’s most powerful tools to define and measure viewability. The AdServing Factory Ad Builder allows viewability to be measured and be used to control ad activation (i.e. displaying the ad for the first time) to provide assurance to clients that the ad was viewed. Viewability does not just have to mean whether an ad is in the viewport, but it can also depend if it is in an active browser window. These effective new features are explained below:

In-View Ad: This concept relates to the percentage of the ad’s area in the viewport (i.e. the part of the browser window that is viewable on the device screen). In the terminology of the AdServing Factory Ad Builder, this is referred to as Viewability. As in the accessor AUHtml5.Ad.ViewPercentage and the event AUHtml5.OnViewabilityChange (which is an event that is triggered every time the page changes its In-View status).

In-View Page: This concept relates to whether the ad is shown in an active (in-focus) browser window or not (e.g. if the user opens a new tab and the ad is no longer in the active tab). In the terminology of the AdServing Factory Ad Builder, this is referred to as Visibility. As in the accessor AUHtml5.Page.IsVisible and the event AUHtml5.OnVisibilityChange (which is an event that is triggered every time the page changes its In-View status). This Visibility concept is particularly important for video or animated ads (in-stream or out-stream) where it only makes sense to start the video ad when the browser window is active (in-focus); and to pause the ad when it is no longer active (in-focus).

In-View Activation: This concept relates to the first time the ad is shown in the page. Only if the InView Minimum Viewability ad setting is met for the amount of time (in seconds) defined in the In-View Activation Time ad setting (e.g. a billboard ad could meet the IAB viewability standard and be activated if its visible area is at least 30% for at least 1 second) will the ad be counted to have been In-View.

Smart Ad Counting: Trackmode

Track Mode provides a sophisticated new option for counting ad delivery by user defined viewability thresholds. This is best described by defining two concepts for counting ads: Ad Initialisation and Ad Activation.

Ad Initialisation is when an ad is served to by the ad server to the browser window (whether the ad is in-view or not). This is typically how ads are counted.

Ad Activation is when an ad has passed the threshold of viewability by having defined minimum percentage of the ad (e.g. 50%) is in the viewport of the browser for a defined amount of time (e.g. 1 second). Therefore, for example, if the Minimum Viewability ad setting is set to 50% and the In-view Activation Time setting is set to 1 second, then if a minimum of 50% of an ad is shown for 1 second it is validated as being activated. If it does not pass this dual threshold it is not validated and is not counted as activated.

Track Mode allows ads to be counted upon activation (user defined viewability measure) and not just upon initialisation (basic/standard measure i.e. not measured by viewability).

Please note that using Track Mode to count ad activation is an additional measure and that the AdServing Factory ad server will always count ad initialisations in the standard way.

AdServing Factory JavaScript Bridge (AUHtml5)

The AdServing Factory JavaScript Bridge is a powerful feature of the Ad Builder that provides all the necessary tools to reliably count ad delivery and track all and any interactions (e.g. impressions, play video, expand, collapse, etc.).

Version Release date Release notes
1.0 19.11.2015 Initial release
1.1 25.02.2016 Added the Track Mode ad setting and the AUHtml5.CanvasPlayer utility method
1.2 23.06.2016 Added the AUHtml5.Device and AUHtml5.User accessors
1.3 24.11.2016 Added the AUHtml5.OnInitAll and AUHtml5.OnMessage events and the AUHtml5.SendMessage method
1.4 04.05.2017 Support for SafeFrames API. New Templates for Third Party. Enhanced support for Rich-Media HTML5 Creatives.

Accessors

All accessors are available only after the AUHtml5.OnInit event has been triggered. The AUHtml5.Ad and AUHtml5.Page accessors will change some of their properties over the ad’s life time, depending on user interaction with the page or the ad itself.

AUHtml5.Ad

This accessor describes the ad and its settings. In the case of a multi-component ad (e.g. a three-component branding), the accessor will describe its corresponding component.

The following properties do not change over the ad’s life time:

AUHtml5.Page

This accessor describes the page the ad is delivered to. In the case when the ad is delivered in an iframe, excepting the properties Url and Referrer, the accessor’s properties will refer to the iframe.

The following properties do not change over the ad’s life time:

The following properties will change depending the various states the page is in (e.g. content changed, page scrolled or browser window being resized):

AUHtml5.Device

This accessor describes the device on which the ad is displayed, based on the browser user-agent and video capabilities.

AUHtml5.User

This accessor describes the user/visitor for whom the ad was delivered.

AUHtml5.Version

This accessor reveals the current AdServing Factory JavaScript Bridge version. Please consult the documentation corresponding to the appropriate version

Events

Events provide the means to access and consult the ad accessors and, depending on ad type, they also handle communication between its components.

AUHtml5.OnInit

This event is triggered only once, after the DOM ready event of the ad component page is consumed and the ad is properly initialised in the page. At this point all the ad’s accessors are available and ready to consult.

AUHtml5.OnInit


AUHtml5.OnInit = function () {
 //e.g. initialize ad resources, preload or prefetch images etc.
}; 
            

AUHtml5.OnInitAll

This event is available only for multi-component ads (e.g. a three-component branding) and it’s triggered only once, after all its components are properly initialised in the page. At this point it’s possible to send messages between components. Please note that in the case of single-component ads (e.g. in-page html) this event will never be triggered.

AUHtml5.OnInitAl


AUHtml5.OnInitAll = function () {
 //e.g. send messages between components to synchronize animation start
};  
            

AUHtml5.OnViewabilityChange

This event is triggered after the ad or ad component initialisation, and every time there is a change with its viewability property (e.g. ad is scrolled in or out of view or browser is resized). Also, in the case of responsive-design ads, after the first trigger, consult the AUHtml5.Ad.Width and AUHtml5.Ad.Height to properly determine the actual dimensions of the ad.

AUHtml5.OnViewabilityChange


AUHtml5.OnViewabilityChange = function () {
 //e.g. consult AUHtml5.Ad.ViewPercentage and stop animation if the value is below the value of AUHtml5.Ad.ViewThreshold
}; 
            

AUHtml5.OnVisibilityChange

This event is triggered every time the page changes its Active In-View status (e.g. the browser window is minimized or the tab is changed).

AUHtml5.OnVisibilityChange


AUHtml5.OnVisibilityChange = function () {
 //e.g. stop the animation if the AUHtml5.Page.IsVisible is false
}; 
            

AUHtml5.OnStateChange

This event is triggered every time there’s an ad state change (e.g. when the ad is being displayed, expanded, collapsed or closed).

AUHtml5.OnStateChange


AUHtml5.OnStateChange = function () {
 //e.g. consult AUHtml5.Ad.State and start the animation when the value is equal to "DISPLAYED"
}; 
            

AUHtml5.OnMessage

This event is triggered every time a message is received from a different components (e.g. the “top” component in a three-component branding had sent a “synchronize request” to the “left” component). Please note that in the case of single-component ads (e.g. in-page html) this event will never be triggered

AUHtml5.OnMessage


AUHtml5.OnMessage = function (msg) {
 //e.g. consult the msg parameter to find out the actual message
}; 
            

Methods

Methods provide the means to interact with the ad or ad components programmatically. Please note that methods can be used both in the JavaScript code and in the HTML code, as seen in the examples below.

AUHtml5.Click([Uri])

This method should be used to perform the click-to-action and properly record it in the ad server. If the method is used without the optional Uri parameter, the click-to-action will use the “Destination Click URL” set up in the ad settings. If the method is used with the Uri parameter, the click-to-action will use it as the click-to-action (e.g. AUHtml5.Click('http://www.domain.com/landing-page') will open and properly record the Uri). Please note that the click-to-action Uri is also available in the window.clickTag value in the ad page.


function myFunction () {
 AUHtml5.Click();
};
            

<div onclick="AUHtml5.Click()">Click me</div> 
            

AUHtml5.ClickWithReference([Uri], Reference)

This method should be used to perform the click-to-action and properly record it in the ad server along with a specific reference. This method is useful when there's a need to differentiate clicks made on various parts or sections of the creative. If the method is used without the optional Uri parameter, the click-to-action will use the “Destination Click URL” set up in the ad settings. If the method is used with the Uri parameter, the click-to-action will use it as the click-to-action (e.g. AUHtml5.Click('http://www.domain.com/landing-page', 'my-reference') will open and properly record the Uri).


function myFunction () {
 AUHtml5.ClickWithReference('my-reference');
};
            

<div onclick="AUHtml5.ClickWithReference('my-reference')">Click me</div> 
            

AUHtml5.Expand()

This method should be used to instruct the expand command for the ad. Please note that the command will be ignored for ads not configured as expandable, configured for “MOUSE-INTERACTION” expansion or when the ad is already in “EXPANDED” ad state.

AUHtml5.Expand()


function myFunction () {
 AUHtml5.Expand(); 
};
            

<div onclick="AUHtml5.Expand()">Click me to expand the ad</div>

AUHtml5.Collapse()

This method should be used to instruct the collapse command for the ad. Please note that the command will be ignored for ads not configured as expandable, configured for “MOUSE-INTERACTION” expansion or when the ad is already in “COLLAPSED” ad state.

AUHtml5.Collapse()


function myFunction () { 
 AUHtml5.Collapse(); 
};
            

<div onclick="AUHtml5.Collapse()">Click me to collapse the ad</div>
            

AUHtml5.Close()

This method should be used to instruct the close command for the ad and as result will hide the ad completely.

AUHtml5.Close()


function myFunction () {
 AUHtml5.Close(); 
};
            

<div onclick="AUHtml5.Close()">Click me to hide the ad</div> 
            

AUHtml5.RecordAction(action)

This method should be used to record specific ad interaction actions. Some actions, like “EXPAND” AND “COLLAPSE”, are automatically recorded. All the recorded actions are available in the ad server, in the appropriate reporting area for the campaign to whom the ad belongs.

AUHtml5.RecordAction(action)


function myFunction () {
 AUHtml5.RecordAction('MY_ACTION');
};
            

<div onclick="AUHtml5.RecordAction('MY_ACTION')">My Action</div>
           

AUHtml5.SendMessage(to, msg)

This method should be used to communicate between different ad components. Please note that in the case of singlecomponent ads (e.g. in-page html) this command will be ignored.

AUHtml5.SendMessage(to, msg)


function myFunction () {
 AUHtml5.SendMessage('top', {'param1':'value1', 'param2':'value2'});
};
            

<div onclick="AUHtml5.SendMessage('top', {'param1':'value1', 'param2':'value2'})">Send message to top component</div> 
            

Utilities

AUHtml5.CanvasVideo(videoElement)

This utility method creates a very light canvas-based video player, mimicking the video element provided through the parameter videoElement. The main feature of this video player is its ability to play video in-line on non-supporting devices (e.g. Apple iPhone prior iOS 10).

Ad Templates

Rich-Media HTML5 In-Page Ad

Ads created from this template consist of an in-page component with support for responsive design, reactive to its content and the page viewport. The template provides in-view activation features and expandability options.

rich media html5 in page ad

Ad parameters for this template are as follows:

HTML Code - The markup corresponding to the ad component.

Destination click URL - the landing page Uri for the ad’s click-to-action.

Render Mode - Use Responsive rendering only if your HTML markup supports responsive design.

Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only).

Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only).

Expand Direction - Ad expansion policy (main). Ignored for non expandable and push expansion rendering.

Expand Alignment - Ad expansion policy (secondary). Ignored for non expandable and push expansion rendering.

Expand Auto-Adjustment: Viewport automatically adjustment policy. Ignored for non expandable and push expansion rendering.

Expanded Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only). Ignored for non expandable rendering.

Expanded Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only). Ignored for non expandable rendering

In-view Activation - Ad display policy based on viewability.

Minimum Viewability - Minimum threshold for the viewable part of the ad. This value is used in conjunction with In-view Activation display policy.

Track Mode - Ad Impression execution policy. This setting is used in conjunction with In-view Activation display policy.

Error Handling - Passback and Clear container error handling will apply only if there is a critical error with the markup. If there is a successful rendering, the impression will be tracked.

Additional notes for this template

Render mode:

  • Strict Size (non expandable) - The creative has a strict size without the possibility of expanding. The Width and Height parameters are used to set the rendering width and height of the creative.
  • Strict Size (push expansion) - The creative is rendered with a strict size with the possibility of expanding. The Width and Height parameters set the initial ad size while the Expanded Height and Expanded Width set the width and height values for the expanded state. The creative expands by pushing the page content.
  • Strict Size (overlayer expansion) - The creative is rendered with a strict size with the possibility of expanding. The Width and Height parameters set the initial ad size while the Expanded Height and Expanded Width set the width and height values for the expanded state. The creative expands by overlaying the page content.
  • Responsive (non expandable) - The creative is rendered with a size set by the HTML markup without the possibility of expanding. The code must be Responsive design compliant. Both the Width and Height parameters act as max-width and max-height limits for the creative. Setting their values to 0 defaults the template to a 100% width and height value of the rendering container.
  • Responsive (push expansion) - The creative is rendered at a size set by the HTML markup with the possibility of expanding by pushing the content. The code must be Responsive Design compliant. Both the Width and Height parameters act as max-width and max-height limits for the creative. Setting their values to 0 defaults the template to a 100% width and height value of the rendering container.
  • Responsive (overlayer expansion) - The creative is rendered at a size set by the HTML markup with the possibility of expanding by overlaying the content. The code must be Responsive Design compliant. Both the Width and Height parameters act as max-width and max-height limits for the creative. Setting their values to 0 defaults the template to a 100% width and height value of the viewport.

When set to Yes, the Expand Auto-Adjustment parameter keeps the creative in-view when the page is scrolled until the rendering container is out of the viewport. It only applies to its expanded overlayer state.

Expand Direction and Expand Alignment are used only for overlaying render modes. Setting the Expand Direction to All directions and the Expand Alignment to Center will expand the ad in all directions equally from the center of the rendering container. Setting for example the Expand Direction to Right and the Expand Alignment to Top/Left will stick the ad to both the top and left of the rendering container and expand the ad to the right. Using the same Expand Alignment but with a Left Expand Direction will only stick the ad to the top position of the rendering container and expand the ad to the left. The two settings work in conjuncture.

Setting the In-view activation to Yes will require setting a Minimum Viewability value. This threshold sets the minimum percentage of the ad needed to be in the viewport for the ad to render.

If Track Mode is set to On Ad Initialization, the tracking will take place when the page is loaded and the ad initialized. Using the On Ad Display Tracking Mode requires that both the In-view Activation and Minimum Viewability are set. This way, the tracking takes place when the ad enters the active viewport.

Branding HTML5 In-Page Ad

Ads created from this template consist of three components, one in the middle being an in-page component (“top”) and two on each side being over-the-page components (“left” and “right”). By default, the side components are aligned to create a reversed U figure, but this can be easily changed through the ad’s settings. For the top component, there is support for responsive design, reactive to its content and the page viewport, in-view activation and expandability options.

Branding html5 in page ad

Ad parameters for this template are as follows:

Top HTML Content - The markup corresponding to the top ad component.

Top Render Mode - Use Responsive rendering only if your HTML markup supports responsive design.

Top Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only).

Top Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only).

Top Expand Direction - Ad's top component expansion policy (main). Ignored for non expandable and push expansion rendering.

Top Expand Alignment - Ad's top component expansion policy (secondary). Ignored for non expandable and push expansion rendering.

Top Expanded Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only). Ignored for non expandable rendering

Top Expanded Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only). Ignored for non expandable rendering

Left HTML Content - The HTML corresponding to the left ad component.

Left Width - Fixed Width for strict size rendering or, when using value 0, the total distance between the left browser edge and left edge of the top component.

Lefth Height - Fixed Height for strict size rendering or, when using value 0, the Viewport Height.

Left Horizontal Offset - Offset adjustment of the horizontal position in relation to the top component's left edge.

Left Vertical Offset - Offset adjustment of the vertical position in relation to the top component's top position in page.

Right HTML Content - The HTML corresponding to the right ad component.

Right Width - Fixed Width for strict size rendering or, when using value 0, the total distance between the right edge of the top component and right browser edge.

Right Height - Fixed Height for strict size rendering or, when using value 0, the Viewport Height.

Right Horizontal Offset - Offset adjustment of the horizontal position in relation to the top component's right edge.

Right Vertical Offset - Offset adjustment of the vertical position in relation to the top component's top position in page.

Destination click URL - The landing page Uri for the ad’s click-to-action.

In-view Activation - Ad display policy based on viewability.

Minimum Viewability - Minimum threshold for the viewable part of the ad. This value is used in conjunction with In-view Activation display policy.

Sticky Side Components - Ad policy regarding keeping the side components in viewport when scrolling.

Track Mode - Ad Impression execution policy. This setting is used in conjunction with In-view Activation display policy.

Error Handling - Passback and Clear container error handling will apply only if there is a critical error with the markup. If there is a successful rendering, the impression will be tracked.

Additional notes for this template

Top Render mode:

  • Strict Size (non expandable) - The creative's top component has a strict size without the possibility of expanding. The Top Width and Top Height parameters are used to set the rendering width and height of the creative's top component.
  • Strict Size (push expansion) - The creative's top component is rendered with a strict size with the possibility of expanding. The Top Width and Top Height parameters set the initial ad's top component size while the Top Expanded Height and Top Expanded Width set the width and height values for the top component's expanded state. The ad's top component expands by pushing the page content.
  • Strict Size (overlayer expansion) - The creative's top component is rendered with a strict size with the possibility of expanding. The Top Width and Top Height parameters set the initial ad's top component size while the Top Expanded Height and Top Expanded Width set the width and height values for the top component's expanded state. The ad's top component expands by overlaying the page content in the direction set by the Top Expand Direction in conjucture with the Top Expand Alignment parameter.
  • Responsive (non expandable) - The creative's top component is rendered with a size set by the HTML markup without the possibility of expanding. The code must be Responsive design compliant. Both the Top Width and Top Height parameters act as max-width and max-height limits for the creative's top component. Setting their values to 0 defaults the template's top component to a 100% width and height value of the rendering container.
  • Responsive (push expansion) - The creative's top component is rendered at a size set by the HTML markup with the possibility of expanding by pushing the content. The code must be Responsive Design compliant. Both the Top Width and Top Height parameters act as max-width and max-height limits for the creative's top component. Setting their values to 0 defaults the template's top component to a 100% width and height value of the rendering container. The ad's top component expands by pushing the page content.
  • Responsive (overlayer expansion) - The creative's top component is rendered at a size set by the HTML markup with the possibility of expanding by overlaying the content. The code must be Responsive Design compliant. Both the Top Width and Top Height parameters act as max-width and max-height limits for the creative's top component. Setting their values to 0 defaults the template's top component to a 100% width and height value of the viewport. The ad's top component expands by overlaying the page content in the direction set by the Top Expand Direction in conjucture with the Top Expand Alignment parameter.

Top Expand Direction and Top Expand Alignment are used only for overlaying render modes. Setting the Top Expand Direction to All directions and the Top Expand Alignment to Center will expand the ad's top component in all directions equally from the center of the rendering container. Setting for example the Top Expand Direction to Right and the Top Expand Alignment to Top/Left will stick the ad's top component to both the top and left of the rendering container and expand the ad's top component to the right. Using the same Top Expand Alignment but with a Top Expand Direction set to Left will only stick the ad's top component to the top position of the rendering container and expand the component to the left. The two settings work in conjuncture.

The left component of the ad is positioned relative to the top one. The left component's top side is aligned with the top component's top while the left component's right side is attached to the top component's left side. Using a positive value for the Left Horizontal Offset parameter will offset the left component to the right while a negative value will offset it to the left. Using a positive value for the Left Vertical Offset will offset the left ad component to the bottom while a negative one will offset it to the top. The right component of the ad is positioned relative to the top one aswell. The Right component's left side is attached to the top component's right side. The same rules apply when offseting the right component as for the left one.

Setting the In-view activation to Yes will require setting a Minimum Viewability value. This threshold sets the minimum percentage of the ad needed to be in the viewport for the ad to render.

If Track Mode is set to On Ad Initialization, the tracking will take place when the page is loaded and the ad initialized. Using the On Ad Display Tracking Mode requires that both the In-view Activation and Minimum Viewability are set. This way, the tracking takes place when the ad enters the active viewport. Not setting the two parameters and setting the Track Mode to On Ad Display, will track the ad on initialization.

Third Party HTML In-Page-Ad

Ads created from this template are suited for delivering third party markup (agency adtag, publisher custom code, etc) that it's rendered into the publisher's website.

html5 in-page ad

HTML Code - The third party markup corresponding to the ad component.

Render Mode - Use Direct rendering if you fully trust the markup source (it may change/break the website). Use FriendlyFrame rendering for full HTML markup or to isolate it from the website. Use SafeFrame rendering to isolate the markup from the website completely.

Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for Direct and FriendlyFrame responsive rendering only).

Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for Direct and FriendlyFrame responsive rendering only).

Error Handling - Passback and Clear container error handling will apply only if there is a critical error with the markup. If there is a successful rendering, the impression will be tracked.

Additional notes for this template

Render mode:

  • Directly into page (strict size) - The third party code comes from a safe source (direct campaign, publisher code, etc) and renders at a fixed size.
  • Directly into page (responsive) - The third party code comes from a safe source (direct campaign, publisher code, etc) and the rendering size is set by the HTML markup or the code has an over-the-page component/special project, etc.
  • Friendly Frame (strict size) - The third party code comes from an unsafe source or it is a full HTML markup (the code contains HTML elements like head or body) and renders at a fixed size.
  • Friendly Frame (responsive) - The third party code comes from un unsafe source or it is a full HTML markup (the code contains HTML elements like head or body) and renders at a size set by the HTML markup. The code must be Responsive Design compliant.
  • Safe Frame (stric size) - The third party code comes from un unsafe source and it needs to be isolated from the page where it is served. It renders at a fixed size with no expansion.
  • Safe Frame (strict size, allow push expansion) - The third party code comes from un unsafe source and it needs to be isolated from the page where it is served. It renders at a fixed size with the posibility of expansion by pushing the content.
  • Safe Frame (strict size, allow overlayer expansion) - The third party code comes from un unsafe source and it needs to be isolated from the page where it is served. It renders at a fixed size with the posibility of expansion by overlaying the content.

Setting the Width to 0 will make the width of the ad equal to the width of the rendering container (100% width). By setting the Height to 0, the template will calculate the height automaticaly when the ad is served. If the Render Mode is set to Directly into page (responsive), the height will be set by the HTML markup.

Rich-Media HTML5 Over-the-page Ad

Ads created from this template consist of a sticky overlayer (i.e. floating over the page) component with support for responsive design, reactive to its content and the page viewport. The template provides expandability option.

Rich media html5 over the page ad

Ad parameters for this template are as follows:

HTML Content - The markup corresponding to the ad component.

Destination click URL - The landing page Uri for the ad’s click-to-action.

Render Mode - Use Responsive rendering only if your HTML markup supports responsive design.

Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only).

Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only).

Expanded Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only). Ignored for non expandable rendering.

Expanded Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for Responsive rendering only). Ignored for non expandable rendering.

Horizontal Alignment - Horizontal rendering position relative to browser viewport.

Vertical Alignment - Vertical rendering position relative to browser viewport.

Display Duration - Duration (in seconds) for which the ad will be displayed. Use value 0 for unlimited duration.

Display Delay - Duration (in seconds) for which the ad display will be delayed. Use value 0 for no delay.

Close Button - Choose Yes to let the system auto-generate the close button for the ad.

Close Button Position - This value is used in conjunction with Close Button = Yes.

Opacity Mask - Choose Yes to display the ad in a modal manner, obscuring the content of the webpage where it is delivered.

Track Mode - Ad Impression execution policy.

Error Handling - Passback and Clear container error handling will apply only if there is a critical error with the markup. If there is a successful rendering, the impression will be tracked

Additional notes for this template

Render mode:

  • Strict Size (non expandable) - The creative has a strict size without the possibility of expanding. The Width and Height parameters are used to set the rendering width and height of the creative.
  • Strict Size (expandable) - The creative is rendered with a strict size with the possibility of expanding. The Width and Height parameters set the initial ad size while the Expanded Height and Expanded Width set the width and height values for the expanded state.
  • Responsive (non expandable) - The creative is rendered with a size set by the HTML markup without the possibility of expanding. The code must be Responsive design compliant. Both the Width and Height parameters act as max-width and max-height limits for the creative. Setting their values to 0 defaults the template to a 100% width and height value of the viewport.
  • Responsive (expandable) - The creative is rendered at a size set by the HTML markup with the possibility of expanding. The code must be Responsive Design compliant. Both the Width and Height parameters act as max-width and max-height limits for the creative. Setting their values to 0 defaults the template to a 100% width and height value of the viewport.

Both the Horizontal Alignment and Vertical Alignment parameters set the position of the ad in the current viewport. By combining the two, the ad can be placed in the center or any side or corner of the page.

The Close Button can be auto-generated and its position set by the Close Button Position to any of the ad's corners. If a custom close button is desired, the AUHtml5.Close() method can be used.

The Opacity Mask parameter can be used to set a modal overlayer over the page so that the content is unavailable until the ad is closed.

Third Party HTML Over-the-Page Ad

Ads created from this template are suited for delivering third party markup (agency adtag, publisher custom code, etc) that it's rendered as an overlayer on the publisher's website.

over the page third party html ad

Ad settings for this template are as follows:

HTML Code - The third party markup corresponding to the ad component.

Render Mode - Use Direct rendering if you fully trust the markup source (it may change/break the website). Use FriendlyFrame rendering for full HTML markup or to isolate it from the website. Use SafeFrame rendering to isolate the markup from the website completely.

Width - Fixed Width for strict size rendering or Maximum Width for responsive rendering. Use value 0 for 100% (applicable for FriendlyFrame responsive rendering only). Ignored for Direct rendering.

Height - Fixed Height for strict size rendering or Maximum Height for responsive rendering. Use value 0 for 100% (applicable for FriendlyFrame responsive rendering only). Ignored for Direct rendering.

Horizontal Alignment - Horizontal rendering position relative to browser viewport. Ignored for Direct rendering.

Vertical Alignment - Vertical rendering position relative to browser viewport. Ignored for Direct rendering.

Display Duration - Duration (in seconds) for which the ad will be displayed. Use value 0 for unlimited duration. Ignored for Direct rendering

Close Button - Choose Yes to let the system auto-generate the close button for the ad. Ignored for Direct rendering.

Close Button Position - This value is used in conjunction with Close Button = Yes. Ignored for Direct rendering.

Opacity Mask - Choose Yes to display the ad in a modal manner, obscuring the content of the webpage where it is delivered. Ignored for Direct rendering.

Error Handling - Passback and Clear container error handling will apply only if there is a critical error with the markup. If there is a successful rendering, the impression will be tracked.

Additional notes for this template

Render mode:

  • Directly into page (no control over size and duration) - The third party code comes from a safe source (direct campaign, publisher code, etc) and renders with no control over the size or duration of the ad.
  • Friendly Frame (strict size) - The third party code comes from an unsafe source or it is a full HTML markup (the code contains HTML elements like head or body) and renders at a fixed size.
  • Friendly Frame (responsive) - The third party code comes from un unsafe source or it is a full HTML markup (the code contains HTML elements like head or body) and renders at a size set by the HTML markup. The code must be Responsive Design compliant.
  • Safe Frame (stric size) - The third party code comes from un unsafe source and it needs to be isolated from the page where it is served. It renders at a fixed size with no expansion.
  • Safe Frame (strict size, allow overlayer expansion) - The third party code comes from un unsafe source and it needs to be isolated from the page where it is served. It renders at a fixed size with the posibility of expansion by overlaying the content.

Both the Horizontal Alignment and Vertical Alignment parameters set the position of the ad in the current viewport. By combining the two, the ad can be placed in the center or any corner of the page.

The Close Button can be auto-generated and its position set by the Close Button Position to any of the ad's corners.

The Opacity Mask parameter can be used to set a modal overlayer over the page so that the content is unavailable until the ad is closed.

Out-Stream HTML5 Video Ad

special units out stream html5 video ad

Ad parameters for this template are as follows:

Desktop Movie - Movie source for large screen devices.

Mobile Movie - Movie source for small screen devices.

Destination click URL - The landing page Uri for the ad’s click-to-action.

In-view Activation - Ad is rendered when it first appears in-view.

Minimum Viewability - Ad's required minimum viewability.

Video Start External Tracker - External Code used to track the start of the video.

Video First Quartile External Tracker - External Code used to track the first quartile of the video.

Video Midpoint External Tracker - External Code used to track the midpoint of the video

Video Third Quartile External Tracker - External Code used to track the third quartile of the video.

Video End External Tracker - External Code used to track the end of the video.

Track Mode - Ad Impression execution policy.

Native Content Ad

Ads created from this template are intented to resemble publication's content where they are inserted.

native content ad

Title - The creative's title resembling the publication's editorial content's title.

Description - The creative's description resembling the publication's editorial content's description.

Image - The creative's image resembling the publication's editorial content's image.

Brand Name - The name of the brand that sponsores the creative.

Brand Icon - The icon of the brand that sponsores the creative.

Destination Url - The landing page Uri for the ad’s click-to-action.