Introduction

Welcome to the AdUnity Knowledge Base. This is where you will find our User Guides and other technical documentation. These resources can be filtered and accessed from the left-hand-side index, or via the top-left search bar.

We are on a mission to clean up the advertising industry, so we have an open and transparent approach to reporting and configuration on our platform. Sometimes this means you may have more options than you are used to. We believe this is a good thing, because it gives our customers more control over their business. If you need any help with configuration or understanding the information in the Knowledge Base please contact Customer Support by creating a support ticket.

AUX User Guide

1. User & Account

1.1 Your Account

When you requested to open an account with us you provided us with information about your company/business. These details are in the Account section. It is your responsibility to make sure your company/business details, contact details and payment details are all up to date.

account details

1.1.1 Company & Company Representative Details

You must keep your company details up-to-date at all times (as required in our standard AdUnity Exchange Agreement). This is not just for legal issues, but it is also important for urgent notifications. In our system the Account Owner is referred to as the Administrator. This is also the user that is the official company representative. The Administrator can update company details as follows:

  1. Click Settings tab from the left menu.
  2. Enter required details under the three sections: Details, Company/Business Registered Address and Company/Business Representative
  3. Click Save button to save your updates.

Please note that ID relates to how we recognise your account within our system. ID cannot be edited or updated

administrator account

1.1.2 Payment Details

We need your payment details in order to pay you. It is entirely the responsibility of the Administrator to accurately input the payment details. Only the Administrator account has the authority to input or change beneficiary details. Please remember we operate a self-billing process, so DO NOT SEND US AN INVOICE. You can download your invoice to us in the Payment Section.

To input or update beneficiary details please follow these steps:

  1. Click Settings tab from left menu.
  2. Enter required details related to the beneficiary details (this includes Beneficiary Name (i.e. the name of the bank account), Bank Details* as well as Billing Contact Person and Billing Address).
  3. Click Save button to save your changes

* Required fields under the Bank Details section may differ for different countries

billing details

1.2 Managing Users & Profiles

AUX is designed to accommodate either single or multiple users in the same account based on a permission and security tree. AUX works for single-site Publishers, multi-site Publishers as well as Networks and Sales Houses. Reporting and trafficking privileges can be defined on a user, campaign and site basis. Therefore, you can use many users for different sites yet keep your account and billing details safe.

You can see an example for a three website account below:

1.2.1 Updating User Profile

In order to update user details please follow the instructions below:

  1. Select the profile name at the upper right corner.
  2. Select User Profile
  3. You can update first name, last name and password from Profile Page
  4. Click Save button to save your changes.
updating user profile

1.2.2 Adding Additional Users

The account Administrator can request additional Users to be added to the account. Only the account Administrator can request additional users. The request is made via a Support Ticket raised via the user interface. The Support Ticket must include the new user details (name and email address) as well as desired access privileges for the new user.

See part 7.1: Raising a Support Ticket of this User Guide to find out how to raise a Support Ticket.

2. Ads & Tags

2.1 Supported Formats and Devices

Publishers can access buyer demand for all devices with AdUnity’s AUX. A publisher may use either responsive site design or specific sites for mobile and desktop. AUX provides demand for standard image, video and native formats as below:

Ad Formats Available
Standard Image Ads Video Ads Native Ads
All standard IAB desktop formats Desktop (in-stream and out-stream) Desktop (in-stream and out-stream)
All standard IAB mobile formats Mobile (in-stream and out-stream) Mobile (in-stream and out-stream)

We use the latest IAB and technical standards for image, video and native ads (HTML5, VAST 2.0, VPAID 2.0, MRAID 1.0). Video ads are natively integrated into our platform or can be served from third-party ad systems with standard VAST 2.0 wrappers. We work with VAST 2.0 and VPAID 2.0 tags. AdUnity also provides a free hosted video ads platform that works with the most popular video players: JW Player, Flow Player and VideoJS.

2.2 What are Sites, Sections and Zones?

Sites refers to your websites (responsive, desktop or mobile), e.g. http://abctestsite.com. You may add new Sites any time. Once you have created a new Site it will not become Active (i.e. made available to buyers on AUX) until it has been activated by AdUnity Customer Support. Please note that while a Site may be Active, it still may take up to 7-days to be approved by all our demand partners (i.e. full demand for any Site may take up to 7 days).

Sections refer to the different type of pages in your website, e.g. Homepage and Article Page. Since many publishers want to handle the homepage differently from other pages in terms of both placements and reporting. A publisher may then implement a different set of tags for the homepage than for other pages. This will enable a better breakdown in reporting. If you wish to have additional Sections please contact AdUnity Customer Support via your login. Please note that it is NOT mandatory to configure a Section and can be left as Unspecified.

Zones refer to the placements, e.g. Halfpage (300x600) or Top (728x90). In AUX, Zones are predefined within your account and are selected from a drop-down menu. If you wish to have additional Zones because you did not find a suitable format within the drop-down menu please contact AdUnity Customer Support via a Support Ticket (see Section 7.1: Raising a Support Ticket).

what are sites, sections and zones

2.3 Managing Sites, Sections and Zones

In order to see all your Sites, and related Sections and Zones in your account, please follow these steps

  1. Select Settings tab from left menu
  2. Under the Media Spaces section you can see Sites, Sections and Zones listed in separate tables
managing sites, sections and zones

2.3.1 Display or Update Details of Selected Web Sites

If you want to see more details of your website or even change some fields, please follow these steps:

  1. Click name of the website listed on table in Settings > Media Spaces section
  2. Site detail page will be displayed with related web site’s value
  3. Enter new values or select Content Category
  4. Click Save button to save your changes.

* Status cannot be updated from the user interface. If you wish to delete a Site please contact AdUnity Customer Support via your login.

display or update details of selected web site

2.3.2 Adding a New Site

If you would like to add new Site to your AUX account please follow these steps:

  1. Click New button on the bottom menu
  2. Make sure Settings button is selected on the opened dynamic menu
  3. Then, click New Site button
  4. Enter the name of your Site and unique ID number. Then, select your Site’s type.
  5. Click Save button to complete process

    Click Save & Open Site button to display site detail page after creating the new site

    Click Save & Open In a New Window button to display site detail page in a new window after creating the new site.

When a new Site is created the Status will be Suspended until Customer Support has approved it (usually within 48 hours) . If you wish to activate it urgently please contact AdUnity Customer Support via your login.

adding a new site

2.3.3 Details of Selected Section

You can easily display a Section by following these steps:

  1. Click name of the section listed on table in Settings > Media Spaces section
  2. Section detail page will be displayed with related section’s value

If you want to add new section or update it as out of use, please contact us.

details of selected section

2.3.4 Display Details of Selected Zones

You can easily display a Zone by following these steps:

  1. Click name of the zone listed on table in Settings > Media Spaces section.
  2. Zone detail page will be displayed with related values and dimension options
details of selected zones

If you want to add new Zone or update it as out of use, please contact us.

Summary of our pre-defined zones:

pre-defined zones

2.4 What is An Adunity Ad Tag?

AdUnity Ad Tags are HTML code that is put into directly into publisher’s Site or ad server. AdUnity Ad Tags are used to call our AUX server to request an ad

what is an adunity ad tag

