4️Winning Impression Reporting

Here’s how to report your rendered impression data to IntentIQ.

IntentIQ’s Real-Time Performance Optimization (RTPO) feature enables IntentIQ Bid Enhancement to improve your revenue lift by analyzing your programmatic performance in real time across all demands, sites, and devices. RTPO automatically tunes its identity data on the fly based on real-time performance analysis to ensure the highest accuracy and relevancy, which results in a higher revenue lift.

To report a winning impression event (Ad served) –

1. Create an object to be input to the IntentIQ method reportExternalWin

Create the following object. Pass the following object as input to the IntentIQ method reportExternalWin.

var intentIq_123123 = new IntentIqObject({
  ...
});

var reportData = {
  biddingPlatformId: 1, // PreBid
  partnerAuctionId: "[YOUR_AUCTION_ID_IF_EXISTS]",
  bidderCode: "xxxxxxx",
  prebidAuctionId: "3d4xxxxxxxxxxxxxxxxxxxx8e",
  cpm: 1.5,
  currency: "USD",
  originalCpm: 1.5,
  originalCurrency: "USD",
  status: "rendered",
  placementId: "div-1"
}

intentIq_123123.reportExternalWin(reportData);

The following table describes the attributes of the object described above.

FieldData TypeDescriptionExampleMandatory

biddingPlatformId

Integer

Specify the platform in which this ad impression was rendered –

1 – Prebid

Note – For additional platforms (such as the following), you can contact your account manager: 2 – Amazon, 3 – Google 4 – Open RTB (including your local Prebid server).

1

Yes

partnerAuctionId

String

Use this when you are running multiple auction solutions across your assets and have a unified identifier for auctions, such as Prebid, Amazon APS and Google AdX. This value is a single unified identifier that represents the auction IDs of multiple platforms.

3d44542d-xx-4662-xxxx-4xxxx3d8e

No

bidderCode

String

Specifies the name of the bidder that won the auction as reported by Prebid, as well as all other bidding platforms.

newAppnexus

Yes

prebidAuctionId

String

Specifies the identifier of the Prebid. Leave this field empty or undefined if Prebid is not the bidding platform.

cpm

Decimal

Cost per mille of the impression as received from the demand-side auction (according to the currency specified below without any modifications or reductions).

5.62

Yes

currency

String

Currency of the auction.

USD

Yes

originalCpm

Decimal

Leave this field empty or undefined if Prebid is not the bidding platform.

5.5

No

originalCurrency

String

Value

USD

No

status

String

Leave this field empty or undefined if Prebid is not the bidding platform.

"rendered"

No

placementId

String

Specifies the unique identifier of the ad unit on the webpage that showed this ad.

"div-1"

No

2. Place reportExternalWin on Your Page

Place reportExternalWin on your page so that it is invoked after you have configured the IntentIQ object, the ad was served (meaning ad content has been successfully delivered and played for a user on the digital platform), and you have received the impression information from the auction.

intentIq_123123.reportExternalWin(reportData);

Example of Functionality Integration

var intentIq_1234567 = new IntentIqObject({
	partner: 1234567,
	pbjs: mypbjs,
	callback: iiqCallbackMethod,
	timeoutInMillis: maximumPrebidDelayTimeout,
	ABTestingConfigurationSource: 'percentage',
	abPercentage: 95,
	manualWinReportEnabled: true,
	domainName:'currentDomain.com',
});

var reportData = {
                biddingPlatformId: 1, //1 == Prebid
                partnerAuctionId: xxxxxxxx-xxxxxx-xxxxxx,
                bidderCode: "newAppnexus",
                prebidAuctionId: "3d44542d-0e22-4662-932e-40cd289e3d8e",
                cpm: 1.5,     
                currency: "USD", 
                originalCpm: 1.5,
                originalCurrency: "USD",
                status: "rendered",
                placementId: "div-1"
  }
  
intentIq_1234567.reportExternalWin(reportData);

Last updated