OpenX Tips

Great news! Erik Geurts and Matteo Beccati have combined forced, and released a patch for the contract campaign under-delivery bug in the OpenX 2.8.2!

You can find the patch attached to OpenX bug OX-5839.

Did you know that the OpenX ad server has a user log, which provides an audit trail of the changes made to the advertisers, campaigns, banners, websites and zones in your OpenX installation?

This can be an incredibly useful tool in diagnosing who changed what, when for larger users of OpenX, where you might have more than one person performing your ad server trafficking.

You can find the audit trail under the My Account > User Log tab.

The User Log

If you have more than one banner on a website page, it’s easy to ensure that you never show the same banner twice with the OpenX ad server.

Provided you are using Single Page Call, or the Javascript zone tag, the Local Mode zone tag or the XML-RPC zone tag, then under Tag Settings on the Invocation Code tab, you can set the “Don’t show the banner again on the same page” option, and OpenX will ensure that the same banner is not shown more than once on a page.

The "Don't show the banner again on the same page" option.

There is also the “Don’t show a banner from the same campaign again on the same page” option for Single Page Call and these three zone tags, which can be used to ensure that every banner on a page will be from a different campaign.

Of course, you can use both options if you want to ensure that not only is every banner on a page from a different campaign, but also that there are no duplicate banners.

OpenX supports a number of different banner types. However, as banner types can be disabled in OpenX, it may be that the banner type you want to use is not present when you go to create a banner.

If this is the case, then you may need to enable the banner type.

OpenX 2.4

While logged in as the administrator account, go to Settings > Main Settings > Banner Settings. Here, you will find the Allowed Banner Types section, where you can select which of the banner types are enabled.

OpenX 2.6 and 2.8

While Working as the Administrator account, go to Configuration > Global Settings > Banner Storage Settings. Here, you will find the the Allowed Banner Types section, where you can select which of the banner types are enabled.

The Allowed Banner Types in OpenX.

This week’s tip is something that seems to trip up a lot of new OpenX ad server users. If you can’t seem to link a banner to a zone, this tip is for you.

OpenX will not let you link a banner to a zone unless the banner dimensions match the zone dimensions and the banner type matches the zone type.

Banner types

There are only three different types of banners in OpenX:

• SQL / Webserver / External banners: These are all image or Flash-based banners; they simply have different storage locations¹.
• HTML banners: These are banners based on HTML and/or JavaScript code.
• Text banners: These are banners based on plain text (that is, no HTML markup).

Which type of banner you are using will have an impact on both how the dimensions of the banner are determined, and which zone type you can link the banner to.

Banner dimensions and zone dimensions

SQL and Webserver banners are image or Flash-based banners that you upload into OpenX (which are then stored either in the OpenX database, or are stored on your local web server’s directory). As a result of the fact that OpenX is able to inspect the image or Flash file when it is uploaded, OpenX can automatically determine the banner’s dimensions.

However, External banners cannot be inspected by OpenX; similarly, although HTML banners are stored in the OpenX database, OpenX cannot determine what the dimensions of your HTML/JavaScript code are. As a result, you need to specify the dimensions of all External and HTML banners in OpenX when you create them².

Setting the banner dimensions for an HTML banner.

Zones also have dimensions. Whenever you create a Banner, Button or Rectangle zone, an Interstitial or Floating DHTML zone, a Popup zone or an Email/Newsletter zone, you can select from a set of standard IAB banner dimensions, or you can enter your own dimensions.

Setting the zone dimensions.

In order to link a banner to a zone, the banner dimensions must be exactly the same as the zone dimensions. OpenX will not allow you to link a banner to a zone if the dimensions are not equal. This is a feature of OpenX, which means not only will OpenX ensure that you do not accidentally link, for example, a skyscraper banner into a rectangle zone (which would look rather odd on your site!), but also means that you can set up campaigns containing multiple banners of many different sizes, and then simply link the campaign to zones, and OpenX will figure out which banners to put into which zones.

The exception to the rule of banner and zone dimensions

Text banners and text zones are the exception to the rule, as they have no dimensions. Text banners and zones are used for displaying plain text banners, which are intended to be inserted into normal paragraphs of text on your site. As a result, there is no need for dimensions to be set at either the banner or zone level — the zone and banner will simply be as “high” and as “wide” as the text itself.

Wildcard zones dimensions

Sometimes, you know better than OpenX, and you need to link banners of different dimensions to a single zone. OpenX will let you do this, by using an asterisk as a “wildcard” when setting up a zone with custom dimensions.

You can use the wildcard for the height, the width, or both, depending on your needs.

A zone with "wildcard" width, and fixed height.

Banner type and zone type

To link a banner to a zone, the banner type must be suitable for the zone type (and vice versa). The following table lists all of OpenX’s banner and zone types, according to which types can be linked to each other.

As you can see, text banners and text zones are the odd types out; all other banner/zone combination are fine.

Happy banner/zone linking!

1. That is, SQL banners store the image or Flash-file data in the OpenX database; Webserver banners store the image or Flash data in a file in a directory on your web server; and External banners are where the image or Flash file is stored on some external system, and you simply provide the URL that the file can be loaded from. [↩]
2. OpenX 2.8 now, fortunately, requires these fields be filled in, so that you do not forget. However, older versions of OpenX did not have this requirement — so if you forgot to fill in the banner’s dimensions, if would often take frustrating minutes to figure out why it was not possible to link the banner to the zone. [↩]