Ad Tags are common in the digital display advertising industry. Ad tags are generally either JavaScript or HTML code that is put into a publisher’s Site or ad server for a variety of reasons (see below):

2.5 Managing Ad Tags

In order to display Single Ad Tag page:

  1. Click Open Short Menu button for a website listed on table in Settings > Media Spaces section
  2. Click Single Ad Tag Button on opened menu

OR

  1. Create a new Ad Tag like described in 2.4.1 Create a tag chapter
managing ad tags

From this page, you can update your preferences and advanced settings for the Ad Tag. Please check 2.5.3 Advanced Ad Tag Preferences chapter for further information

2.5.1 Creating New Single Ad Tag

You can easily create an AdUnity Ad Tag by following these steps:

  1. Click New button on the bottom menu.
  2. Make sure Settings button is selected on the opened dynamic menu.
  3. Then, click New Ad Tag button.
  4. Fill all the required fields in order.
  5. To generate tag, please select Single Ad Tag.
  6. You can find the generated tag under Billboard section in Tag Detail Page which will be opened automatically
creating new single ad tag

2.5.2 Implementing Ad Tags

After generating the Ad Tag for the selected Section and Zone, you can specify tag type as either Standard or VAST Video.

implementing ad tags

Then, all you need to do is to copy the Ad Tag and paste it to your website code or ad server

Please contact AdUnity Customer Support via your login if you need help with this.

2.5.3 Advanced Tag Preferences

You can add following specialities to you tag just putting ticks to related options:

advanced tag preferences
2.5.3.1 Passback Function

You can add passback function easily by following these steps:

  1. Tick the Passback Function option.
  2. Then, from the selector box, please choose which service you want to pass request. Following options will be listed:
    • Google AdX/AdSense
    • Google Publisher Tag
    • AdServing Factory
    • AdOcean
    • Zontera
    • Custom
  3. In this example it is assumed the Google AdX/AdSense option is selected. Update the following parameters on your tag
    • data-au-passback-val='google_ad_client = "ca-pub-XXXXXXXXXXXXXXXX"
    • google_ad_slot = "XXXXXXXXXX"
    • google_ad_width = XXX
    • google_ad_height = XXX
passback function
2.5.3.2 Avoiding loops

In order to prevent passback loops, please avoid recursive output of the AdUnity tag on your adserver passback request.

A possible configuration for Google DFP using specific macros is as follows:

avoiding loops

Please note the key-value setting (exchange = adunity) within the "Targeting" parameter. This implies having the "exchange" key in DFP and setting a delivery restrinction on the AdUnity campain (exchange != adunity).

By doing so, you will ensure that once the impression is being passed back in DFP, it will not deliver the AdUnity ad tag again for the same impression, thus avoiding the passback loop. Note that you can however use other key-value pairs that you may already have.

2.6 Creating Multiple Ad Tags Using Bulk Ad Tags

AUX comes with an advanced tag generator and tagging options designed to assist with fast implementation of tags. There is a Bulk Ad Tag option that creates tags for all Zones (placements) so they do not have to be created one-by-one. This is a time saving feature. The Ad Tags created using the Bulk Ad Tag feature are the same as if they were created one-by-one.

If you want to generate Bulk Ad Tags, you need to click Bulk Ad Tags button when creating new ad tag.

creating multiple ad tags

2.7 IAB ads.txt - increased transparency and protection against fraud

The IAB’s Ads.txt project is the latest initiative for improving transparency in programmatic advertising by allowing publishers to declare authorized partners to sell their inventory. By creating your ads.txt file, you can protect your inventory from domain spoofing and unauthorized sellers.

Ads.txt is not mandatory but is highly recommended. It provides protection by giving DSPs a simple way to check if inventory from a particular source has been authorized by the domain owner.

