E-Planning Header Bidder is an E-Planning’s proprietary technology that allows you to implement a header bidding system in a site in just a few clicks. This system consists in a unique generic code being implemented in every page, which automatically identifies the ad spaces and holds an auction among the different sources available in the network.

Content

How to Get the Code

The E-Planning Header Bidder code consists of a simple HTML tag that you must add to your site. This tag can be extracted from the platform by accessing the Implementation tab.

There are different code versions, depending on where they will be implemented:

Direct display in the site: Use this code if you will paste it directly in the HTML code of your site.
Google Tag Manager: Use this code if you will add it through a tag management tool like Google Tag Manager.
Video Instream (VAST): Use this code for video inventory auctions.

Remember that you also need to implement the lines in the ads.txt file correctly. Click here for more info about ads.txt.

Implementation

Direct display in the site

In order to make a direct implementation in your site, copy the code of the platform and paste it in the HTML code of your site.

How to Get the Code

Click on the Implementation tab (1). Within the Implementation for display chart (2) select Direct Implementation (3), copy the code shown below. (4).

You can copy the code directly to your Clipboard by clicking on the indicated option (5).

Implementation

Once you have extracted the code, you must plug it into the site pages or sites to be monetized within the <head> tag of the code. It is important that the code be implemented BEFORE the Ad Manager tag.

Tip

The code works asynchronously. This allows you to download the code without interfering with the normal site load time, thus avoiding latency issues that may affect the user’s experience.

Additional Settings

The code supports additional settings that can be adapted to particular situations of different sites, thus optimizing both experience and results.

We recommend you contact our Tech Support Team before applying any additional settings in order to assist you and enlighten you along the process. You can contact our tech team by clicking on the Tech Support icon located in the upper right corner of the screen.

usedivname Parameter

E-Planning Header Bidder identifies the Ad Manager placements through their names. However, if you use the same name for different placements, there might be some problems identifying each placement. In this case, the usedivname parameter commands E-Planning Header Bidder to use an alternative identification method based on the space container ID.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net" data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-usedivname="true">

timeout Parameter

E-Planning Header Bidder waits for the call to the googletag.display() method until the page loads fully or all Ad Manager placements are executed. If your site uses conditional calls to googletag.display(), then you might experience an additional latency, which may make the ads take longer to be displayed. You can set a specific waiting time for E-Planning Header Bidder to do this and to interrupt it if the waiting time is up. This process is made through the timeout parameter, which is set in milliseconds.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net" data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-timeout="1500">

ma Parameter

By default, E-Planning Header Bidder will auction off all placements of the page. The ma parameter allows you to limit the number of placements that will be bid on.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net" data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-ma="5">

be Parameter

You can avoid certain placements from being bid on. All you need to do is list them in the be parameter specifically or you can add any regular expression delimiting it with the symbol !.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net" data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-be='["/12345/slot1","/12345/slot2"]'>

gtimeout Parameter

The gtimeout parameter allows to extend E-Planning Header Bidder waiting time until the Ad Manager setup is completed.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net" data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-gtimeout="600">

disableinitialload Parameter

By default, the Ad Manager tag makes its setup, E-Planning Header Bidder stops its execution for a few milliseconds, auctions off the ad spaces, and then reactivates the spaces with no winning bid. However, it may be the case that Ad Manager be intentionally stopped during its implementation or else you wish to disable it until a particular event happens in the site. In this case, the disableinitialload parameter will command E-Planning Header Bidder not to interfere in the deactivation, activation and reload of the Ad Manager spaces.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net" data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-disableinitialload="true">

tip Parameter

In some cases, you may want to count the ads displayed by E-Planning Header Bidder through external tools. This modifier allows to add a counting pixel that will be executed every time an ad is displayed. You can add more external counting URLs by using an incremental index from 2 on at the end of the modifier, for example data-tip, data-tip2, data-tip3 .. data-tipN

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net"data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-tip="https://unaPrimerUrlDeConteoExterno.com" data-tip2="https://unaSegundaUrlDeConteoExterno.com" data-tip3="https://unaTercerUrlDeConteoExterno.com">

ss Parameter

In a normal execution, E-Planning Header Bidder verifies the DFP implemented spaces, and makes a unique request to their servers to start bidding.

When the ss parameter is added, the Single Slot mode is activated. When this mode is on, Ad Manager is stopped and all placements must be activated manually using the hbepl.callSingleSlot(<slot>) method, where <slot> is a reference to an Ad Manager slot. The moment this method is used, the placement in question will be auctioned off. This allows to make the placement addition asynchronously as they are requested by the site.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net" data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-ss="true">

<script>
	var slot = googletag.pubads().slots[0];
	hbepl.callSingleSlot(slot);
</script>

dkt Parameter

By default, all custom parameters (Key, value) applied to the Ad Manager spaces are captured and sent in the auction. There are implementations where these parameters are used for the connection between a third-party platform and Ad Manager, where the amount of data sent is quite large. If the dkt parameter is added with a "true" value then E-Planning Header Bidder will ignore these values.

<script src="https://i.e-planning.net/layers/hbdfp.js" id="hbepl" async data-sv="us.img.e-planning.net"data-sv="ads.us.e-planning.net" data-ci="xxxxx" data-dkt="true">

Google Tag Manager

Google Tag Manager applies certain limitations to the use of the E-Planning Header Bidder code. For this reason, you can extract a special code from the platform and plug it into Google Tag Manager.

How to Get the Code

Click on the Implementation tab (1). Within the Implementation for display chart (2) select Google Tag Manager (3), copy the code shown below. (4).

You can copy the code directly to your Clipboard by clicking on the indicated option (5).

This code is multi-protocol, so it will work in both secure (https) and non-secure (http) sites, using dynamically the protocol of the site where it is implemented.

Code Insertion in Google Tag Manager

In order to plug the code into Google Tag Manager, access the registration tag form by clicking on Tags (1.A) and then on New (1.B).

Within Tag Configuration, click on the tag type selection menu.

Select the option custom HTML.

Paste the E-Planning Header Bidder code for Google Tag Manager you extracted from the platform in the HTML container.

Click on Triggering to select a trigger.

On the Triggers list select Preview.

Click on Save to apply the changes.

The platform will ask you to enter a name for the code. Enter "E-Planning Header Bidder" and click on Save.

Click on Submit to apply the changes.

Enter the description of the changes you made and publish them. Write a description of the changes applied (10.A), in this case “Insertion of E-Planning Header Bidder". You may also add a comment if you wish so in (10.B). Then, click on Publish to apply the changes (10.C)

Refresh Ads

If you wish to refresh the page ads (Refresh) for the Display implementation, run the following method in Javascript:

hbepl.refresh()

This method will refresh all E-Planning Header Bidder spaces with Ad Manager, generating a new correlator value for Ad Manager.