Skip to content

pb11-notes.md

Latest commit

 

History

History
106 lines (77 loc) · 4.48 KB

pb11-notes.md

File metadata and controls

106 lines (77 loc) · 4.48 KB
layout title description sidebarType
page_v2
Prebid.js 11.0 Release Notes & Publisher API Changes
Description of the breaking changes included for Prebid.js 11.0
1

Prebid.js 11.0 Adapter Interface and Publisher API Changes

{:.no_toc}

This document describes the changes included for Prebid.js version 11.0.

  • TOC {:toc}

Publisher Summary

  1. A number of obsolete modules have been removed (see list below).
  2. Adpod is no longer supported.
  3. PAAPI is no longer supported.
  4. The addAdUnits, bidAccepted, and seatNonBid events have been removed.
  5. The storageControl module now defaults to strict enforcement.
  6. The way viewability is calculated and signaled has been overhauled.

Removed Modules

The following modules have been removed from Prebid.js as part of the 11.0 release:

{: .table .table-bordered .table-striped }

Module Notes
adpod
categoryTranslation
dfpAdServerVideo Use gamAdServerVideo instead
dfpAdpod
dmdIdSystem
express
freeWheelAdserverVideo
gamAdpod
intersectionRtdProvider
optableBidAdapter
paapi
paapiForGpt
topLevelPaapi
quantcastBidAdapter
quantcastIdSystem
ringieraxelspringerBidAdapter

Removed events

The following events have been removed and will no longer trigger callbacks registered with pbjs.onEvent:

  • addAdUnits: this event carried no information besides the fact that pbjs.addAdUnits was called. auctionInit and beforeRequestBids contain the ad units involved in each auction.
  • bidAccepted: use bidResponse instead.
  • seatNonBid: use pbsAnalytics instead.

Strict storageControl enforcement

The storageControl module now defaults to strict enforcement; including it will cause undisclosed storage use to fail instead of just logging a warning. You may revert to warning only with

pbjs.setConfig({
  storageControl: {
    enforcement: 'off'
  }
})

Viewability overhaul

A number of changes were aimed at standardizing two related problems: viewability of an ad unit at the time an auction starts; and viewability of an ad that was rendered on the page.

adUnit.element and getAdUnitElement

Many adapters attempt to calculate the position of an ad unit on the page so that they can include that information in their bid request. To facilitate this, 11.0 adds a new element configuration option for ad units that can be used to specify the page element it corresponds to. For example:

pbjs.requestBids({
  adUnits: [{
    code: 'myAdUnit',
    element: document.querySelector('#ad-container')
    // ...
  }]
})

Adapters can retrieve the element using the getAdUnitElement utility function. If element is not specified for an ad unit it defaults to document.getElementById(adUnit.code).

Viewability after rendering

To determine viewability of an ad rendered on the page, publishers can choose one of two optional modules:

When a bid is deemed viewable, both modules now:

  • fire a bidViewable event
  • run the relevant adapter's onBidViewable method
  • trigger "viewable-mrc50" (event: 2) event trackers in the bid's eventtracker array.