In order to setup ads.txt for AdUnity authorization you must copy the following lines (please include the #AdUnity AUX comment) into your domain's ads.txt file (http://yourdomain.com/ads.txt).


#AdUnity AUX
adunity.com, 1000001, RESELLER
indexexchange.com, 183775, RESELLER
openx.com, 537101597, RESELLER
contextweb.com, 558315, RESELLER, 89ff185a4c4e857c
            

Please implement on all your sites/domains where AdUnity AUX ad tags are trafficked. Also, please consider that the ads.txt file can include multiple authorized partners within the same exchange/hub.

3. Brand Safety

3.1 Quality Advertisers

AUX is connected to over a hundred demand sources including the biggest and most reputable in the market. However, even the biggest DSPs have problems with fraud and malware. This is why we constantly check for malware, spoofed landing pages, unidentified creative attributes and various other hidden dangers. AdUnity uses automated systems to continually scan demand from our partners to identify and neutralise malware and other fraudulent activity. We also employ a combination of robust validation processes and technology to vet new demand sources

However, there are still times when a publisher will want to filter out advertisers for commercial and editorial reasons. This is why we developed our Brand Safety features. Aside from the obvious issue of ad quality there are several common situations where a publisher would want to block specific advertisers. These are listed below.

When it is appropriate to block advertisers
1 When the advertising breaks editorial policies, e.g. blocking fast-food ads on a dieting/healthy eating site.
2 When the advertiser is a competitor, e.g. blocking ads for subscriptions to a financial news site, on a site in the same sector with the same subscription business model.
3 When the advertiser is already a direct buyer of media, i.e. stopping a direct advertiser’s ability to buy cheaply on the open market when they are buying on a premium/ guaranteed basis.
4 In order to avoid poor quality ads, such as ads for "miracle cures" and "get-rich-quick schemes"

We believe that the more control the Publisher has in accepting or rejecting advertisers the better. AdUnity provides this control. We have two features under Brand Safety: one is to make a custom block/blacklist against specific advertisers and the other is to make a make custom block/blacklist by category.

3.2 Ad Preview

Ad Preview shows the ads served to a publisher's site (both image and video ads) in a single place. This not only provides evidence of the quality of the creatives but also provides the bid range for each creative

In order to access Ad Preview:

  1. Select the Brand Safety tab from left menu

* These screens can be filtered by site if required.

ad preview

Each ad preview window, there are:

ad preview window

3.3 Brand Safety

3.4 Block/Blacklist Specific Advertisers

Publishers can block/blacklist specific advertisers by domain with an additional option to block all sub-domains too. The Advertisers that are blocked are shown on the blacklist but can be reinstated any time with a single click to unblock.

In order to block an advertiser:

  1. Select Brand Safety from left menu.
  2. Select Blocked Advertisers from right menu.
  3. Enter values.
  4. Select Add button.
  5. After it is added to table, click Save button to save changes.
block/blacklist specific advertisers

3.5 Block/Blacklist Advertiser Categories

Many advertisers flag their category based on IAB Quality Assurance Guidelines contextual taxonomy. AUX uses these flags to identify and potentially block categories of advertisers

In order to block an advertiser category please follow these simple steps:

  1. Select Brand Safety from left menu.
  2. Select Blocked Categories from right menu.
  3. Enter values.
  4. Select Add button.
  5. After it is added to table, click Save button to save changes.
block/blacklist advertiser categories

4. Yield Maximisation Tools

4.1 Yield Maximisation Tools

Each ad impression is a unique event and AUX can maximise the value of each one. Two important things we can do to maximise the value of ad impressions are: firstly dynamically vary the bid-floor; and secondly if necessary utilise a soft bid floor. AUX’s dynamic bid floor technology is called Dynamic Lift. AUX’s soft bid floor technology is called Soft Bid Floor. These two tools can be enable by the publishers under Auction Intelligence control panel (shown below), which is under the Auction Settings (shown below) which is accessible via the right menu.

yield maximisation tools

Dynamic Bid-Floor refers to a programmatic seller-side technique to maxmise revenue for the publisher in a real-time auction by varying the bid floor dynamically. AUX’s dynamic bid-floor technology is called Dynamic Lift. Dynamic Lift automatically changes the bid floor in order to come close to what is calculated to be the maximum price a buyer is willing to pay. This price can be above or below the Base Bid Floor. Dynamic Lift is enabled and adjusted by publishers. AdUnity recommends that publishes enable Dynamic Lift and set allow bids at least 50% below Base Bid Floor.

Soft Bid-Floor refers to a programmatic seller-side technique to maxmise revenue for the publisher in a real-time auction by accepting bids below the Base Bid Floor. Soft Bid Floor is enabled and adjusted by publishers. AdUnity recommends that publishes enable Soft Bid Floor and set allow bids at least 20% below Base Bid Floor.

Base Bid-Floor is reference bid-floor that the publisher sets. AdUnity recommends that the Base Bid Floor should be set at the level of expected eCPM for that Zone provided that Dynamic Lift is enabled and the lower limit of the Dynamic Lift setting is at least 50%. If the lower limit is not set to at least 50% of Base Bid Floor then the Base Bid-Floor should be set at a rate below expected eCPM for that Zone.

4.2 Why Publishers Shoud Use Dynamic Lift

Dynamic Lift is not enabled by default. It can only be enabled by the publishers. Dynamic Lift significantly improves floor price efficiency because it automatically varies bid floor for each impression in real-time in order to maximise sale price. Dynamic Lift is enabled and adjusted by publishers to suit their particular market conditions and to optimise for different types of sales targets and business goals

In particular Dynamic Lift solves a common problem for publishers: selling inventory at below market value. This happens in situations where there are only one or two bidders for a particular impression (often just one serious buyer and one low-value opportunist buyer). Given the rules of the Vickery Auction (second price auction), the highest bidder wins, but only pays the bid floor price (plus one cent) or the second-highest bid, whichever is highest

Therefore, in many cases the bid-floor effectively becomes the sale price. Hence the ad inventory becomes undervalued and the benefits of an auction market evaporate. This market inefficiency problem is illustrated below.

why publishers should use dynamic lift

There are three main reasons why this is such a common problem. Firstly programmatic buying is driven by targeted audience data, so if the audience is not a match for the campaign there is no. Secondly, campaign pacing by DSPs means they do not always bid for audiences they are interested in. Thirdly, many DSPs understand these market dynamics and bid at below market rates to exploit arbitrage opportunities (i.e. buy low and sell high).

The only way to correct this market failure is to adjust the bid floor on an impression-by-impression basis to match or get very close to real market value. This is what Dynamic Lift does. Dynamic Lift automatically adjusts the price floor towards real market rates and makes a significant improvement to publishers’ revenues as shown below.

dynamic lift technology

Dynamic Lift technology combines analyses of the real-time bid landscape together with an analysis of both bid quality and bid density on a user basis. This analysis creates new bid floors in real-time depending on current market conditions and historic demand for any given audience/inventory

4.3 Auction Settings and Auction Intelligence Manager

Auction Settings is where Base Bid Floor can be set for each Zone and where Auction Intelligence control panel is located. The Auction Intelligence Manager control panel is where Dynamic Lift and Soft Bid Floor can be enabled and adjusted.

In order to display Auction Settings page where Base Bid Floor can be set for each Zone:

  1. Click Revenue tab from left menu.
  2. Click Auction Settings tab from the right menu
auction settings and auction intelligence manager

4.4 Setting Base Bid Floor

Auction Settings is where Base Bid Floor can be set for each Zone

setting base bid-floor

In order to set the Base Bid Floor for a Zone to display Auction Settings page where Base Bid Floor can be set for each Zone and:

  1. Search for Zone that is intended to have Base Bid Floor set by using the Site Name, Section Name or Zone name search boxes. When you start typing in one of these search boxes the relevant Zones are shown below.
  2. setting base bid-floor zone search
  3. Click on Price box in order to edit it.
  4. setting base bid floor price box
  5. Input Base Bid-Floor for Zone.
  6. Click Save button on right menu to save your changes.

4.5 Dynamic Lift

Dynamic Lift is not enabled by default. To enable Dynamic Lift follow these steps:

  1. Go to Auction Intelligence Manager control panel, which is on the Auction Settings page
  2. Click Enable Dynamic Lift.
  3. Click Save button on right menu to save your changes.
dynamic lift

4.5.1 Dynamic Lift: Adjusting Lower Bid Floor Limit

Once Dynamic Lift has been enabled the Lower Bid Floor Limit can be set. By default it is set to 50%. In most scenarios AdUnity recommends that it remains at 50%, but the publisher may change it. To adjust this setting please follow these steps:

adjusting lower bid floor limit
  1. Click on the Allow bids box to set percentage below Base Bid Floor.
  2. Click Save button on right menu to save your changes.

OR

  1. Use slider to set percentage below Base Bid Floor.
  2. Click Save button on right menu to save your changes
adjusting lower bit floor limit with slider

4.5.2 Dynamic Lift: Setting Strategy

Once Dynamic Lift has been enabled Strategy can be adjusted. By default strategy is set to Fill. To adjust this setting please follow these steps once Dynamic Lift has been enabled:

  1. Go to Auction Intelligence Manager control panel, which is on the Auction Settings page
  2. Use drop-down menu to select Strategy (Fill, Revenue or Balanced).
  3. Click Save button on right menu to save your changes.
dynamic lift: setting strategy

Fill Strategy optimises the Dynamic Lift technology to maxmise fill. This means it aims to fill as many ad impressions as possible with auction wins.

Revenue Strategy optimises Dynamic Lift technology to maxmise revenue. This means it aims to maximise overall revenue.

Balanced Strategy provides an even balance between Fill and Revenue Strategies.

4.6 Soft Bid Floor

Soft Bid Floor is not enabled by default. To enable Dynamic Lift follow these steps:

  1. Go to Auction Intelligence Manager control panel, which is on the Auction Settings page.
  2. Click Enable Soft Bid Floor
  3. Click Save button on right menu to save your changes.
soft bid floor

4.6.1 Soft Bid: Adjusting Hard Bid Floor Limit

Once Soft Bid Floor has been enabled the Lower Bid Floor Limit can be set. By default it is set to 50%. In most scenarios AdUnity recommends that it remains at 50%, but the publisher may change it. To adjust this setting please follow these steps:

Soft Bid Floor: Adjusting Hard Bid Floor Limit
  1. Click on the Allow bids box to set percentage below Base Bid Floor.
  2. Click Save button on right menu to save your changes.

OR

  1. Use slider to set percentage below Base Bid Floor.
  2. Click Save button on right menu to save your changes.
Soft Bid Floor: Adjusting Hard Bid Floor Limit with slider

5. Reporting

5.1 Transparent and Clear Reporting

AdUnity provides some of the most transparent and detailed reporting in the industry.

The Open Auction programmatic market is still a black box for most Publishers. Publishers simply do not know who is buying their media and how much they are paying. In contrast, AUX provides full visibility with market-wide and bid level insights. Using AUX reporting tools a Publisher can evaluate demand across multiple dimensions: advertiser, Zone, geo and even bid-range. This valuable insight can be used to better inform sales strategy.

Reporting on AUX is divided into two areas and each has its own dashboard: Revenue (for market demand and revenue focused reporting) and Reporting (for inventory focused reporting).

* Requests means the total number of impressions that have been successfully received by AdUnity.

** Win Rate means the percentage of requests that are sold.

5.2 Inventory Reporting: Reporting Dashboard

You can track the inventory of your site/s in detail. Further reports are available under AUX Traffic Viewer.

  1. In order to see the Inventory Reporting dashboard please following step:
  2. Select Reports tab from left menu.
Inventory Reporting: Reporting Dashboard

The AUX Inventory Dashboard provides an instant visual feedback on the performance of a Publisher’s ad inventory. This dashboard highlights and compares the key inventory related metrics: impressions, requests* and win rate**. Various charts break these down by time, site and zone. Charts can be filtered to show the publisher network or on a site-by-site basis.

Below the charts is a table showing raw traffic numbers with a detailed breakdown. There is also a link for the AUX Traffic Viewer reports

AUX Traffic Viewer is where a publisher can define and download any reports about their network, individual sites or placements

* Requests means the total number of impressions that have been successfully received by AdUnity

** Win Rate means the percentage of requests that are sold

5.3 Inventory Reporting: AUX Traffic Viewer

In order to access the AUX Traffic View page please following step:

  1. Select Reports tab from left menu.
  2. Select AUX Traffic Viewer from link.
Inventory Reporting: AUX Traffic Viewer

The AUX Traffic Viewer is designed to show as many or as few columns as needed. These reports can include details of eCPM; revenue; wins/sold impressions, clicks, country/geo and passbacks.

Forecasts is where a publisher can see how many ad impressions of different types are forecast to be available for a future time period. The forecast calculation is based on historic traffic. If the publisher has reserved impressions for this future time period, these are also shown. These Forecast Reports can include a breakdown by site; zone and country.

* Requests means the total number of impressions that have been successfully received by AdUnity.

** Win Rate means the percentage of requests that are sold.

5.4 Revenue Reporting

The AUX Revenue Dashboard is designed to provide immediate analysis of the market demand for a publisher’s inventory as well as trend and historical sales performance. This is achieved with charts comparing key commercial performance data sets. Together these charts provide a powerful analysis of the bid landscape facing the publisher and the relative ad sales performance of Sites and Zones (placements) over last 14 days.

Revenue Reporting

6. Payments

6.1 About Payments

AdUnity invoices and collects revenue on an on-going basis from numerous media buyers in several different currencies and at different billing cycles. The payments from media buyers are aggregated and processed before being paid onto you. See below the main points of our payments process:

Self-Billing: AdUnity operates a self-billing process. This means we invoice ourselves on your behalf every calendar month. DO NOT SEND US AN INVOICE. You can download your invoice to us in the Payment section of the AUX. See section 6.5 Download Invoice.

VAT: If applicable invoices will include VAT. You must provide AdUnity with your VAT number if you have one. If your company is based in the UK the VAT invoice to AdUnity will be charged at 20%. If the your company is based in another EU country the VAT invoice will have VAT zero-rated and the sale will be classed as a despatch between EU countries.

Calendar Month: AdUnity works on a calendar month basis for all invoices, billing and payments.

Commission: AdUnity takes a sales Commission of 20% on the value of programmatic sales on AUX. This sales commission is taken before the amount displayed on the Revenue Dashboard. This means that the money amount shown on the Revenue Dashboard is that amount that will be paid to you.

60 Days: Revenue generated on AUX is paid in 60 days from the end of the relevant calendar month. For example, revenue generated for the month of January will be paid at the end of March.

Pending Payment: A Pending Payment is a payment that is due to be paid to you for a given calendar month. Pending Payment for a given month may differ from the estimated amount as shown on the Revenue Dashboard depending on whether AdUnity received expected payment from media buyers. An alert email is sent by AdUnity to Publisher to inform the Publisher that a payment is pending. Typically the Pending Payment is made within 7 days of email notification.

Estimated Revenue: Estimated Revenue is the revenue we have estimated that you have earnt from AUX. The reason why it is estimated is because there are sometimes differences between our programmatic sales records and the programmatic sales records of media buyers. Once we have confirmation of the agreed amount to be paid by all the media buyers for a given month we can then make this a Pending Payment. Unfortunately, some media buyers do not make a final confirmation for several weeks.

Open Balance: Open Balance refers to all estimated revenue owed to you over the 60-day billing cycle

6.2 Pending Payments and Estimated Revenue

You can view any Pending Payments and Estimated Revenue in the Revenue Dashboard.

Estimated Revenue for the current month is shown in the Revenue Dashboard (below). All revenue in the Revenue Dashboard is Estimated Revenue.

Pending Payments and Estimated Revenue

You can view any Pending Payments in the Revenue Dashboard, under the Revenue Schedule in the Revenue column.

Pending Payments and Estimated Revenue

6.3 Payment History

All you past payments are listed under Received Payments on the Payments page of the AUX user interface.

In order to display the Payments page where the list of payments can be found please follow the below instruction:

  1. Click Revenue tab from left menu.
  2. Click Payments tab from the right menu.
Payment History

All your past payments are listed under Received Payments on the right side of the Payments page as shown below.

Past payments

6.4 Download Invoices

Invoices can be downloaded from the list of Received Payments on the Payments page.

In order to download an invoice please follow the below instructions:

  1. Click on the hamburger menu button on the relevant payment listed under Received Payments.
  2. Click Open or Download Invoice depending on whether you would like to open or download the invoice.
Download Invoices

7. Customer Support

7.1 Raising a Support Ticket

If you have a problem, you can easily create a Support Ticket to tell us about it. To raise a Support Ticket please follow these steps.

  1. Click New button on the bottom menu.
  2. Make sure Support button is selected on the opened dynamic menu.
  3. Then, click New Ticket button
  4. Choose a category and fill all the required fields in order.
  5. To submit it, please click Submit Ticket button

    If you want to add more details, please click Add More Details button.

* If you selected to add more details, Ticket Detail Page will be open automatically.

Raising a Support Ticket

7.2 Adding Details to Ticket

If you want to add details to your ticket, you can do it on ticket detail page by clicking Add More Detail button when you are creating the ticket or you select the ticket from table in Support tab.

When you finish editing your ticket, please don’t forget to click Send button.

Adding Details to Ticket

7.3 Managing Tickets

You can easily track all tickets created from your account in Support page. Also, you can filter items by their title, category, status, creation date, last update date and user name as well.

Managing Tickets

Ad Server User Guide

1. Orders & Segments

1.1 Order

The Order is the main operational entity that encapsulates all the information needed to deliver creatives to the ad network users.

The main scope of an order is to group segments together for the purpose of obtaining aggregate measurements like ad impressions, unique visitors and other metrics for the objects inside the campaign.

The relations between an Order, a Segment and Ads are the following:

Each Segment runs independently of other Segments of the same Order based on its targeting;

The main operation workflow for deploying a campaign – order is:

  1. Create a New Order (Orders > New Order); Choose the owner account of the order and main user of the order. Choose an additional user if necessary (this additional user can view this order and receive order alerts). Choose other parameters like order name, agency, customer, billing reference, sales agent and order type and Save.
  2. Create a Segment; Choose Start and End Date of the Segment and Delivery Type; Set the booking impressions (only for some Delivery types) and Target limits;
  3. Select the Media Spaces where the ad will run (Media Space = Site + Section + Zone);
  4. Set other Targeting (geo, frequency, hour/day etc.), if necessary;
  5. For Delivery Types that needs inventory reservations Reserve ad inventory. Check if the reserved inventory is satisfactory and Save the Segment.
  6. Go to the Ad Library and create the creatives for the campaign;
  7. Return to Orders > Segment and on the Manage Ads section choose the creatives you want to assign on this segment and allocate them;
  8. Start the segment;

On the Order editing screen, the user has the option to enable both Post Tracking and Interactions Tracking on creatives. Enabling post tracking on the Order page will enable it by default on all the segments contained by it.

The user also has the option to set a Maximum overall budget and a Maximum daily budget for the respective order.

The Ad Server Management System will deploy the new Segments based on the System Update Times.

The current run priority and status of any segment from the system can be observed in the SYSTEM LIVE PROBABILITY table.

Any Order or Segment can be modified at any time. The Ad Server Management System will recalculate the serving priorities due to historical data and current settings every hour.

1.2 Segments

The Segment is the main ad serving unit responsible with targeting, capping, media spaces inventory reservation, creative allocation, delivery limitations, serving companions, pricing, etc.

The Segments are grouped in an Order (Campaign) in order to have aggregated reporting statistics across business entities and also to have a high level of customization in ad delivery operations.

Each Segment can be controller individually inside an Order by status and can have its own combination of Media Spaces.

Each Segment can have its own targeting filters and can contain an unlimited number of creatives assigned.

Segments can be excluded from one-another by using the Collision Avoidance tags.

The segment control parameters are:

1.1.1 Types and Delivery

Delivery types with inventory reservation:

Delivery types without inventory reservation:

Special types:

1.1.2 Media Spaces

The Media Spaces represent the publisher network trafficking objects and it models the structure of an ad network through sites, sections and zones.

In order to select a combination of Media Spaces, these must be created in advance in the Settings module: Settings > Sites, Settings > Sections, Settings > Zones.

In order for a Segment to run on all the Sections of a site, the top level Account option must be ticked instead of individual Sections when selecting from the SECTIONS tree. After adding the selection to the list, the Sections option will read “Not specified”, meaning that the Segment will run on all the sections of that respective Media Spaces combination.

In order for a Segment to run on all the Publisher Sites, the top level Account option must be ticked instead of individual Sites when selecting from the SITES tree. After adding the selection to the list, the Sites option will read “Run on network”, meaning that the Segment will run on all the sites of that respective Media Spaces combination.

Zones must be selected individually when doing a Media Spaces combination.

Media Spaces Restrictions can also be set in place to restrict an ad from running on selected Media Spaces combinations. This can be done under the Media Spaces Restriction tab and the process is similar to the one described above for Media Spaces selection.

1.1.3 Targeting filters

For a better control over the delivery of the Segment, targeting filters can be set in place.

The user has the option the set a daily fixed number of Impressions, Clicks or even an overall daily budget.

Frequency filtering

Frequency capping allows the user to set different frequencies per visitor. A frequency capping can be set per the entire ad or a number of days with a Repeat ad each “X” minute option. This option will stop the delivery for each unique visitor until the time span has passed.

All capping filters can be combined with the first matching condition being applied to limit the delivery per unique visitor.

Geographic filtering

Ads can be geographically targeted by IP address on three levels of localization: Country, Region and City.

IP filtering

Ads can be targeted by an IP address class or by a single IP.

Time filtering (Hour/Day)

Different Hour/Day intervals for the Segment to run can be set from the Hour/Day tab.

Keywords filtering

Ads can be targeted ads by keywords from the URL or Referrer of the ad placement page.

Custom parameters

This filter can be used in custom defined specific scenarios.

Browser/OS

Ads can be targeted based on the Browser or Operating System used.

Resolution

Ads can be targeted based on Screen Resolution by setting the Maximum and Minimum width/height of the Browser’s Resolution.

1.1.4 Ad assignments

Each Ad from the Ad Library can be allocated to any Segment that has an appropriate Media Space selected. This means that an Ad can be allocated to a Segment only if that Segment contains a Media Space with a zone that matches the creative’s size.

Ads are allocated to segments using the Manage Ads section from the bottom of the page.

Pressing the “Choose” button will open a selection of ads with sizes compatible with the zones selected in the Media Spaces of the Segment.

An ad is assigned to a segment by first selecting the desired Zone from the dropdown and then pressing the Assign button.

Manual priority:

The rotation of each ad can be specified manually using the Priority value. If left blank, the system will run the creatives evenly distributed.

Display mode:

The user can also override the run period of a particular ad by selecting different start and end dates from the ones of the segment.

1.1.5 Inventory reservation

Inventory reservation is probably the most important method in ad trafficking and day-to-day operations.

There are three major Ad delivery types:

The inventory reservation system will try to guarantee the delivery plan when you book it on a Segment and the Ad Server System will automatically calculate the delivery probability in order to have the same delivery rate as the one planned.

All Segment types that needs inventory reservations (Uniform, Quick, Forced) will be automatically adjusted by the system after the booking plan and will have priority in front of other type of Segments that do not require inventory reservation.

How to reserve inventory:

  1. Choose all the Media Spaces where the Segment will run and make all other targeting settings;
  2. Use "Reserve Inventory" to make inventory reservation for this Segment (the reservation process can take between a few seconds and 1 minute, depending on the Segment parameters) Order > Segment > Reserve Inventory;
  3. Check to see if the Inventory forecast is acceptable for the Segment and Save it;
  4. If you want to modify the Media Spaces, the booked inventory will be deleted and the Reservation must be done again. You can delete the inventory manually Order > Segment > Delete Inventory, or the system will do it automatically when you save the new Media Spaces configuration.

The inventory reservation can be rebooked at any time. The Ad Server System will calculate the running priorities after the current reservation numbers. If you rebook the Segment, the old inventory data will be deleted.

Note

The inventory reservation mechanism uses historical data so, in order to have available impressions for booking the media spaces (site - section - zone), you must first have traffic data (ads impressions) for at least a full week.

All inventory reservation modifications will go into effect at the beginning of the following hour.

2. Settings

All the advertising network settings can be managed from the Settings tab of the interface.

2.1 Accounts (Acc)

The Accounts section of the Ad Server can be found in the Acc tab under the left-hand side Settings menu option.

The Ad Server security architecture is based on a classical tree organization structure compounded by accounts formed by publishers, advertisers and users units.

An account is a collection of users with similar rights over functional entities like orders, sites, zones etc.

ad server organization structure
Network (Publisher) Is the primary container for Sites, Sections and
Zones (ad network).
Can own sub-networks composed by sites, sections
and ad slots.
Owns Advertisers accounts
and can manage and access all its Child
Account Objects.
Advertiser Can own sub-networks or advertisers.
Subordinate to one Network. Owns Orders and Creatives Library. Can
manage and access all its Child
Account Objects.

2.1.1 Publishers

The Publisher represents a collection of the following objects grouped under the same account:

Basically, the publisher account can manage sites and campaigns on media spaces belonging to him or to other subordinated publishers.

2.1.2 Advertisers

An Advertiser account is usually owned by a Publisher account. Its main scope is to group Orders (Campaigns) under the same authority with specific security rights.

Due to flexible security management rights Advertiser account and users can be easily configured to have access to complex rights like Order editing, Creatives entry and full Reports to only viewing certain global Reports.

An Advertiser account can be easily upgraded to a full Publisher account if necessary.

2.1.3 Users(logins)

Users can access the Ad Server by using their login credentials (email and password).

Each user is placed under the Account security context and can access almost all Account objects.

Users can be heavily customized to have different levels of access using the following sections under the Settings – Acc menu options:

2.1.4 User System Permissions

User access can be customized to different levels of functionality using the System Permission options under the Settings – Acc interface option.

2.2 Site

A Site is an abstract object that models a real website or a business entity with similar attributes.

The Site attributes are:

2.3 Section (Sec)

A Section is an abstract object that models functional or similar content section of a site (ex. a main site category like “sports” or a more generic “homepage” section).

The Section attributes are:

The User has to option to duplicate a specific section on all of his accounts;

Note

On every account, at least one section must be defined in order to book spaces in the Ad Media Spaces editing interface.

2.4 Zone

The Zone represents the abstract object that uniquely identifies an ad slot in a web page (or on any other media type).

The Zone attributes are:

Note

Each web page or media type can hold an unlimited number of zones. It is recommended to have only one distinct zone per page (unique Zone KeyID), although the system can also run with duplicated zones on the same page.

On every account at least one zone must be defined in order to book spaces in Ad Media Spaces editing interface.

2.5 Custom parameters (Pars)

The custom parameters can be used for a variety of custom targeting.

The Customer parameter attributes are:

Note

The system will use and always store the latest values of the custom parameters sent from the HTML ad tags.

Custom parameters are placed under Account security policy and can be used in Ad Media Targeting interface accordingly. Also, the values are stored attached on the Publisher from which the ad request is made and will be used on serving time in the same manner: an ad request from a site will have access only to the parameters set on the site account.

3. Ad Library

All the creatives owned by an Account can be found in the Ad Library. They are referenced by a unique assignment ID used to associate the creative with an Ad.

Every creative is build using one of the existing templates found in the Ad Server.

All of the Ad Server Ad Templates can be found HERE.

4. Reports

With our Reporting system you can get accurate and detailed reports of all your ad campaigns results in an easy and fast way. Also, the reporting engine can perform real-time data, accurate analysis on all system objects like ads, orders, publishers and sites.

Reports are conveniently designed to meet different business scenarios. You can find standard and dynamic reports such as: Order global, Ads by Media Spaces, Post Tracking analysis (conversions), Inventory forecast, Custom parameters analysis reports and others.

All standard reports can be scheduled by email daily or on custom time span interval and can be exported with Excel type applications.

Additionally, for business analysts, the Reporting Server comes with a more sophisticated OLAP engine where all system measures (impressions, clicks, revenues) can be analysed by a variety of dimensions, like Publisher, Site, Order, Segment, Client, Agency, Order type, Creative template in a fast way using Microsoft Pivot Table technology.

All access to reports and the date inside them are managed by the system rights policy and can be easily customized at user level. So, you can customize access specific to only some objects or to specific reports for every user login provisioned in the system.

4.1 Processing Cycle

Processing engines collect and process trafficking data from ad servers at the beginning of every hour so that the latency from real-time data is minimal. When the processing cycle ends, the aggregated data is pushed to the admin interface so you can see newly counts for every object in the system with a latency of maximum 1 hour and a half.

Additionally, a daily second processing cycle is used to count and report statistics like daily unique impressions for every order or ad. This process runs at the end of the day, when all the day’s trafficking data is available.

4.2 Counting methods

4.2.1 Impressions

An impression represents a unique creative visualization in a web browser context.

For all rich media templates that are served with Standard HTML tags for JavaScript, the ad impressions are counted using a client side 1x1 pixel image designated as a tracking request pushed to client browser after the ad creative script is outputted.

For Pop Up/Under and Transitional creatives, the tracking 1x1 pixel are displayed together with the creatives.

All these 1x1 pixel requests with 200 HTTP status code are collected on the ads web server logs and then analysed by the processing engine hourly.

4.2.2 Clicks

A click represents a unique user action on a creative in a web browser context.

The clicks are tracked with the Ad Server click handler that receives the click action from the creative and then redirects (302 HTTP) the user agent to the final destination of the advertiser.

All click requests are collected in the ads web server logs and then analysed by the processing engine hourly.

4.2.3 Fraud and Cache Filtering

The processing module extracts the impressions and clicks directly from the ads web server logs and before validation and assignment to the campaigns, a set of fraud and cache protection rules will be applied:

Additional to processing filters, a fraud elimination mechanism exists on serving time in order to ban manual requests for impressions and clicks.

4.3 Campaign reports

On the Orders tab of the Reports main module you can find a list with all the system campaigns on which current logged user credentials has access. The available reports can be accessed on entire Order level or even at Ad level.

Reports available for Orders and Ads:

  1. Global report: contains a wide range of data set, starting with general measures like impressions, clicks, CTR, total unique visitors and ending with detailed view of counts at ad, site, creative & zone, date, frequency per visitor, geographic and click reference levels. This report contains data from all running period of the campaign or ad.
  2. Media spaces report: shows data for an order or ad drilled-down by custom period with any combination of the followings: creative and network objects (publisher, site, section, zone);
  3. Post tracking (conversions) report: shows post tracking statistics grouped by reference with unique per day calculations; this report has data only if the Ad has the post tracking feature activated and successful post track request occurs;

Order reports are generated every hour after the end of hourly processing cycle and the unique visitors counts are updated at the end of the daily process cycle.

4.4 Discrepancies with 3rd party ad servers

When an ad server delivers ads that are hosted by a third party, small reporting discrepancies between the two systems may occur. For example, the publisher's ad server will initially count the impression and the third party will count the impression only after the ad is returned.

Discrepancies may also result from:

5. Help

The Help section of the Ad servers is used to raise new support tickets and also manage existing ones.

You can easily filter tickets by their ID, Opened user, title, category, status, creation date or Last update date.

You can raise a new Support ticket by pressing the Add new ticket button on the top-right hand side of the page.

The Issue title represents the title of the support ticket. A ticket must be included into one of the categories found under the Issue category dropdown before submitting.

It is best practice to add as many details as possible into the Issue Detail text field before submitting the ticket. (ex. Creative ID, Segment ID, Order ID). Screenshots, files or other archives can also be added to the support ticket by using the upload field found on the right of the text field.

Other users or relevant people can be added to the support thread using the Add to CC email field.

The Ad Server Knowledge base can also be found under this Section.

5.1 F.A.Q.

Q: How do I create an account and give reporting access to one of my suppliers?

To create a new sub-account, you must first navigate to your account’s settings page found under Settings (Setup) – Acc and press the New Account button in the Actions section of the page. A new Account setup page will be opened.

Please make sure that your account is marked as the owner of the new account under the Account Name and Type section. Fill in the Account name and press Save.

In order to create a new user for the new supplier account, press the New User button from the Actions section.

Fill in the First name, Last name and Email fields and set a Password (and Confirm password) for the new user. The password can be changed by the user later on.

In order to give the new user reporting access, please select the Reports – Reporting area option from the System permissions tab and add it to the list.

Under the Reports Permissions tab, check the desired options. The most common options are:

Under Sites Visibility you must add all the accounts or individual sites that the previously set reports will apply to.

Provide the new user with the Login URL either by using the Send by Email option or copying it and sending it directly. The Login URL can be found under the Quick login section of the page.

Q: I received a new creative in the form of an html file and some other additional files. How do I add it to the Ad Server?

When importing a creative into the Ad Server it is very important to choose the right template for the job (more information about the available templates can be found HERE).

Copy the .html file content into the HTML Content text field of your new ad and import all the other additional files into the ad’s Additional files section. Please make sure you follow the folder structure exactly and set all necessary Ad Attributes to the desired specs.

Quick tip!

Use the ad Preview option to see how your ad is being rendered on different screen sizes.

Q: I have imported my new ad but when I click it, nothing happens. What do I do?

If when clicking on your ad you are not redirected to your Destination URL, you must add the click macro to your HTML code. This can be done in two ways depending on the situation:

Q: I have assigned my ads on the _mobile zone but my ads aren’t showing. Why?

Please check that you have also implemented the adTag for that specific zone into the website page where you wish the ad to be delivered.

Quick tip!

A quick fix would be to change the suffix of the zone name from _mobile to _mob in Settings – Zone, as the Ad Server will change it automatically to _mob when the adTag is rendered into the page.

Q: I have created a new zone for my Account and assigned ads to it in an existing Inventory reservation type segment but it’s not delivering ads. Why is that?

In order for the System to be able to reserve inventory, it must first have a minimum of information about the websites it will reserve traffic from.

When creating a new zone for your Account, you must redo the inventory reservation for all the Inventory reservation type segments where the new zone will be assigned.

All the inventory reservation modifications will take effect at the beginning of the following hour. /p>

AdBuilder User Guide

AdBuilder Introduction

The AdUnity AdBuilder 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 AdUnity AdBuilder. Within the AdBuilder we have also included the AdUnity 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 AdUnity AdBuilder 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. AdUnity also recommends that AdBuilder users read the Glossary of Advanced Features to get the most out of the AdBuilder.

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 AdUnity AdBuilder.
  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 AdUnity AdBuilder 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 AdBuilder 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 AdUnity AdBuilder, 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 AdUnity AdBuilder has some of the industry’s most powerful tools to define and measure viewability. The AdUnity AdBuilder 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 AdUnity AdBuilder, 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 AdUnity AdBuilder, 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 AdUnity ad server will always count ad initialisations in the standard way.

AdUnity JavaScript Bridge (AUHtml5)

The AdUnity JavaScript Bridge is a powerful feature of the AdBuilder 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 AdUnity 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.

AUV User Guide

AUV Introduction

The AdUnity AUV is an easy to use web application that allows for quick video cutting and sharing designed to work with both livestream feeds and local files.

The AdUnity AUV allows users to have access to a video library generated from livestream video cuts based on a weekly schedule or even local files that can then be edited and shared. The tool was designed based on the needs of news professionals who wanted to be able to share parts of their live coverages and feeds on the spot without the need for powerful machines with dedicated video editing software and vaste amounts of storage space.

The AdUnity AUV tool uses the HLS protocol for improved speed and ease of use. HLS or HTTP Live Streaming is an HTTP-based media streaming communications protocol implemented by Apple Inc.. It works by breaking the overall stream into a sequence of small HTTP-based file downloads, each download loading one short chunk of an overall potentially unbounded transport stream. As the stream is played, the client may select from a number of different alternate streams containing the same material encoded at a variety of data rates, allowing the streaming session to adapt to the available data rate. At the start of the streaming sessions, HLS downloads an extended M3U playlist containing the metadata for the various sub-streams which are available.

The main purpose of the AdUnity AUVis to facilitate the editing and sharing process of video files from either livestream feeds and/or local files by automating part of the tasks and providing a sleek and easy to use web interface.

Livestream capture

AdUnity AUV can be set to automaticaly save video cuts from an online streaming video source based on a weekly schedule called the Cuts Schedule.

The cuts are automaticaly added the the User's Library and named accordingly to the name their were given in the Cuts Schedule section. A one day example from a Cuts Schedule can be seen in the following image:

auv cuts schedule

The video cuts generated from a similar schedule to the one pictured above will populate the user's Library and are easily recognizable by their blue background titles. These are labeled as Raw Stream cuts and are available for editing as soon as they are saved.

auv daily cuts

In order to edit a Raw stream labeled video, the user must first create a copy of the video by pressing the edit a copy button in the Library listing. This will create a copy of the desired cut labeled Raw stream edit that is available for editing.

auv video cut labels

Appart from the scheduled livestream cuts, the user can create a custom cut by selecting the Stream from live archive option from the Create dropdown menu. By selecting a stream from the left hand side menu, the user can select a Stream start date from up to seven days prior to the current date. The cut has a standard time frame of two hours. The end date is therefore autocompleted. Hitting the Save button will create a new Live Stream Edit labeled cut in the User's Library.

auv stream from live archive

Local file upload

Local files can be manually uploaded by the user. The file is added to the User's Library with a Video upload label and it's available for publishing imediatelly. Local file uploads are not available for editing.

In order to appeal to a higher number of devices, only videos converted to the mp4 digital format using the libx264 encoder can be uploaded into the AUV library. The maximum single file size upload is 250Mb.

Cuts editing

Both Raw Stream edit and Live Stream Edit labeled cuts can be edited by using the video editing tools found under the player section of every editable video cut.

The User can navigate through the video timeline either by using the mouse or the move forward/backward buttons under the video player. In order to remove or keep a specific section of the video, the User must mark both the beginning and the end of the desired section using the mark as selection start/end buttons and then either press the remove between markers button or the remove outside markers button accordingly.

auv video editing screen

A History of all the users' actions can be found on the right hand side of the page.

Publishing videos

Both Raw stream edit, Live Stream Edit and Video Upload labeled videos can be made available to the public domain by publishing them.

auv published label

After a video edit is published, it can be shared by using its Embed URL. The URL is obtained by pressing the published video's share button either while in the editing screen or in the Library listing. Published videos are marked with a green "Published" text followed by the date and hour when the respective video was published.

auv embed url

Both Raw stream Edit and Live stream Edit labeled video can be downloaded if the "On publish generate mp4" option is ticked before publising the video. The video file will become available for download after aproximatively 1-2 minutes and can be accessed by pressing the Download mp4 button. If the download is no longer needed, the downloadable mp4 file can be removed by pressing the Remove mp4 button.

auv embed url

Livestream to Facebook/Youtube

The User has the ability to start streaming the livestream feed directly to Facebook or Youtube by using the Facebook/Youtube live stream option under the Create dropdown menu.

This will create a Facebook live stream or Youtube live stream labeled item in the Library listing. The user must choose one of the two available options from the Publish url field (Facebook or Youtube) and provide a Stream key accordingly for the desired streaming platform.

The Stream start date and Duration (max. of 240min) can be set using their respective option.

The livestream can be managed by using the Start and Stop buttons provided in the interface. A Check status button and an Output log are also available for debugging purposes.

auv facebook or youtube livestream

Library Video labels

Depending on their origin or current state, videos are labeled as such:

Label Usage
Raw stream Video cut generated from the livestream feed based on the Cuts Schedule. Can be copied for edit.
Raw stream edit Copy of the Raw stream that is editable by the user. Can also be published and shared.
Live stream edit Custom livestream cut generated by the Stream from live archive option in the Create menu. Can be edited, published and shared.
Video upload Generated by the Video from file option in the Create menu. Can be shared.
Facebook live stream Library entry generated by the Facebook/Youtube live stream option from the Create menu. Is used to start a Facebook live stream from a livestream feed.
Youtube live stream Library entry generated by the Facebook/Youtube live stream option from the Create menu. Is used to start a Youtube live stream from a livestream feed.

Video player tag

Video player tag example:


<!-- Video player tag START -->
<div class="au-video"
    data-au-account="57100025007405" data-au-site="site.example"
    data-au-options='{"title":"Video title", "analytics":"UA-XXXXXXXX-X", "live":false}'
    data-au-sources='[
        {"src":"//stream.adunity.com/stream/playlist.m3u8", "type":"application/x-mpegurl"}
    ]'
    data-au-related='{"title":"Title of related article ", "url":"//www.related-article.html"}'
    data-au-ads='[
    ]'>
    <p>Video will appear shortly. Please disable your ad blocker if you have one.</p>
