Skip to content

Commit

Permalink
added getHighestUnusedBidResponseForAdUnitCode (#2926)
Browse files Browse the repository at this point in the history
  • Loading branch information
bretg authored May 3, 2021
1 parent 1780c92 commit 39cb91b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions dev-docs/publisher-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ This page has documentation for the public API methods of Prebid.js.
* [.getHighestCpmBids([adUnitCode])](#module_pbjs.getHighestCpmBids)
* [.getAllWinningBids()](#module_pbjs.getAllWinningBids)
* [.getAllPrebidWinningBids()](#module_pbjs.getAllPrebidWinningBids)
* [.getHighestUnusedBidResponseForAdUnitCode([adUnitCode])](#module_pbjs.getHighestUnused)
* [.getNoBids()](#module_pbjs.getNoBids)
* [.getNoBidsForAdUnitCode(adUnitCode)](#module_pbjs.getNoBidsForAdUnitCode)
* [.setTargetingForGPTAsync([codeArr], customSlotMatching)](#module_pbjs.setTargetingForGPTAsync)
Expand Down Expand Up @@ -469,6 +470,15 @@ Use this method to get all of the bids that have won their respective auctions b

<hr class="full-rule">

<a name="module_pbjs.getHighestUnused"></a>

### pbjs.getHighestUnusedBidResponseForAdUnitCode(adUnitCode) ⇒ `bid object`

Use this method to retrieve the highest unused bid for the specified adUnit. Unused means not it's not rendered.

This differs from [`getHighestCpmBids()`](#module_pbjs.getHighestCpmBids) in that
getHighestCpmBids only considers bids for auctions that have completed (and are also unused), this function considers bids for ongoing auctions as well.

<a name="module_pbjs.getTargeting"></a>

### pbjs.adServers.freewheel.getTargeting(options) ⇒ Object
Expand Down

0 comments on commit 39cb91b

Please sign in to comment.