From 4d1319e00abf62093cd8f73ff66e49d06d6284da Mon Sep 17 00:00:00 2001
From: bretg <bgorsline@gmail.com>
Date: Mon, 3 May 2021 13:07:28 -0400
Subject: [PATCH] added getHighestUnusedBidResponseForAdUnitCode

---
 dev-docs/publisher-api-reference.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/dev-docs/publisher-api-reference.md b/dev-docs/publisher-api-reference.md
index c876d71303..f8d5d48c95 100644
--- a/dev-docs/publisher-api-reference.md
+++ b/dev-docs/publisher-api-reference.md
@@ -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)
@@ -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