</div>
<script src="//content.adunity.com/aulib.js" async></script>
<!-- Video player tag END -->
            

Customizable video player tag parameters:

RTB Specifications

Adunity is fully compliant with IAB's OpenRTB 2.4 specifications and its Native subprotocol version 1.1. You can learn more about IAB's OpenRTB and Native subprotocol from the links below.

Banner BidRequest Example:


{
    "id":"6750528580817250",
    "imp":[
        {
            "id":"1",
            "banner":{
                "w":300,
                "h":250,
                "id":"123456789",
                "pos":3,
                "mimes":[
                    "text/plain",
                    "text/html",
                    "text/xml",
                    "image/jpg",
                    "image/jpeg",
                    "image/gif",
                    "image/png",
                    "application/x-shockwave-flash",
                    "application/javascript"
                ]
            },
            "instl":0,
            "tagid":"au_xgbTL8DiQff3e3C6Ete5aA+pA+wSIqYGTRk/RcH2apY=",
            "bidfloor":1.07163,
            "bidfloorcur":"USD"
        }
    ],
    "site":{
        "id":"123456789",
        "name":"site.com",
        "domain":"site.com",
        "page":"http://site.com/page.html",
        "ref":"https://www.site.com/category",
        "publisher":{"id":"123456789"},
        "content":{
            "id":"123456789",
            "url":"http://site.com/page.html",
            "context":"5",
            "sourcerelationship":1
        }
    },
    "device":{
        "ua":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:53.0) Gecko/20100101 Firefox/53.0",
        "geo":{"type":2, "country":"FRA"},
        "ip":"192.0.0.1",
        "devicetype":2,
        "os":"Mac OS X",
        "osv":"10.10",
        "js":1,
        "flashver":"23"
    },
    "user":{"buyeruid":"u123456789"},
    "test":0,
    "at":2,
    "tmax":350,
    "allimps":0,
    "bcat":["IAB25", "IAB26"]
}
            

