You are here: Demand Partners > Real-time bidding > Bid notifications > Endpoint notifications

Loss notifications via endpoint notifications

Last updated on July 14, 2017

OpenX supports sending real-time loss notifications to demand partners via OpenX endpoint notifications, in which auction results information via a JSON object can be sent to specified endpoint provided by the DSPDemand-side platform, a platform or provider that allows advertisers to manage multiple ad exchange and data exchange accounts through one interface, often in real time.. To enable this feature or receive more information, please contact your Platform Development Manager.

AuctionResults JSON object

Field name Data type Description
auction_id string

The unique ID for the auction - this will match the BidRequest.id value sent in the corresponding bid requestWhen OpenX Ad Exchange receives an ad request, it sends a communication containing details about the impression to selected real-time bidders to solicit bids for it..

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

results Array of Result objects

The list of information about the auction results.

Result object

Field name Data type Description
clearing_price_micros integer

If the bid won the auction, then this field indicates the actual price that the bidder paid for 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.. This value is expressed in CPMCost per mille, a pricing method which calculates cost based on the number of impressions (per 1000). micros.

error_reason string

If there was an error processing the bid, this field provides the specific reason. See the Error reasons list below.

loss_reason string

If the result of the bid is a loss, this field provides the specific reason. See the Loss reasons list below.

matching_ad_id MatchingAdId object

The MatchingAdId for the bid which this result corresponds to.

status integer

Indicates if the bidder’s bid won or lost the auction, or if an error occurred:

  • 1 (win)

    The bidder won the auction.

  • 2 (loss)

    The bidder lost the auction.

  • 3 (error)

    An error occurred in processing the bid.

winning_bid_micros integer If the result of the bid is a loss, this field indicates the bid price that actually won the auction. This value is expressed in CPM micros.

MatchingAdId object

Field name Data type Description
campaign_id integer The ID for the order to which the matching ad belongs.

creative_id

integer

The ID for the matching ad.

placement_id

integer

The ID for the line itemThe primary unit of execution for an order, which represents a specific inventory purchase and the required conditions for ad delivery. to which the matching ad belongs.

 

Note: The following are subject to regular updates. We strongly recommend regularly checking this table for new OpenX loss/error reasons.

Loss reasons

Loss reason Description
PRICE

Bid price was insufficient to win the auction.

INVALID_BID

Bid was invalid.

NO_AD_CODE

Bid did not have a valid ad markup.

SSL_MISMATCH

Bid contained a non-HTTPS creativeThe media asset associated with an ad, such as an image or video file. for an HTTPS ad requestCommunication from a web browser or app to an ad server to display an ad..

NURL_TOO_LONG

Submitted nurl exceeded the allowed limit of 800 characters.

NURL_INVALID

Submitted nurl was invalid.

PMP_DEAL_ID

Bid was not sent with a (valid) Deal ID.

PMP_BUYER

BuyerA company that pays a demand partner to purchase ad inventory on OpenX Ad Exchange. blocked by publisherAn account type that represents a business with ad space to sell. from participating in deal.

PMP_BRAND

BrandA name that represents the product or service being advertised, such as Tide. blocked by publisher from participating in deal.

PMP_OTHER

Bid was discarded for a general deal block.

CREATIVE_BRAND

Bid contained a brand blocked by the publisher.

UNBRANDED

Bid contained an unbranded adomain.

CREATIVE_TYPE_IMAGE

Creative type blocked by the publisher (Image).

CREATIVE_TYPE_FLASH

Creative type blocked by the publisher (Flash).

CREATIVE_TYPE_TEXT

Creative type blocked by the publisher (Text).

CREATIVE_TYPE_VIDEO_USER_INITIATED

Creative type blocked by the publisher (User-Initiated In-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). Video).

CREATIVE_TYPE_DHTML

Creative type blocked by the publisher (HTML).

CREATIVE_TYPE_AUDIO_USER_INITIATED

Creative type blocked by the publisher (User-Initiated Audio).

CREATIVE_TYPE_VIDEO_AUTO_PLAY

Creative type blocked by the publisher (Auto-Play In-Banner Video).

CREATIVE_TYPE_AUDIO_AUTO_PLAY

Creative type blocked by the publisher (Auto-Play Audio).

CREATIVE_TYPE_ROTATING

Creative type blocked by the publisher (Rotating Creative).

CREATIVE_TYPE_NATIVE

Creative type blocked by the publisher (Native).

CREATIVE_TYPE_VAST

Creative type blocked by the publisher (VAST).

CREATIVE_TYPE

Creative type blocked by the publisher (General).

CREATIVE_ID

The crid was blocked by the publisher or OpenX.

CREATIVE_ATTRIBUTE_ALCOHOL

Creative content contained an attribute blocked by the publisher (Alcohol).

CREATIVE_ATTRIBUTE_AUDIO_VIDEO

Creative content contained an attribute blocked by the publisher (Audio/Video).

