Integrate web/mobile web with PSP
Prebid Server Premium (PSP) supports four options for Direct Supply customers to integrate web and mobile web inventory:
- Prebid.js Send Top Bid
- Prebid.js Send All Bids
- Non-prebid
- Long Form Video Service
Monetize Ad Server customers do not need to change their current integration into Microsoft Monetize and can instead follow the PSP Setup Steps.
Prebid.js send top bid
Context
In general, Send Top Bid should be used by default when publishers do not have bidder-specific line items already set up in their ad server, or if they do not need all bids for reporting purposes. By using the Send Top Bid option, the winning bid response will indicate Microsoft Monetize as the winner with a buyer member ID as normal even if a separate SSP Demand Partner won through Prebid Server Premium. The publisher's ad server will see Microsoft Monetize as the winner if this top bid wins the ad server auction. Publishers can determine which SSP won, either Microsoft Monetize or another Demand Partner via Prebid Server Premium, by utilizing Microsoft Monetize's reporting and analytics and cross-referencing the other SSP Demand Partners' reporting.
Implementation
To set up Prebid.js with Send Top Bid:
Integrate with a Prebid.js instance that uses the Microsoft Monetize (AppNexus) Prebid.js adapter.
This should not require any changes to the "appnexus" adapter setup on page if already integrated through Microsoft Monetize this way.
Call the Microsoft Monetize SSP client-side using the
/ut/v3/prebid
endpoint.If Demand Partners are already being called client-side, remove partners other than 'appnexus' (Microsoft Monetize) from the Prebid.js client-side instance.
Configure those, and any additional SSP Demand Partners, in Microsoft Monetize via Publishers > Prebid Server Premium > Demand Partner Configurations.
For more information, see Add, Edit, or Delete a PSP Configuration.
For video-specific nuances, see the guidance here.
Proceed with PSP Setup steps.
Prebid.js send all bids
Context
Send All Bids should be used if Demand Partner-specific line items in the ad server are absolutely required. PSP will set key value targeting for the top CPM bid, along with the standard top bid key values (bidder, price, deal) for each included Demand Partner per ad unit.
Implementation
To set up Prebid.js with Send All Bids:
Integrate with a Prebid.js instance that uses the Microsoft Monetize (AppNexus) Prebid.js adapter.
This should not require any changes to the "appnexus" adapter setup on page if already integrated through Microsoft Monetize this way.
Note
When using Prebid.js 9.0 or higher, include the anPspParamsConverter module in every Prebid.js build for pages that use Microsoft Monetize for PSP demand. This module converts client-side calls to the format required for server-side endpoints.
Call the Microsoft Monetize SSP client-side using the
/openrtb2/prebid
endpointFollow the Prebid GitHub example here.
Important
Prebid.js version 6.10 or higher is required.
Make the below changes to the s2sConfig:
Set the accountId to your Microsoft Monetize Seller Member ID.
Set enabled to true.
Set defaultVendor to 'appnexuspsp'.
Set allowUnknownBidderCodes to true.
Include both includebidderkeys, includewinners, and includeformat in the extPrebid targeting object as shown in the following example:
extPrebid = ([ { "targeting":{ "includebidderkeys":true, "includewinners":true, "includeformat":true } } ])
Include 'appnexus' in bidders.
Set the timeout value to the number of ms the browser should wait for a response from Microsoft Monetize.
Note
This value should be greater than your Microsoft Monetize (PSP) auction timeout. If the value is lower, there is a risk that the client-side timeout will hit before Microsoft Monetize responds with a bid, potentially preventing receipt of demand from Microsoft Monetize. For more information, see the Demand Partner Timeout section in Add or Edit PSP Global Settings.
See below for a s2sConfig example:
pbjs.setConfig({ "s2sConfig":{ "accountId":9325, "bidders":[ "appnexus" ], "defaultVendor":"appnexuspsp", "enabled":true, "allowUnknownBidderCodes":true, "timeout":1000, "extPrebid":{ "targeting":{ "pricegranularity":"dense", "includebidderkeys":true, "includewinners":true, "includeformat":true } } } })
When using Send All Bids, report on the key values in an external ad server, such as Google Ad Manager (GAM), by defining key values appropriately and setting them as reportable. GAM documentation can be found here.
For video-specific nuances, see the guidance here.
Proceed with PSP Setup steps.
Targeting key values
As noted above, it is recommended to set all three parameters (includebidderkeys
, includewinners
, includeformat
) to true to receive the most information from PSP in the form of targeting key values.
In the s2sConfig
, at least one of includewinners
or includebidderkeys
must be set to true to receive any targeting keys.
If includewinners
is true, the following targeting keys will be received:
"hb_bidder": "appnexus"
,"hb_pb": "0.00"
,"hb_size": "600x500"
If includebidderkeys
is true, the following targeting keys will be received:
"hb_bidder_appnexus": "appnexus"
,"hb_pb_appnexus": "0.00"
,"hb_size_appnexus": "600x500"
If includeformat
is also set to true in addition to either of the above parameters, this key will be received as well:
"hb_format_appnexus": "banner"