Link Search Menu Expand Document

PDF

Ad Units

Publishers


After you set up your sites, you can create ad units, which represent the specific areas to display ads. Read this section for ad unit basics.


on this page

NOTE

Some features mentioned here may not be available in your region or based on your user role. For more information, visit the O​penX Community​.


About Ad Units

Each ad unit you create belongs to a single site and generates a unique identifier, called an ad unit ID, or “auid”. For web-based ad units, place the ad tag code in the source code of your sites. For mobile and video ad units, configure your app or video player to communicate the ad request to OpenX. For more information on tag types, read about the Ad Request API.

Ad unit type

One of the attributes that you must specify for each ad unit is Ad Unit Type, which defines the delivery medium for the ad unit. Learn more about supported ad unit types in Creating ad units.

NOTE

For information about ad tags, see Ad Tags.


Creating Ad Units

You can create an ad unit for each unit of ad space on your website or mobile app. Each ad unit belongs to a site (the OpenX object), and the settings for that site are used as defaults for each ad unit. The Ad Unit Type field is where you select the delivery medium, or the way ads will be viewed. Depending on your OpenX products and the type of site you have set up in OpenX, you can create video, mobile, or web ad units. This field inherits options based on the site’s default delivery medium.

Ad Units List

Ad unit typeDescription
WebStandard web-based display ads, such as web banners on web pages.
MobileAds that display in mobile web browsers or within mobile applications. To create a mobile ad unit, the site under which you create an ad unit must have a Default Delivery Medium of Mobile.
If you set up a Mobile site to serve video ad units to your mobile app, at the ad unit level, change the Ad Unit Type to Video.
VideoVideo ads that play in sequence with video content in a video player.
If you set up a Mobile site to serve video ad units to your mobile app, at the ad unit level, change the Ad Unit Type to Video.

Refer to the following tabs for step-by-step instructions by ad unit type:

NOTE

Prior to creating ad units, you must have your publisher account and sites created.

Creating Web Ad Units

Once you have created a site in OpenX, you need to create ad units for it. Create a web ad unit when you’d like to display standard web-based ads, such as web banners. You can learn more about ad units and read creating ad units for more information about types of ad units for different delivery mediums.

To create a web ad unit:

  1. Select the site for which you are creating an ad unit and then click Next.

    The Create New Ad Unit screen is displayed.

  2. Complete the following required fields:

    In this fieldDo this
    NameEnter a unique name.
    Ad Unit TypeWeb should already be selected.
    Presentation FormatSelect Display or Interstitial.
  3. Click Advanced Settings to expand the following optional fields to complete, as needed:

    In this fieldDo this
    Ad Unit Floor (Optional)If your OpenX configuration enables exchange selling, enter the minimum price that you are willing to accept for this ad unit. The currency type is based on the Currency setting for the container site. If any real-time selling rules target this ad unit and have a Floor Price value that is different from this Ad Unit Floor, the higher floor becomes the minimum bid price allowed to win the inventory.
    Passback Ad Tag (Optional)Type the HTML ad code for a fallback ad to serve in cases when OpenX would otherwise serve a blank ad. You can enter a value in the Passback Ad Tag field if you have appropriate permissions. You should leave the Passback Ad Tag field empty if you do not have a passback tag for the ad unit.
  4. Click Save to complete the ad unit setup.

    NOTE

    You do not need to provide ad unit sizes as these are automatically configured for each request.

Creating Mobile Ad Units

Once you have created a site in OpenX for either mobile app or for mobile web browser inventory, you need to create ad units for it. Ad units created under Mobile Sites are considered “mobile” ad units whether intended for mobile app or mobile browser display.

If you’re creating a mobile ad unit for video inventory, see the tab Creating a video ad unit for video-specific instructions. See Creating Ad Units for a list of all types of ad units you can create for different delivery mediums.