CREATIVE_ATTRIBUTE_DATING_ROMANCE

Creative content contained an attribute blocked by the publisher (Dating & Romance).

CREATIVE_ATTRIBUTE_DOWNLOADS

Creative content contained an attribute blocked by the publisher (Downloads).

CREATIVE_ATTRIBUTE_ERROR_BOX

Creative content contained an attribute blocked by the publisher (Error Box or Alerts).

CREATIVE_ATTRIBUTE_EXCESSIVE_ANIMATION

Creative content contained an attribute blocked by the publisher (Excessive Animation).

CREATIVE_ATTRIBUTE_GAMBLING

Creative content contained an attribute blocked by the publisher (Gambling).

CREATIVE_ATTRIBUTE_RELIGIOUS

Creative content contained an attribute blocked by the publisher (Religious).

CREATIVE_ATTRIBUTE_SWEEPSTAKES

Creative content contained an attribute blocked by the publisher (Sweepstakes & Offers).

CREATIVE_ATTRIBUTE_SEXUAL_HEALTH

Creative content contained an attribute blocked by the publisher (Sexual Health).

CREATIVE_ATTRIBUTE_MAKE_MONEY_FAST

Creative content contained an attribute blocked by the publisher (Money-Making Scheme).

CREATIVE_ATTRIBUTE_POLITICAL

Creative content contained an attribute blocked by the publisher (Political).

CREATIVE_ATTRIBUTE_SUGGESTIVE

Creative content contained an attribute blocked by the publisher (Suggestive Content).

CREATIVE_ATTRIBUTE_TOBACCO

Creative content contained an attribute blocked by the publisher (Tobacco).

AQ_ATTRIBUTE

Creative content contained an attribute blocked by the publisher (General).

CREATIVE_INDUSTRY

Creative represents an industry blocked by the publisher.

CREATIVE_LANGUAGE

Creative contained a language blocked by the publisher.

CREATIVE_MIMETYPE_FLASH_JS_VPAID

Creative mimetypes not supported for ad unitThe smallest inventory component that represents the space on a site where ads display. (Flash & Javascript VPAIDVideo Player Ad-Serving Interface Definition, a type of API framework for interfacing between a video ad creative and a video player.).

CREATIVE_MIMETYPE_FLASH_VPAID

Creative mimetypes not supported for ad unit (Flash).

CREATIVE_MIMETYPE_JS_VPAID

Creative mimetypes not supported for ad unit (Javascript VPAID).

CREATIVE_MALWARE

Creative flagged for potential malware.

CREATIVE_TOO_MANY_INITIAL_REQUESTS

Creative blocked due to making too many HTTP requests prior to page load.

CREATIVE_TOO_MANY_REQUESTS

Creative blocked due to making too many HTTP requests in total.

CREATIVE_INITIAL_FILE_WEIGHT_TOO_HIGH

Creative exceeds allowed threshold of downloaded bytes prior to page load.

CREATIVE_FILE_WEIGHT_TOO_HIGH

Creative exceeds allowed threshold of downloaded bytes in total.

CREATIVE_VIDEO_NOT_SCANNED

Video creative not yet scanned by exchange.

DYNAMIC_THROTTLE

Bid discarded due to high probability of AQ violation.

SINGLE_BID_PER_ACCOUNT

Multi-bid - Bid Not Selected.

Error reasons

Loss reason Description
TIMEOUT

The original bid was not received within the time allotted.

ERROR_CONNECT

An error occurred while establishing the HTTP connection.

ERROR_RECEIVE

An error occurred while receiving the response.

ERROR_PARSE

An error occurred while parsing the response.

ERROR_UNKNOWN

An unknown error occurred.

ERROR_EMPTY

The bid responseAfter evaluating a bid request, a real-time bidder’s communication to OpenX Ad Exchange, indicating if they’re interested in the impression, and if so, how much they’re willing to pay for it. was empty.

ERROR_NXDOMAIN

An error occurred while trying to resolve the endpoint domain.

SYSTEM_ERROR

A system error occurred.

Example: Sample auction results message

If you set up a notification endpoint, an auction results message is sent to that URL in the following JSON format:


{
	"auction_id": "AUCTION_ID",
	"results": [ {
		"matching_ad_id": {
			"campaign_id": "CAMPAIGN_ID",
			"placement_id": "PLACEMENT_ID",
			"creative_id": "CREATIVE_ID"
		},
	"status": 1, // 1: win; 2: loss; 3: error
	"clearing_price_micros": CLEARING_PRICE // The actual price paid, expressed in CPM micros; only sent for status == 1
	"loss_reason": "LOSS_REASON", // If status == 2
	"error_reason": "ERROR_REASON", // If status == 3
	"winning_bid_micros": WINNING_BID, // The price that won the auction, expressed in CPM micros; only sent if status == 2
		}[, ...]
	]
}

See also:

Win notifications

Loss notifications via LURL

Feedback form