Skip to content

Commit

Permalink
gpt-pre-auction ORTB2 updates (#2835)
Browse files Browse the repository at this point in the history
  • Loading branch information
bretg authored Apr 8, 2021
1 parent a292f73 commit 4519222
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions dev-docs/modules/gpt-pre-auction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ This module enables targeting and tracking at the ad server adunit level.
Enabled by default if compiled into your package, this module will add the [Prebid Ad Slot](/features/pbAdSlot.html) and matching GAM ad unit name to each ad unit's first-party data before bid requests are sent to the adapters.

* **Prebid.js Adapters** - will be able to utilize these values as:
* AdUnit.fpd.context.adServer.name="gam"
* AdUnit.fpd.context.adServer.adSlot="/1111/home"
* AdUnit.fpd.context.pbAdSlot="/1111/home-left"
* AdUnit.ortb2imp.ext.data.adserver.name="gam"
* AdUnit.ortb2imp.ext.data.adserver.adslot="/1111/home"
* AdUnit.ortb2imp.ext.data.pbadslot="/1111/home-left"
* **Prebid Server Adapters** - will see the OpenRTB as:
* imp[].ext.context.data.adserver.name
* imp[].ext.context.data.adserver.adslot
* imp[].ext.context.data.pbadslot
* imp[].ext.data.adserver.name
* imp[].ext.data.adserver.adslot
* imp[].ext.data.pbadslot

## Configuration

Expand Down Expand Up @@ -67,13 +67,13 @@ When this module is on, it uses the BEFORE_REQUEST_BIDS event to insert function

If GPT slot matching succeeds:

- it sets fpd.context.adserver.name to 'gam'
- it copies the resulting GPT slot name to fpd.context.adserver.adSlot
- it sets the Adunit ortb2imp.ext.data.adserver.name to 'gam'
- it copies the resulting GPT slot name to ortb2imp.ext.data.adserver.adslot

The customPbAdSlot function is called if it was specified, writing the results to fpd.context.pbAdSlot.
If there's no customPbAdSlot, a default algorithm is used to determine fpd.context.pbAdSlot:
The customPbAdSlot function is called if it was specified, writing the results to ortb2imp.ext.data.pbadslot.
If there's no customPbAdSlot, a default algorithm is used to determine ortb2imp.ext.data.pbadslot:

- first use the AdUnit's context.pbAdSlot if defined
- first use the AdUnit's ortb2imp.ext.data.pbadslot if defined
- else, see if the AdUnit.code corresponds to a div and if so, try to retrieve a data element from the div called data-adslotid.
- else if the GPT slot matching succeeded, use the GPT slot name
- else, just use the AdUnit.code, assuming that that's the ad unit slot
Expand Down

0 comments on commit 4519222

Please sign in to comment.