Video BidRequest Example:


{
    "id":"99078430807759470",
    "imp":[
        {
            "id":"1",
            "video":{
                "mimes":[
                    "video/mp4",
                    "application/javascript"
                ],
                "minduration":1,
                "maxduration":120,
                "protocols":[2, 3, 5, 6],
                "w":640,
                "h":480,
                "linearity":1,
                "battr":[10, 11, 14],
                "maxextended":2,
                "minbitrate":50,
                "maxbitrate":12000,
                "boxingallowed":1,
                "pos":3,
                "api":[2]
            },
            "instl":0,
            "tagid":"au_UBpsrEtpuH6fzxuaKlrTKXzRu0XEvgkoF/I7Cj+gE4g=",
            "bidfloor":2.588439,
            "bidfloorcur":"USD"
        }
    ],
    "site":{
        "id":"123456789",
        "name":"site.com",
        "domain":"site.com",
        "page":"http://site.com/page.html",
        "ref":"http://site.com/category",
        "publisher":{"id":"123456789"},
        "content":{
            "id":"123456789",
            "url":"http://site.com/page.html",
            "videoquality":1,
            "context":"5",
            "sourcerelationship":1
        }
    },
    "device":{
        "ua":"Mozilla/5.0 (Linux; Android 6.0; VFD 1100 Build/MRA58K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.83 Safari/537.36",
        "geo":{"type":2, "country":"DEU"},
        "ip":"192.0.0.1",
        "devicetype":1,
        "make":"Generic_Android",
        "model":"VFD 1100",
        "os":"Android",
        "osv":"6.0",
        "js":1,
        "flashver":"0"
    },
    "user":{"buyeruid":"u123456789"},
    "test":0,
    "at":2,
    "tmax":350,
    "allimps":0,
    "bcat":["IAB25", "IAB26"]
}
            

