PUSHDOWN DOCUMENTATION

Adsolutions / Documentation  / PUSHDOWN DOCUMENTATION

PUSHDOWN DOCUMENTATION

The templates are made as basic as possible so you have a simple starting point to begin building your creative.

The template consists of the following assets:

  • index.html
  • code.js
  • style.css

index.html
The head of the html contains the ad size and links to the core library and other two template assets.

The body contains a background div and a standard html video player with an ID. You can add your own sources and change the controls etc.

code.js

The code is wrapped within the init() function. This function is called when our library is ready.

The highlighted lines show we look for an element with ID videoPlayer (the ID of the video element) and the next highlighted line we tell the library to register this element as the video player. This way we can measure the VAST video events and report on them.

Next a bunch of general functions. Their purpose is explained in the comments of the file but we’ll go by them one by one.

The prefixedEvent function adds browser prefixes. (element, type, callback). Further down the code you can find a sample  prefixedEvent(background, “AnimationEnd”, contractHandler);

The stopPropagation function prevents further propagation of the current event in the capturing and bubbling phases for several browsers.

The addClass allows you to add a class. addClass(elm, clsName);

The hideElement function can hide an element. It calls the addClass function with the ‘hide’ class Further down the code you can see some examples:

hideElement(closeButton);
hideElement(videoContainer);

Adds the class ‘hide’ to both the closeButton and the videoContainer elements.

The opposite of the addClass function. The removeClass function can remove a class. removeClass(elm, clsName);

The showElement function can unhide an element. It calls the removeClass function with the ‘hide’ class. Further down the code you can see some examples:

showElement(closeButton);
showElement(videoContainer);

Removes the class ‘hide’ to both the closeButton and the videoContainer elements. Making them visible again.

Next a vid.onended function. It’s currently empty but if you want to make something happen when the video ends playback you can put it here.

Next the closeButton handler. It manages what happens when the close button is clicked. You can see that also calls the contractHandler on AnimationEnd of the background element. This is the next function.

Then the contractHandler function. The highlighted line is mandatory and is there to tell our system we need to contract the iframe in which the ad is rendered.

Next the expandButton function. It handles what happens when the expandButton element is clicked. The highlighted line is mandatory and is there to tell our system we need to expand the iframe in which the ad is rendered.

Then the expandHandler function which triggers an event and shows the close button and video container.

The code.js file is also the spot where the click is implemented. You can change the URL in this file. Or designate it to a different element or add multiple clickable elements.

The click is syntax is like so: ADTECH.click(‘Click Name‘, ‘your CLICK URL‘);

Click Name is used in the reports to distinguish which click through button was clicked on. You don’t have to enter the URL if you don’t know it yet. We can handle it for you if you send the URL or redirect later on.

SUPPORT
During the design phase we can provide you with a preview URL so you can see the work in action and make changes to your design accordingly. Send us the source files and fonts to support@adsolutions.com (WeTransfer preferred)

Final creative or requests for a preview can be send to traffic@adsolutions.com

Also read the GENERAL DOCUMENTATION fur further reference on building HTML5 ads.