OpenX 2.6 facilitates the quick and easy delivery of advertising onto your website. Before beginning our in-depth guide to all of OpenX’s functions, and to get you started as rapidly as possible, we would like to introduce you to the product’s key concepts.
N.B. If you are using an earlier release of OpenX, please use the documentation at http://www.openx.org/support/documentation.
The key concepts
How it works
Use the OpenX interface to:
So, those are the basics. Now we’ll begin the detailed guide to how you can get the most out of OpenX…
An advertiser is the owner of the advertising you display on a website. Advertisers run campaigns containing banners. You must create an advertiser before you can set up a campaign and add banners to it.
In the Advertisers & Campaigns page click the Add new advertiser link.
In the Basic information section, the following information is required:
In the Advertiser report section, select when (or if) to send emails to the advertiser:
See also: About users for information about linking a user to an advertiser account.
When you click the Next button, the Add new campaign page opens.
Note: You can change details for an advertiser at any time in the Advertiser properties page.
Campaigns are always owned by advertisers and you must create an advertiser before defining a campaign. A campaign contains a number of banners. These can share delivery settings, or different delivery settings can be assigned to each banner. Use the delivery settings to control the frequency and duration of ad delivery, the ad priority, and to limit the display of ads based on a variety of parameters.
The Advertiser properties > Campaign overview page contains:
When you create an advertiser, the Add new campaign page opens. Alternatively, when adding a campaign to an existing advertiser, click the Add new campaign link in the Advertiser Properties > Campaign overview tab. All settings for a campaign are optional and can be changed at any time.
If you do not enter a Name for the campaign, the campaign is given the name of the advertiser followed by "- Default".
In Inventory details, you can enter the number of ads to run, based on:
| To track when an ad view is converted, the administrator must enable conversion tracking in the My Account > Global Preferences tab. See also: the OpenX 2.6 Adminstrator Guide for information about global preferences. |
Under Contract details you can set start and end dates for the campaign and enter revenue information:
Priority information influences the delivery of banners for a campaign. The options available depend on other settings for the campaign.
Priority levels can be:
Distribution options are:
The following table lists the options available for different combinations of settings.
| Impressions, clicks or conversions booked |
Expiration date | Priority level(s) | Distribution |
| Set number | Date set | High | Automatic |
| Set number | Do not expire | Exclusive, Low | None |
| Set number | Do not expire | High | Daily total |
| Unlimited | Date set | Exclusive, Low | None |
| Unlimited | Date set | High | Daily total |
| Unlimited | Do not expire | Exclusive, Low | None |
| Unlimited | Do not expire | High | Daily total |
The Hide advertiser and websites option is useful, for example, when a publisher runs an ad at a 'blind' discount. Otherwise, the advertiser will never pay full price to advertise on that site again.
| If you use iFrame tags with this setting, the advertiser cannot discover the site name from the referrer domain. See also: iFrame tags. |
Tick the Companion positioning option to display only banners from the same campaign (simultaneously) on a page with multiple zones.
You can place a cap (or limit) on the number of times a visitor sees a campaign. You can cap campaigns in two ways:
OpenX records the number of views with cookies, and you can reset the cookie after a specified period by setting it in the Reset view counters after: field. If a visitor has disabled cookies, banners in capped campaigns will not be delivered to that viewer. If a visitor deletes existing cookies, the cookie count is reset to zero, and the visitor will see banners in this campaign until the limits are again reached.
See also: Zone delivery capping and Banner delivery capping.
Click the Save changes button when you add or change campaign settings.
You must link a campaign to zones on your website before you can deliver banners for the campaign.
See also: About websites and About zones.
You can either:
To link a campaign to a zone, select the zone in the Websites & Zones page. In the Zone properties > Linked banners tab, you can link the selected zone to a campaign or to an individual banner.
To link to a campaign:
OpenX lists all banners in the campaign that match the zone size and type. Each of these banners is linked to the zone through the parent campaign.
Important: If a banner you expect to see is absent from the list, check that its dimensions are compatible with the zone size. When an existing ad is updated, check the dimensions have not changed. If the banner is a different size, the link to the zone will break.
To link zones to a campaign, click the campaign on the Advertisers & Campaigns page. In the Campaign properties > Linked zones tab, select the zones you want to link to this campaign. When you click Save changes, the Banner overview page lists all the banners for this campaign. Zones that are compatible with the banner size and type are automatically linked through the parent campaign.
To check which banners are linked to a zone, select the zone in the Campaign properties > Linked zones tab. The Zone properties > Linked banners tab displays a list of the banners linked to the zone.
You can copy campaigns and move campaigns from one advertiser to another. Copying campaigns is an easy way to create multiple campaigns with similar properties.
In the Advertisers & Campaigns page, click the campaign you want to copy. In the Campaign properties page, click the Duplicate link in the left-hand navigation bar. After a brief pause, OpenX displays the new campaign with the name "Copy of campaign name". You can rename it and change the campaign properties. Click Save Changes when you are done.
You can copy a campaign for one advertiser and move it to another advertiser.
In the Advertisers & Campaigns page, click the campaign you want to move. In the Campaign properties page, select the destination advertiser from the Move to menu in the left-hand navigation bar. Click the arrow to start the move. After a brief pause, the page refreshes and lists the campaign under the destination advertiser.
A banner is any creative content that is displayed as an ad. Banners can be in many file formats, including .gif, .jpg, .png, .swf (Flash), JavaScript, text, and HTML. To display banners, link banners to zones on your website(s).
In the Campaign properties > Banner overview tab you can:
OpenX delivers three types of banner:
Image refers to a variety of file types. The following table lists the formats that OpenX supports:
| Media | File formats |
|---|---|
| Image | .jpg, .jpeg, .gif, .png |
| Flash movie | .swf |
| Quicktime movie | .mov |
| Real Media movie | .rpm |
You can serve these ads:
Select the appropriate server option when you add a banner to the system.
You can enter HTML code for banners such as plain text ads, forms, or banners with multiple images. You can also use HTML code from external ad networks such as Google AdSense.
Text ads are similar in style to Google Sponsored Links.
To add a banner to a campaign, click the Add new banner link on the Campaign properties > Banner overview tab.
See also: Adding Flash banners for additional requirements for adding Flash banners.
In the banner type drop-down menu, the first three options are different serving arrangements for image banners. See also: Banner types
Select one of the following options:
If the menu does not contain all options, it is possible that the system administrator deactivated the missing types.
More information: Contact your system administrator or refer to the Banner settings section of the OpenX Administrator Guide.
When you select an option, the page refreshes to display the form for this banner type.
To add a banner:
Enter the Destination URL to visit when a user clicks a banner, including the http:// prefix.
For all banner types, you can set the frame for the destination URL in the Target field. The default target, is _blank, opens the URL in a new window.
You can enter the following HTML attributes:
You can set the following additional options:
In the Comment field, you can enter comments and notes about the banner.
When you click Save Changes, the Delivery Options page is displayed.
You can copy banners and move banners from one campaign to another. Copying a banner is a quick way to create new banners with common properties.
In the Banner properties page, click the Duplicate link in the left-hand pane. After a brief pause, OpenX displays the new banner with the name "Copy of banner name". You can change the name in the Description field of the Banner properties page, and also change any other banner properties.
Once you have done this, click Save Changes.
In the Banner properties page, select the destination campaign from the Move to menu in the left-hand pane. Click the arrow to start the move. After a brief pause, the page refreshes and the banner is now listed in the Campaign overview page of the destination campaign.
OpenX provides two mechanisms to control the delivery of banners to target ads to make the most of your inventory. You can set delivery limitations to ensure that banners are only delivered if certain conditions are met, and you can use delivery capping to limit the number of times a banner is shown to a visitor.
Use delivery limitations, for example, to display banners only to visitors from a certain country and only at certain times of day. Or you could target an entertainment venue ad to visitors who were referred by an events listing page, showing different versions on different days of the week. The range of limitations is extensive, and you can combine limitations for even more effective targeting. You can also divide your website into channels, such as 'sport' and 'news', and set delivery limitations for these channels.
Visitors tend to become "blind" to ads the more often they see, and become increasingly less likely to respond as a result. You can cap the number of times you show the same ad to a visitor, and instead show alternatives that might have more impact. You can also cap the number of times a visitor is shown any ad from the same campaign.
This page describes the following delivery options:
See also: Delivery limitations example for an example of using various limitations to target your advertising.
To set delivery limitations, in the Banner Properties > Delivery Options tab, select the limitation you want from the drop-down menu. You can limit banner delivery based on:
You can combine delivery limitations to target your ads even more effectively.
You can target ads based on the visitor website in a number of ways:
See also: About channels
With geotargeting, you can target ads to visitors from a specific location. Geotargeting uses a GeoIP database from MaxMind. OpenX can check the IP address of a visitor against this database to determine the visitor's location. MaxMind provides a free database that targets by country or continent, and you can buy additional databases to target more specifically (for example by city or ISP).
Geotargeting is not enabled by default in OpenX, and must be enabled by the administrator before it appears in the Delivery limitations menu. To enable free geotargeting, in the My Account > Global settings tab select the Geotargeting Settings option from the drop-down menu and click the arrow. Select MaxMind GeoIP as the Geotargeting Module Type. This option automatically enables the free version of the MaxMind GeoIP database, and the Geo - Continent and Geo - Country options will appear in the menu of delivery limitations.
Important: You must be Working as an administrator to view the Global preferences page which includes the Geotargetting Settings. If you do not have administrator access, contact your administrator for assistance.
Traffic patterns to your website probably vary a lot depending on the hour of the day and day of the week. You can use delivery limitations to:
When a visitor requests an ad, information about the visitor's client is passed with the request. You can use this information to:
You can place a cap (or limit) on the number of times a visitor sees a banner, campaign or zone. This is an effective way to increase click-through rates as visitors are most likely to click on an ad the first few times they see it.
There are two ways to cap banners:
OpenX records the number of views in cookies. You can reset the views total after a specified period by entering a value in the Reset view counters after: field. If a visitor has disabled cookies, capped banners will not be delivered to that viewer. If a visitor deletes existing cookies, capping information is reset to zero and the visitor will continue to see the banner until the limits are again reached.
See also: Adding a campaign for information about delivery capping at the campaign level.
You can use delivery limitations to constrain delivery of ads in a large number of ways. These examples show how you can combine limitations to target ads more effectively:
To set delivery limitations for a banner, either:
This example limits delivery to visitors on a certain page, for example to advertise tickets to visitors on an events listing page. The tickets are only on sale on the day of the event which happens every Friday night. You can add a second limitation to restrict the ad to deliver on Friday only.
To limit delivery to the events listing page:
The banner will be displayed only to visitors to the events page and will not appear on other pages on your website. Alternatively, if you selected the is different from option, the banner would never display on the events page again.
To restrict delivery to Fridays only:
If you wanted to be even more precise, you could set a third limitation and use the Time - Hour of day option to stop showing the ad an hour before the event starts.
To use geotargeting, you must have enabled geoIP targeting. Refer to the Geotargeting section of banner delivery limitations. After you enable geotargeting, these options appear in the delivery limitations drop-down menu. To limit by country:
After you create a zone, you can link banners to it. Only linked banners are displayed in a zone. You can link banners and zones in two ways:
You can link individual banners to zones, or link them as part of a campaign. See also: Linking campaigns to zones.
In the Zone properties > Linked banners tab, you can link a selected zone to a campaign or to an individual banner.
To link a zone to a banner:
The page refreshes and the banner is listed in the Banners linked to this zone section.
Important: If a banner you expect to see does not appear, check that the banner and zone dimensions are compatible. When updating an existing ad, do not change the dimensions; a change in dimensions can break the link to the zone.
The Banner properties > Linked zones tab lists all the zones that are compatible in size and type with the selected banner. Select the zone or zones you want to link to this banner and click Save changes.
OpenX is used to manage advertising on websites. A website owner defines areas (zones) on a website that are reserved for displaying advertising.
To begin serving ads, you must first define at least one website. Typically, the first website you create within OpenX represents your own website. You can create additional websites within OpenX for each of the websites that you manage, or for partner websites that use your ad server but are not under your control.
Once you have created your website, you can link users to it and define which activities they can perform, for example creating zones and generating tags to add to a website’s pages. You can also divide your website into channels for different categories of ad, such as 'entertainment' or 'sport'.
See also: About channels, About users
To add a website to the system, click through to the Websites & Zones page, click the Add new website link. In the Add new website page:
When you have completed these steps, click Save Changes. OpenX then displays the Zone overview page where you can set up zones for the website(s) you have added.
You can give the website manager access to view and manage various aspects of the website on the system in the Website properties > User Access tab.
See also: About users
Single page call is a simple, JavaScript invocation method that uses a single HTTP request to deliver multiple banners to a web page. Instead of making several calls to the adserver for pages with multiple ads, a single call loads the page much faster, without the delays associated with rendering each zone individually.
You generate invocation code for a single page call at the "website" level, rather than at the "zone" level. In the Websites & Zones -> Website properties -> Invocation Code tab, begin by setting various options for the invocation code.
The following table describes the ad delivery options you can set for single page call.
| Parameter | Description |
|---|---|
| Don't show the banner again on the same page | Tick Yes if you do not want to show the banner more than once on this page view. |
| Don't show a banner from the same campaign again on the same page | Tick Yes if you do not want to show any other banner from this campaign on this page view. |
| Target frame | This value sets the HTML TARGET attribute in the ad code. The Default option opens the target page in a new browser tab. Alternatively, you can change it to open in a new window or in the same window. |
| Source | The source variable is used for targeting ads and can be any string. Delivery limitations (Site:Source) can match against this value and, generally, the value is different for each section or page on your site. _See also: Banner delivery limitations. |
| Show text below banner | Tick Yes if you want to display text below a banner. Enter this text in the Banner properties page. |
The following table describes the code generation options you can set for single page call:
| Parameter | Description |
|---|---|
| Include <noscript> tags | This option appends backup <noscript> tags to each of the ad code blocks and is on by default. |
| Generate code for use on SSL pages | This option creates tags which will not generate security warnings when served on SSL pages. |
| Include comments | Removing comments from the ad code reduces the amount of code in your web pages. However, before you remove comments, review them carefully because they contain important information about the code. After you have set and reviewed the comments for all optional parameters, you can then tick No to remove them. |
When you have set all the options you require, click Generate to create code blocks for you to insert into your web pages.
Single page call generates two types of code block:
The script call must be included on every page which contains ads and must appear before any code blocks are called. For this reason, OpenX recommends that you place the <script> call in the HTML <head> tag. You use the same script call for every page with ads on your site.
Example <script> tag:
As well as generating the script call, the invocation code page creates a code block for every zone on this website. Place these code blocks in the site HTML at the point where you want the banner for each zone to display.
Example ad code block:
This standard usage limits you to placing each zone once only in the HTML for a web page because, with no additional requests necessary to reuse a code block, any repeats of the code block will deliver the exact same banner, again and again.
To overcome the limitation of being unable to reuse code blocks in a web page, single page call includes an advanced feature called "named zones". To use named zones, define a list of name and zoneid pairs in a JavaScript array before the <script> call, and use these identifiers in the code blocks.
Using the named zones mechanism, you can define different names which request the same zoneid. You can also optimise the named zones array to fractionally improve performance by only requesting the zones that are present on the page.
The format of the named zone array is:
Note that both Banner - top and Banner - bottom set the same zone ID, but this mechanism will re-select an ad for the Banner - bottom position.
To use the named zones feature, you must use the "names" in the OA_show(zone) function in the ad code block for each zone.
Zones are spaces on your website used for displaying ads. A zone can be a single space on a specific page, or a space on multiple pages which shows the same collection of banners. Zones are part of a website. You must create a website before you can define its zones.
When you link banners and campaigns to zones, OpenX creates bannercode you can copy into your website to start serving ads.
OpenX supports a wide range of zone types. When you create a zone, you first select which type you want. This selection influences the types of zone invocation tags you can create to place in your web pages. This page describes the zone types and the tags they support.
A zone can be one of the following types:
Each zone type is explained in more details in the relevant zone type page in this guide.
The most common zone type is used to display banners (including buttons and rectangles). In the Invocation code tab for the zone, select an option from the Banner invocation drop-down menu and click the arrow to update the contents of the Bannercode text box with this specific tag. There are no set rules on which tag type to use - just choose the one that is best suited to your website and ad serving environment.
See also: Zone tags, which describes the different tag types and associated optional parameters.
Set any optional parameters you want to use and click the Refresh button to update the bannercode. When you have set all desired parameters, copy and paste the bannercode into your web pages or website templates.
Email zones display banners in email newsletters. There are a number of constraints on these zones:
See also: Zone tags which describes the No Cookie Image Tag and associated optional parameters.
Set any optional parameters you want to use and click the Refresh button to update the bannercode. When you have set all desired parameters, copy and paste the bannercode into your email newsletter template.
JavaScript is the only zone tag you can use with pop-up zones. These zones have some special parameters you can set in addition to the optional parameters described in the Zone tags page.
The additional parameters for pop-up zones are:
| Parameter | Description |
| Initial position | Enter the offsets in pixels from the top left of the window for the ad to appear. |
| Pop-up type | Pop-up displays on top of the web page and Pop-under displays behind the browser, for example if you want the ad to appear when the user closes the browser. |
| Automatically close after | For a pop-up ad, you probably want the ad to close after a number of seconds. For a pop-under ad, you probably do not want to close the window automatically. |
| Instance when the pop-up is created | The pop-up can appear immediately, after the page closes or after a set period of time. |
| Window options | With these options you can set the standard controls available in a browser window. |
Set these and other optional parameters and click the Refresh button to update the bannercode. When you have set all desired parameters, copy and paste the bannercode into your web pages or page templates.
Text ad zones display text ads. In the Invocation code tab for the zone, select an option from the Banner invocation drop-down menu and click the arrow to update the contents of the Bannercode text box with this specific tag. There are no set rules on which tag type to use - choose the one that is best suited to your website and ad serving environment.
See also: Zone tags, which describes the different tag types and associated optional parameters.
Set any optional parameters you want to use and click the Refresh button to update the bannercode. When you have set all desired parameters, copy and paste the bannercode into your web pages or website templates.
JavaScript is the only zone tag you can use with interstitial or floating DHTML zones. There are four types of interstitial or floating DHTML zones, and each has some special parameters you can set in addition to the optional parameters described in the Zone tags page. Select the type of interstitial zone you want to use from the Style menu on the Zone properties > Invocation code tab.
Set the special and other optional parameters and click the Refresh button to update the bannercode. When you have set all desired parameters, copy and paste the bannercode into your web pages or page templates.
The interstitial or floating DHTML zones are:
This type of zone is suitable for a splash page that appears on top of a web page and disappears after a set period of time. The additional parameters for these zones are:
| Parameter | Description |
| Horizontal alignment | Set the ad to appear at the left, center or right of the web page. If the user resizes the browser, the position of the ad adjusts accordingly. |
| Vertical alignment | Set the ad to appear at the top, middle or bottom of the web page. If the user resizes the browser, the position of the ad adjusts accordingly. |
| Show close button | Select Yes if you want to enable the user to close the ad. |
| Automatically close after | If you want the ad to close automatically, enter the number of seconds before it closes. If you do not enter a value, the ad does not close. |
| Banner padding | This value defines the padding between the banner and the interstitial layer that contains it. The default value is 2 pixels. |
| Horizontal shift | Use this value to provide a more precise definition of the location of the interstitial, for example to set it to appear 10 pixels from the left of the window if you set the horizontal alignment to left. |
| Vertical shift | Use this value to provide a more precise definition of the location of the interstitial, for example to set it to appear 10 pixels from the top of the window if you set the horizontal alignment to top. |
| Background colour | This value defines the color of the interstitial that contains the banner. The default colour is white. You can select an alternative colour using the colour picker provided. |
| Border colour | This value defines the colour of the 1 pixel border that surrounds the interstitial. The default colour is black. You can select an alternative colour using the colour picker provided. |
| Transparent background | Tick the checkbox if you want the interstitial that contains the ad to be transparent. |
| No border | Tick the checkbox if you want the interstitial to have no border. |
This type of zone is suitable for an ad that moves across a web page to disappear at the far side, or "loops" across the screen on a regular basis. The additional parameters for these zones are:
| Parameter | Description |
| Horizontal alignment | Set the ad to appear at the left, centre or right of the web page. If the user resizes the browser, the position of the ad adjusts accordingly. |
| Vertical alignment | Set the ad to appear at the top, middle or bottom of the web page. If the user resizes the browser, the position of the ad adjusts accordingly. |
| Show close button | Select Yes if you want to enable the user to close the ad. |
| Automatically close after | If you want the ad to close automatically, enter the number of seconds before it closes. If you do not enter a value, the ad does not close. |
| Banner padding | This value defines the padding between the banner and the interstitial layer that contains it. The default value is 2 pixels. |
| Horizontal shift | Use this value to provide a more precise definition of the location of the interstitial, for example to set it to appear 10 pixels from the left of the window if you set the horizontal alignment to left. |
| Vertical shift | Use this value to provide a more precise definition of the location of the interstitial, for example to set it to appear 10 pixels from the top of the window if you set the horizontal alignment to top. |
| Background colour | This value defines the color of the interstitial that contains the banner. The default colour is white. You can select an alternative colour using the colour picker provided. |
| Border colour | This value defines colour of the 1 pixel border that surrounds the interstitial. The default colour is black. You can select an alternative colour using the colour picker provided. |
| Transparent background | Tick the checkbox if you want the interstitial that contains the ad to be transparent. |
| No border | Tick the checkbox if you want the interstitial to have no border. |
This type of zone is suitable for an ad that appears by the user's mouse cursor and follows the cursor as it moves.
| Parameter | Description |
| Smooth movement | If you select Yes the banner does not "chase" the cursor, but moves smoothly in its track at a predetermined speed. If you select No the user cannot click the banner. |
| Speed | This setting controls the speed at which the banner follows the cursor. It is available only if you select the Smooth movement option. |
| Hide the banner when the cursor is not moving | If you do not select Yes, the banner will obscure the page content when the cursor is not moving. |
| Delay before banner is hidden | This setting is only available if you select to Hide the banner when the cursor is not moving. |
| Transparency of the hidden banner | This setting is only available if you select Hide the banner when the cursor is not moving, and you can obscure it up to 90%. This setting only works with Internet Explorer 5.5 or above. |
| Horizontal shift | This value indicates the horizontal offset of the banner from the cursor. The default value is 10 pixels. |
| Vertical shift | This value indicates the vertical offset of the banner from the cursor and the default value is 10 pixels. |
This type of zone is suitable for an ad that is similar to those that appear on Geocities pages. These banners appear at the top of a web page and contain buttons the user can click to collapse and close them.
| Alignment | Set the ad to appear at the left, centre or right of the web page. If the user resizes the browser, the position of the ad adjusts accordingly. This setting applies to horizontal alignment only, as all of these types of ads appear at the top of the page. |
| Close text | This text appears under the ad. When the user clicks the text, the interstitial collapses. |
| Automatically collapse after | If you enter a value in seconds in this field, the interstitial will collapse after this period. |
| Banner padding | This value defines the padding between the banner and the interstitial layer that contains it. The default value is 2 pixels. |
To add a zone, in the Website properties > Zone overview tab, click the Add new zone link. In the Add new zone page, follow these steps:
When you finish defining the zone, click the Save Changes button. OpenX opens the Advanced page, where you can specify additional properties for the zone.
After setting up a zone, select the Zone properties > Invocation code tab in order to generate an ad tag. You will then paste the tags into HTML pages which invoke (call) OpenX to deliver ads. The types of tags available depend on the type of zone you set. The tag types (listed in the order of popularity) are:
When you select the tag type, you can set various optional parameters which change the Bannercode for your zone. These parameters vary depending on the type of zone and the type of zone tag you use. The following table describes these parameters and which tags use them. Popup and Insterstitial zones have a number of additional parameters which are desribed on the Popup zones and Interstitial or Floating DHMTL zones pages. If a tag is not available in the drop-down menu, it is possible that the system administrator has disabled this tag type for the server. Contact your administrator for more information.
| Parameter | Description | Used by which tag types? |
| Target frame | This value sets the HTML TARGET attribute in the bannercode. The Default option opens the target page in a new browser tab, or you can change it to open in a new window or in the same window. | All |
| Source | Enter a source value if you want to limit banner delivery based on source, such as sports or news. See also: Banner delivery limitations. | All |
| Support 3rd party server clicktracking | Use this setting to track clicks in OpenX for ads served on an external ad server. See also: The 3rd Party Click Tracking White Paper on the OpenX developer zone. | All |
| Insert cache-busting code | JavaScript tags automatically insert a random number into the invocation code to ensure that an earlier banner is not delivered from the browser cache. With all other tags, to avoid ad caching, you must enter this manually into the tag and tick Yes. | All |
| Include comments | Removing comments from the bannercode reduces the amount of code in your web pages. However, before you remove comments review them carefully, because they contain important information about the code. After you have set and reviewed the comments for all optional parameters you can then tick No to remove them. | All |
| Show text below banner | Tick Yes if you want to display text below a banner. Enter this text in the Banner properties page. | JavaScript, Local mode, XML-RPC |
| Don't show the banner again on the same page. | Tick Yes if you do not want to show the banner again on this page view. | JavaScript, Local mode, XML-RPC |
| Don't show a banner from the same campaign again on the same page. | Tick Yes if you do not want to show any other banner from this campaign on this page view. | JavaScript, Local mode, XML-RPC |
| Store the banner inside a variable so it can be used in a template | This option enables you to use local mode to display banners in site templates. If you tick No and use a site template, the banner will display before the rest of the page loads. | Local mode |
| Host language | PHP must be running on the remote host. | XML-RPC |
| Use HTTPS to contact XML-RPC Server | Tick Yes if you want to connect to a secure server using HTTPS. | XML-RPC |
| XML-RPC timeout (seconds) | Set the number of seconds to wait for a response from the server. | XML-RPC |
| Refresh after | To automatically refresh a banner, specify the number of seconds between each reload. After each refresh, a new banner from your zone is displayed. | iFrame |
| Resize iframe to banner dimensions | This option is only available if your website and OpenX are on the same top level domain. In this case, it is possible to show banners of different sizes in a zone and the iFrame will resize to fit. | iFrame |
| Make the iframe transparent | This option works only with Internet Explorer 5.5 or higher. | iFrame |
| Include Netscape 4 compatible iLayer | Because the Netscape 4 iLayer does not work well with tables, do not place the banner in a table cell if you are using this option. | iFrame |
| Include code to track Google AdSense clicks | Tick No if you do not want to track these clicks. | iFrame |
In the Advanced tab of the Zone properties page, you can set the following properties:
Sometimes a zone cannot display an ad because it is not linked to any active banners, or because delivery limitations prevent it from doing so. To stop this happening, you can create a chain of zones. In a chain of zones, if it is not possible to display a banner for the zone then a banner from another zone can be used.
If you select Stop delivery and don't show a banner, an empty space appears on the website if no banners can be displayed for this zone.
If you select Display the selected zone instead and select a zone from the drop-down menu, OpenX will display a banner from that zone if no banners can be displayed for this zone.
Note: Only zones from the same publisher are available in the menu, unless you made zones for another publisher public.
You can place a cap (or limit) on the number of times a visitor sees a zone. You can cap zones in two ways:
OpenX records the number of views with cookies. You can order the cookie count to reset after a specified period by setting it in the Reset view counters after: field. If a visitor has disabled cookies, banners in capped zones will not be delivered to that viewer. If a visitor deletes existing cookies, the cookie count is reset to zero and the visitor will see banners in this zone until the set limit is again reached.
You can generate additional HTML when a banner is delivered for a zone, for example to show another form of banner (e.g. a popup). This code is executed each time a banner from this zone is delivered. You can enter your own HTML code, or paste code from a supported ad network.
For text ad zones, you can prepend and append HTML to the text ad to determine the layout of the ad.
If you set the Append even if no banner is delivered option to 'Yes', the additional code is delivered even when no banner is delivered.
The Zone properties > Probability tab lists all banners currently considered for delivery in a zone. To change the likelihood of delivering a banner, change the 'priority level' of the campaign or change the 'weight' of the banner.
Important: These changes not only affect this zone but all zones linked to the banner or campaign.
If no banners are currently considered for delivery, the list will be empty unless the zone is chained with another. If a chain is set, the list can contain banners that are not linked to this zone, but which are likely to be shown.
Channels are a convenient way of defining different content sections of a website and applying a separate set of delivery limitations for each channel. Channels are useful when advertisers want to target specific visitor interests, for example entertainment or sport.
There are 2 types of channels:
To create a channel, follow these steps:
In the Website properties > Channels overview tab, click the Add new targeting channel link.
Set yourself to be Working As a Manager type of account. Click My Account and then the
In the Name field, enter a suitable name for the channel, for example "entertainment". This value must match the Source value you enter when you generate the tag for a banner linked to a zone. You can also add Description and Comments for the channel.
See also: Zone tags
When you click Save Changes, the Delivery options page appears and you can set delivery limitations for the channel. To set these limitations, follow the same procedures described in Banner delivery options.
After you create a set of limitations for the channel, it becomes available for selection when setting delivery limitations for banners that are linked to zones on the selected website. To apply the channel limitation to a banner, select the Site - Channels option in the delivery limitations section for the banner and select the channel from the list of available channels. All limitations you set for the channel are then applied to the banner.
When you are creating the tag for a zone to add to your web pages, enter the same value in the Source field as the name of the channel, e.g. "entertainment".
You can also set a channel at "agency" level. You must be working as a manager user to perform this task.
Direct selection is a way to manage delivery of your inventory without using websites and zones. To use direct selection, you create a selection string and place it directly in the ad tag. The selection string instructs OpenX which banners to consider for delivery.
Direct selection is more flexible and more powerful than using zones to select banners for delivery. However, there is a disadvantage: because the selection is made from within the ad tag, you must change the tag any time you want to change the selection. Direct selection is also more difficult to implement on your website, and is intended for advanced users only.
See also: The Direct Selection tutorial provides guidelines on using this delivery technique.
When you login to OpenX as an administrator or manager, the Home page launches.
| If you login as an advertiser or website user, the Home page tab does not appear. |
This page presents a dashboard-style, at-a-glance view of information about your activities, and about activities in the OpenX community. Each section (widget) provides information on a specific topic:
You can move these widgets around the Home page. To move a widget, click on it and drag it to a new location. Or you can remove a widget from view by clicking on the Close button (X) on the top-right corner of the widget. The widget no longer appears on the Home page. To restore a widget to view, click the More Widgets link on the top right and drag it back into the Home page.
A user is any person who uses the OpenX interface and has a username and password with which to log into the OpenX installation. A user is linked with at least one OpenX account, and can be linked with a number of accounts. A user can have multiple roles for different linked accounts. Each role has its own set of permissions, which define the actions a user can perform on the associated account.
The user roles in OpenX are:
The following table describes the permissions associated with each user role.
| Role |
Permissions |
2.4 equivalent |
|---|---|---|
| Administrator |
Server administrator rights
|
Administrator |
| Manager |
Account manager rights
|
Agency |
| Website |
Website rights can include any of:
|
Publisher or affiliate |
| Advertiser |
Advertiser rights can include any of:
|
Advertiser or client |
It is not necessary to logout of OpenX and then log back in to move from one user role to another. To change user roles, select this option from your list of roles in the Working as menu (on the top-right of the screen).
The role of a user depends on the entity you link to the user.
To link a user to a manager account and provide this user with manager permissions:
To link a user to an advertiser and provide this user with advertiser permissions:
To link a user to a website and provide this user with website permissions:
To view and change user preferences for a specific role:
An account is an entity within OpenX that "owns" various other entities, such as campaigns, banners, websites, zones, and even other accounts. OpenX has four types of account:
An account can have one or more users linked to it, and a user can be linked to one or more accounts.
In the My Account tab, you can view the account settings and user log for your current role. Change your role to view these settings for other user roles.
The My Account tab provides access to various preferences associated with a user. The options in the My Account tab vary, depending on the current user role.
| Preference |
Settings |
Advertiser |
Website |
Agency |
Administrator |
|---|---|---|---|---|---|
| User preferences |
Change name, language, email address or password |
X | X | X | X |
| Account preferences |
Manage banner, email report, tracker, timezone and UI settings | Limited |
Limited |
X | X |
| Global settings |
Manage global settings for banners, conversion tracking, database, debug logging, email. geotargetting, maintenance, synchronization and UI. |
- |
- |
- |
X |
| Maintenance settings |
Check maintenance is running, check banner cache, recalculate priority, move images from database to server and synchronize delivery limitations. |
- |
- |
- |
X |
See also: About users and refer to the Adminstrator Guide for information about Global settings and Maintenance settings
The My Account > Account Preferences tab is visible to all administrator and agency users, and can be visible to advertiser and website users depending on the permissions assigned to them. In the Account Preferences tab, select a preference type from the drop down menu to view and change its settings. The preferences you can manage are:
Note: The options available to advertiser and website users are limited to those that are relevant to these roles, and to the permissions set for specific users.
You can manage the following banner preferences:
You can control when email alerts about campaigns are sent to administrators, agencies and advertisers warning when a campaign is about to end. The preset values are to send alerts when 100 impressions remain in the campaign, and when the campaign is due to expire in one day. Settings that are not relevant to the user role are disabled.
Tracker preferences are visible to administrator and agency users only, and include the following settings to manage conversion tracking:
You can also apply conversion tracking for all by campaigns by ticking the Link newly created campaigns by default checkbox.
To change the timezone for a user, select an alternative timezone from the drop down menu.
With the user interface preferences you can control the display of various types of information in OpenX, including:
In the Reports tab you can generate a range of reports which can be downloaded in Excel file format. The following reports are available:
To create a report, click on the link for the relevant report and then:
Req: requests (user requests an ad; by default this is not logged)
Impr: impressions (user requests an ad, and ad is delivered to user)
Clicks: click
Ctr: click through ratio
Conv: conversion (sale)
Pend conv: pending conversion (not approved)
Impression SR column: sale ratio: ratio of sales to impressions
Click SR column: sale ratio: ratio of sales to clicks
Rev: revenue
Cost: media cost
Num.Items: the number of items inside a conversion (i.e. when you sell two books in one sale)
Tech Cost: tech cost of a banner
Income: revenue minus technology cost
Inc. Margin: income/revenue
Profit: (revenue) minus (technology cost) - (cost)
Margin: gross profit/revenue
ERPM: (revenue/impressions * 1000)
ERPC: (revenue/clicks)
ERPS: (revenue/conversions)
EIPM: (income/impressions * 1000)
EIPC: (income/clicks)
EIPS: (income/conversions)
ECPM: (cost/impressions * 1000)
ECPC: (cost/clicks)
ECPS: (cost/conversions)
EPPM: (profit/impressions * 1000)
EPPC: (profit/clicks)
EPPS: (profit/conversions)
Show ERPM column: effective revenue per thousand impressions (e.g. 1,000,000 imps -> 1,000 clicks -> 10 sales @ $100/sale => 10*$100 / 1,000,000 per imp)
Show ERPC column: effective revenue per click
Show ERPS column: effective revenue per sale
Show EIPM column: effective income per thousand impressions (subtracting costs, like technology costs and generating net amounts)
Show EIPC column: effective income per click
Show EIPS column: effective income per sale
Show ECPM column: effective cost-per-thousand impressions (e.g. 1,000,000 imps -> 1,000 clicks -> 10 sales. Cost per imp = 0.01c : 0.01*1,000 = 10c)
Show ECPC column: effective cost-per-click
Show ECPS column: effective cost-per-sale
EPPM: effective profit per thousand
EPPC: effective profit per click
EPPS: effective profit per sale
OpenX provides a wide range of statistics to help advertisers and publishers understand the effectiveness of advertising campaigns, and where ads are placed on websites. Statistics are gathered each time the maintenance script runs.
Select the Statistics tab to view statistics for today (the default setting), or select the Specify dates option and enter dates in the date fields. There are three overviews of statistics:
For each advertiser and website, you can view the following:
When you click on specific advertisers, campaigns or websites, additional tabs are displayed which provide more detailed statistics. Some tabs include links to Export statistics to Excel.
The OpenX administrator can define the information available in the statistics screens.
See also:Account Preferences to learn how additional items can be included in reports.
Note: All statistics refer to figures compiled since you originally defined each advertiser or publisher.
When you click the Statistics tab, OpenX displays today's statistics for all of your current advertisers. Change the date period to view statistics for another period, such as last week or month.
Expand information for an advertiser to view their campaigns. To view statistics for a specific campaign, click on the campaign. You can now view the following campaign statistics for the selected period:
Similarly, in the Advertisers & Campaigns tab the following tabs are displayed by expanding information for an advertiser and clicking on a specific banner:
In the View by menu you can select to aggregate statistics by:
Note: If you view statistics by hour, the database will take longer to return the information and the more advertisers you have, the longer it will take to process the information.
A total of statistics for the selected view is displayed at the end of the page.
When you click the Statistics > Global history tab, OpenX displays an overview of statistics without specifying associated advertisers or websites. The tab includes links to Create a Graph of Statistics and Export Statistics to Excel.
In the View by menu you can select to aggregate statistics by:
A total of statistics for the selected view is displayed at the bottom of the page.
When you click the Statistics > Websites & Zones tab, OpenX displays the statistics for all of your current websites, for the time period already set in this menu. Change the date period to view statistics for another period, such as last week or month.
Expand details of a website to view campaign statistics for a zone. You can view the following statistics for the campaign for the selected period:
In the View by menu you can select to aggregate statistics by:
Note: If you view statistics by hour, the database will take longer to return the information and the more websites you have, the longer it will take to process the information.
A total of statistics for the selected view is displayed at the end of the page.