Native BidRequest Example:


{
    "id":"6564004331957851",
    "imp":[{
        "id":"1",
        "native":{
            "request":"{\"ver\":\"1.0\",\"layout\":6,\"adunit\":503,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"title\":{\"len\":75}},{\"id\":2,\"required\":1,\"img\":{\"type\":3,\"wmin\":382,\"hmin\":200}},{\"id\":3,\"required\":1,\"data\":{\"type\":1,\"len\":35}},{\"id\":4,\"img\":{\"type\":1,\"wmin\":50,\"hmin\":50}},{\"id\":5,\"data\":{\"type\":2,\"len\":160}}]}",
            "ver":"1.0",
            "api":[2]
        },
        "instl":0,
        "tagid":"au_euuLP2Ah36xKhiCA8tRSOiHvy4Jl4zGQnwUhUtqdnfU=",
        "bidfloor":0.75,
        "bidfloorcur":"USD"
    }],
    "site":{
        "id":"123456789",
        "name":"site.com",
        "domain":"site.com",
        "page":"http://site.com/page.html",
        "ref":"http://site.com/category",
        "publisher":{"id":"123456789"},
        "content":{
            "id":"123456789",
            "url":"http://site.com/page.html",
            "context":"5",
            "sourcerelationship":1
        }
    },
    "device":{
        "ua":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36",
        "geo":{"type":2, "country":"ITA"},
        "ip":"192.0.0.1",
        "devicetype":2,
        "os":"Windows 7",
        "js":1,
        "flashver":"27"
    },
    "user":{"buyeruid":"u123456789" },
    "test":0,
    "at":2,
    "tmax":350,
    "allimps":0,
    "bcat":["IAB25", "IAB26"]
}