To create a mobile ad unit for mobile web or mobile app:

  1. Open the mobile site for which you are creating an ad unit. A mobile “site” is needed in OpenX even for a mobile app, in order to group the inventory together for that app.

  2. Click Create New Ad Unit.

    The Create Ad Unit screen is displayed.

  3. Complete the following required fields:

    In this fieldDo this
    NameEnter a unique name.
    Ad Unit TypeMobile should already be selected.
    Presentation FormatSelect Display or Interstitial.
  4. Click Advanced Settings to expand the following optional fields to complete, as needed:

    In this fieldDo this
    Ad Unit FloorSet a floor price for the ad unit.
    API Framework (Optional)Type to select one or more API frameworks. This information can then be passed to buyers. Note that populating this field will override any “af” query argument or OpenRTB “api” argument set in the ad request.
    Passback Ad TagType the HTML ad code for a fallback ad to serve in cases when the ad server would otherwise serve a blank ad. Note that if you are using DFP as your ad server for a mobile app ad unit, you can only use a secure (https) passback tag. You can enter a value in the Passback Ad Tag field if you have the appropriate permissions. You should leave the Passback Ad Tag field empty if you do not have a passback tag for the ad unit.
  5. Click Save to complete ad unit setup.

    NOTE

    You do not need to provide ad unit sizes as these are automatically configured for each request.

    After you create a mobile ad unit, a Mobile Ad Tag is generated. For more on how to create an ad tag, see Ad Tags.

Creating Video Ad Units

To serve video ads that play in a video player in your mobile app or on your website (mobile and/or desktop), you need to create separate video ad units for each of the following inventory types:

  • Desktop web
  • Mobile web
  • Mobile app

To create a video ad unit:

  1. Open the site for which you are creating an ad unit.

  2. Click Create New Ad Unit.

    The Create New Ad Unit screen is displayed.

  3. Complete the following required fields:

    In this fieldDo this
    NameEnter a descriptive name to identify your video ad unit.
    Ad Unit TypeSelect Video. The default option is determined by the Default Delivery Medium selection from the parent site for which you are creating the ad unit.
    Presentation FormatSelect In-stream or Interstitial. Support for Out-stream is coming soon.
    Mime TypesChoose the MIME types that your video player is compatible with. For more information, see Video MIME types. By default, all MIME types are selected.
    ProtocolsChoose the highest version of the OpenRTB protocol that your video player supports. Include the backwards-compatible options.
    If your video player supports wrappers, you may include both wrapper and non-wrapper options. Most players support both regular VAST and wrapped VAST since both are part of the IAB standard. A wrapped VAST is when the DSP adds XML to a VAST response by encapsulating the original VAST response in a new VAST response. By default, all protocols are selected.
    Maximum Ad DurationSelect an ad duration from the list for a video ad to be displayed in this ad unit. The default value is set to 30 seconds.
  4. Click Advanced Settings to expand the following optional fields to complete, as needed:

    In this fieldDo this
    Ad Unit Floor (Optional)Specify the minimum price a demand partner must clear to be considered a valid bid.
    API Framework (Optional)This setting overrides any OpenRTB api arguments set in the ad request. Choose the API framework supported by your video player. If necessary, see the IAB guidelines for MRAID and VPAID.
       • MRAID-1
       • MRAID-2
       • ORMMA
       • VPAID 2.0

    Note: If you selected application/javascript in the MIME Types field, select VPAID 2.0.
    Playback Methods (Optional)Select the preferred way for a video to launch. Select only one playback method. Selecting more than one method is unclear to buyers and may impact revenue. Failing to specify a playback method signals to buyers that any method may be used, which can lead to confusion and, as a result, lower bid depth and/or lower-priced bids.
    Indicate this ad unit contains rewarded video inventoryCheck this box if this ad unit contains opt-in video inventory.
    Minimum Ad Bitrate (Optional)Specify the acceptable minimum bitrate for video ads. If left blank, the default setting is 240 Kbps.
    Maximum Ad Bitrate (Optional)Specify the acceptable maximum bitrate for video ads. If left blank, the default setting is 4,000 Kbps.

    Example of a video ad unit setup

  5. Click Save to complete the ad unit setup.

    NOTE

    You do not need to provide ad unit sizes as these are automatically configured for each request.


Configuring VAST ad tags

Now that you have created a video ad unit and you have a VAST ad tag, you must configure your VAST ad tag and add it to your ad server or video player.


About Video MIME Types

MIME types describe the type of file you are transmitting in a way that has meaning to the code base via which your video player and ad server communicate. You are probably used to recognizing files based on their filename extensions, such as .mov for a Quicktime file. These filename extensions are associated with MIME types so your ad server or video player can communicate with each other and demand sources who want to serve ads to your video ad units.

Your video player is compatible with a particular set of MIME types. You need to identify those and specify the subset of them that is compatible with your ad unit’s inventory type while creating a video ad unit. By doing this, you should receive only ads that are compatible with your video player and inventory type.


MIME type syntax

