Structured ad requests

Last updated on June 13, 2017

If you need to manipulate a structured response to render ads in a custom application, you can implement an ad requestCommunication from a web browser or app to an ad server to display an ad. to OpenX that has a corresponding structure. For example, you might create an ad request to display ads on a mobile device or a desktop application. Your application must be able to parse the response and then serve the selected ads. OpenX provides structured responses in XML, JSON, and JSONP.

You can make the following types of requests:

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 Ad ServerA complete digital advertising platform where publishers sell, manage, and deliver their advertising inventory across all digital formats..

When a user interacts with your custom application, which has been designed to communicate with OpenX:

  1. The custom application invokes an ad request for the ad unit, ad unit group, or multiple ad units.

  2. The Ad Server receives the request, performs ad selection, and returns a structured delivery response.

  3. The custom application parses the response and renders the selected ad in the appropriate location.

To configure your custom application:

  1. Create ad units or ad unit groups in the OpenX UI or via the OpenX API.

  2. Implement the appropriate logic and configuration in your custom application to generate OpenX ad requests based on corresponding examples provided in this ad requests section.

  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.

Note: These ad requests use a client-side impressionA single display of an ad on a web page, mobile app, or other delivery medium. For deals, impression is a metric to relay the total number of ads that have served. See also billable impression, forecasted impressions. counting mechanism. Your custom application should be configured to handle this operation. Work with your OpenX Account Manager to ensure a complete and proper integration.

The OpenX Ad Request API supports the following:

You can implement more than one type of ad tagA small piece of code that defines the ad space where ads display on a website. It includes parameters that describe the inventory advertising campaigns can target, which may in turn display ads in the ad space.. For example, if you want to display three ad units on a webpage, you could implement an image tag, an iframe tag, and a JavaScript tag.