Back to Platform Overview
Glossary
Creatives
Working with creatives
Creative technical specs
Viber Format Creatives specs
Advanced Creative settings
Creative billing

UI template: HTML5 Banner


Preview

An ad format with two panels, initial and fullscreen. The fullscreen panel appears after a click or mouseover. On a click on the Close button, the fullscreen panel closes.

This ad format may be subject to restrictions imposed by Google in cooperation with the Coalition for Better Ads on delivery of ads in Chrome. A list of ad experiences that should be avoided in this ad format according to Initial Better Ads Standards:
· autoplaying video ad with sound.

Supported platforms

Desktop Tablet Phone
Windows Mac iOS Android iOS Android
Chrome, Firefox, Edge, IE10+ Safari8+, Chrome, Firefox – – – –

Format requirements

Main panel

Standard sizes WxH, px: 300×250, 240×350, 300×250, 240×500, 300×600

Expanded panel

Standard sizes, WxH: 100%x100%

Video (optional)

  • Video player container can be of any size within the panel’s borders
  • File type: .mp4
  • Duration: 30 sec
  • Frame rate: 24 fps

Audio

User-initiated

Buttons

“X Close” button in the upper right corner of the expanded panel (allows user to collapse the expanded state)
The minimum essential value of top and right properties for the Close button element is 5px:

  • right: 5px;
  • top: 5px;

Banner size

up to 300 KB without video
up to 2 MB with video

Download an archive with a template:

Download

Present file structure corresponds to the default template only and can be changed by you. The required file in a .zip archive is body.html. All parameters such as dimensions, events, click tracking, etc. can be defined in the body.html.

How to work with .zip archive (template)

  1. Unpack an archive with a creative template.
  2. For creative preview use the preview page or copy all files to folder index – banners – banner- body and open a file index.html in a browser using localhost. For that, a web server has to be installed (e.g. IIS for Windows, Apache for Mac OS).
  3. Open the file body.html with the text editor and edit the code snippet inside tags <body> </body>.
Provide banner sizes, scripts, etc. within <body> </body> tags. Otherwise, the ad won’t show.
  1. Edit JS files.
  2. Save and archive all banner assets in .zip (you should archive the files, not the folder that contains the files).

Assets requirements

ZIP archive

The banner with all banner assets should be archived as a .zip file. It is recommended to use .zip file with a template.

HTML file

The HTML file must define all used sources (libraries, images, etc). A recommended file name is body.html.

API connection and usage

globalHTML5Api connects automatically, requested in the following way.

Expand the globalHTML5Api code
globalHTML5Api.on('load', function(){
  /*
    YOUR CODE IS HERE
  */
});

All used modules should be listed as function parameters. Two and more modules should be separated by commas. In this format, the Player module may be used.
A simplified example of the globalHTML5Api.init usage for the Click to Fullscreen format:

Expand the globalHTML5Api.init example code
globalHTML5Api.on('load', function(){
	globalHTML5Api.init({
		'resize' : [
			{
				'name': 'state-1',
				'width': '300px',
				'height': '250px',
				'onComplete': function () {
					//function();
			},
				'onStart': function () {
					//function();
			}
			},
			{
				'name': 'state-2',
				'fixed' : {
						'vertical':'center',
						'horizontal':'center'
					},
				'width': '100%',
				'height': '100%'
			}
		]
	});
});

Parameters of globalHTML5Api.init

Key Parameters Properties Type Description
resize(options) – – – globalHTML5Api.resize initialization
options – Array Array of objects with properties. Each object presents the container state (resizeState)
name (required) String Object (state) name
width (required) String|Number Banner container width
height (required) String|Number Banner container height
fixed – Object Object with properties. Describes the container position according to browser window
vertical (required) center String The vertical alignment of the container
horizontal (required) center String The horizontal alignment of the container
onComplete Function Callback function running upon completion of globalHTML5Api.init.resize.to(this.name)
onStart Function Callback function running upon starting of globalHTML5Api.init.resize.to(this.name)

globalHTML5Api.resize Methods

Method Parameters Type Description
to(resizeStateName, time, eventName) – – Changing the current container state to indicated one
resizeStateName (required) String Container state to which the current one should be switched to
time (required) Number Time for the container state-changing animation
eventName  (required) String Events for tracking:

  • adExpand – an ad container is expanding;
  • adCollapse – an ad container is collapsing;
  • adExpandAuto – an ad container is expanding automatically;
  • adCollapseAuto -an ad container is collapsing automatically.
currentState() – – Method returns the string:
resizeState.name – current container state name
interactive to resizeState.name – changing the container state to the indicated one

Methods of globalHTML5Api

Method Arguments Type Description
click(URL) – – Method to call the clickthrough. Target URL may be set as a parameter or from the user interface. <_The URL set in the code has a higher priority than the URL set from the UI, which can lead to a conflict. Therefore, it is mandatory to use only one of the available methods_.
URL (optional) String Target URL
src(URL) – – Method returns the absolute path to file
URL (optional) String Relative path to file

Video

In case the creative contains video, see the Video player module page.

Images

Supported file types: .jpg, .png, .gif, .svg

CSS files are supported as well.

Important! To serve ads on secure sites (sites that are served over the HTTPS protocol), make sure that external references to files support only secure HTTPS scenarios.

Event tracking

  • View
  • Confirmed view
  • Click
  • Expand by user
  • Auto-expand
  • Collapse by user
  • Auto-collapse
  • Play
  • Pause
  • Resume
  • Sound on
  • Sound off
  • Progress
Chrome will limit the resources a display ad can use before the user interacts with the ad by removing heavy creatives from the page. An ad is considered heavy if the user has not interacted with it (for example, has not tapped or clicked it) and it meets any of the following criteria:
– Uses the main thread for more than 60 seconds in total
– Uses the main thread for more than 15 seconds in any 30-second window
– Uses more than 4 megabytes of network bandwidth

For any questions regarding ad manuals please contact the support manager of your account.

Updated on April 16, 2024