A MIME type’s structure consists of a type and a subtype. The type and subtype are two strings which are separated by a forward slash (/):

type/subtype


Spaces are not permitted, and lowercase is the standard, though MIME types are not case sensitive.

In the case of Video in the OpenX Ad Exchange, you find MIME types with a type of either application or video. For example, the Quicktime file referenced above has a type of video and a subtype of quicktime. The MIME type associated with a Quicktime file looks like this:

video/quicktime

How to choose MIME types

When you create a video ad unit, all available MIME types and Protocols are selected by default. In addition, the Maximum Ad Duration is set by default to 30 seconds. From here, the MIME types you decide to keep depend on your video player’s compatibility and the inventory type of your video ad unit.

create ad unit > video > mime types

It is very important to choose the correct MIME types. Choosing incorrect MIME types will make your ad unit available to incompatible ad types in the OpenX Ad Exchange. Determine which MIME types to select based on two criteria:

  • Video player compatibility
  • Inventory type of your video ad unit

The table below provides an overview of MIME type choices.

MIME typeSample filename extensions
application/javascript (requires VPAID 2.0 support).js
application/vnd.apple.mpegurl.m3u, .m3u8
application/x-mpegurl.m3u, .m3u8
video/3gpp.3gp
video/mp4.mp4, .m4a, .m4p, .m4b, .m4r, .m4v
video/mpeg.m1v
video/ogg.ogg
video/quicktime.mov, .qt
video/webm.webm
video/x-m4v.m4v
video/ms-asf.asf, .wma, .wmv
video/x-ms-wmv.wmv
video/x-msvideo.avi

External documentation for supported MIME types

The following external documentation is subject to change without notice to OpenX. When in doubt, please follow documentation for your video player’s latest version.


Editing Ad Units

After you create an ad unit, you can change any of its settings except for the Ad Unit Type setting. In addition, you can change status (Activate or Deactivate) for an ad unit directly in the list of ad units or you can change the status of multiple ad units at once.

To edit an ad unit:

  1. Do one of the following:

    • From the Ad Units List, open the Actions list , and then select Edit:

    • From the Ad Unit Details screen, click Edit located on the top right:

  2. Edit the ad unit settings as needed. You can edit any of the fields except the Ad Unit Type.

  3. Click Save.


Viewing Ad Units

View general details for the ad units that you have access to. In the Ad Units List, you can filter ad units by Publisher, Site, and Status. To view additional details, access the Ad Unit Details screen where you can view the ad unit advanced settings and track user activity in the History tab.

To view ad unit details:

In the Ad Units List, do one of the following:

  • Click on the ad unit’s name.
  • On the row of the ad unit you want to view, open the Actions list , and then select Details.

The Ad Unit Details screen displays by default information about the ad unit. This includes the ad unit ID, name, site, type, size, status, and any advanced settings.

web ad unit example


Exporting Ad Units

You can export a list of ad units data in .csv format. The export file contains the following:

  • Ad Unit Name
  • Ad Unit ID
  • Publisher ID
  • Publisher Name
  • Site ID
  • Site Name
NOTE

You can also export ad tags, for more see Ad Tags.

To export ad units:

  1. Open the Ad Units List.

  2. Do one of the following:

    To exportDo this
    An individual ad unitOn the row of the ad unit you want to export, open the Actions list , and then select Export Ad Unit.



    Note: You can also export an ad unit from the Ad Unit Details screen by clicking Export Ad Unit located on top.
    Multiple ad unitsOn the Ad Units List, check the boxes of the ad units you want to export, and then click Export Ad Units located on top of the screen.

  3. In the confirmation screen that appears, click Export. The .csv file of the ad unit(s) you selected is downloaded.


Deleting Ad Units

Before you delete an ad unit you no longer want to use, consider the following:

  • Any ad calls for the ad unit are considered invalid.
  • Forecasts related to the inventory that the deleted ad unit represents will be removed.
  • You will no longer have access to view or manage the deleted ad unit.

To delete ad units:

  1. Open the Ad Units List.

  2. Do one of the following:

    To deleteDo this
    An individual ad unitOn the row of the ad unit you want to delete, open the Actions list , and then select Delete.



    Note: You can also delete an ad unit from the Ad Unit Details screen by clicking Delete located on top.
    Multiple ad unitsOn the Ad Units List, check the boxes of the ad units you want to delete, and then click Delete located on top of the screen.

  3. In the confirmation screen that appears, click Delete. This removes the ad unit(s) from the list.