Imp object

Last updated on February 22, 2018

BidRequest.imp

Each BidRequest object contains an array with a single Imp object to describe the 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.. Each Imp object can contain one of the following objects to describe the ad space:

In addition, the Imp object can contain a Pmp object along with a BannerThis is an ad that appears on a web page which is typically hyperlinked to an advertiser’s website. Banners can be images (GIF, JPEG, PNG), JavaScript programs or multimedia objects (For example, Java). or Native object.

Imp object

Field name Data type Description Sent?
id string

A unique ID for the impression.

For example: "888b4a7a-d259-11e0-9912-000c29b0c11a"

The value of this field currently matches the BidRequest.id field, but this may change in the future.

The OpenRTB specification requires that you use the value of BidRequest.imp.id to populate BidResponse.seatbid.bid.impid.

Always

metric

Object array

An array of Metric objects that offers insight into different metrics about the impression itself to assist with your bidding decisions.

A Metric object is always sent when it is enabled.

Sometimes

banner Bannerobject

An object containing properties that describe the display banner ad unitThe smallest inventory component that represents the space on a site where ads display. for this impression opportunity.

A Banner object is always sent for banner impression opportunities.

Sometimes

video

Video object

An object containing properties that describe the display video ad unit for this impression opportunity.

A Video object is always sent for video impression opportunities.

Sometimes

native

Native object

An object containing properties that describe a native adAn advertisement designed to blend in with the appearance and tone of the editorial content it runs alongside. impression opportunity.

A Native object is always sent for native ad impression opportunities.

Sometimes

pmp

Pmp object

An object containing properties that describe deals eligible for impressions.

A Pmp object is always sent for private marketplaceThe packaging, offering, and selling of high quality inventory to a limited set of buyers. Abbreviated as PMP. deals.

Sometimes

displaymanager

string

Name of SDK technology or player responsible for rendering an ad (typically video or mobile).

Sometimes

displaymanagerver

string

Version of SDK technology or player responsible for rendering an ad (typically video or mobile).

Sometimes

instl

integer

Indicates whether the request is for an interstitialA full-screen ad displayed in content transitions. For example, a video ad that loads between levels of a mobile game. ad (1) or not (0).

Sometimes

secure

integer

If this impression must be SSL secured, all creativeThe media asset associated with an ad, such as an image or video file. assets that are returned must use the HTTPS protocol, not HTTP.

  • 0 = False

  • 1 = True (HTTPS URLs are required.)

Sometimes

exp

integer

Advisory as to the number of seconds that may elapse between the auction and the actual impression.

Sometimes

Additional publisher enrichment fields

Feedback form