Link Search Menu Expand Document


Ad Request API Calls


Last updated on August 10, 2020

You can place ad tags in you inventory to make ad request calls to OpenX, which in turn will send delivery responses to serve ads. Each ad tag includes parameters describing the inventory that advertisers can target.

You can customize ad requests to support your particular implementation using the OpenX ad request API, for example, you might create an ad request to display ads on a mobile device. When a user interacts with your custom application, which has to be configured to communicate with OpenX:

  1. The custom application invokes an ad request for the ad unit, ad unit group, or multiple ad units.
  2. OpenX receives the request, performs ad selection, and returns a structured delivery response in JSON and JSONP.
  3. The custom application parses the response and renders the selected ad in the appropriate location.

Ad Request Types

You can make the following types of requests:

  • Standalone: Requests an ad for a single ad unit.
  • Ad unit group: Requests ads for multiple ad units in a single call, referenced by an ad unit group ID. This type of request is required for companion ad placement.
  • Multi-ad unit: Requests ads for multiple ad units in a single call.

You can also request a delivery response for one or more ad units and one or more ad unit groups in a single call to OpenX.

Getting Started

To configure your custom application:

  1. Create ad units or ad unit groups in the OpenX UI or via the OpenX Platform API.
  2. Implement the appropriate logic and configuration in your custom application to generate OpenX ad requests based on corresponding examples provided in video integration instructions.
  3. Configure your custom application with the appropriate ad unit or ad unit group IDs.
  4. Implement the appropriate logic in your application to parse the structured response from OpenX, and then render the ads to the end user.

These ad requests use a client-side impression counting mechanism. Your custom application should be configured to handle this operation. To ensure a complete and proper integration, visit the OpenX Community.