added feature/getNoBidsForAdUnitCode function (#5932)

* added feature/getNoBidsForAdUnitCode function * added unit test
prebid · Nov 16, 2020 · ac686e5 · ac686e5
1 parent fb32955
commit ac686e5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/src/prebid.js b/src/prebid.js
@@ -258,6 +258,18 @@ $$PREBID_GLOBAL$$.getNoBids = function () {
   return getBids('getNoBids');
 };
 
+/**
+ * This function returns the bids requests involved in an auction but not bid on or the specified adUnitCode
+ * @param  {string} adUnitCode adUnitCode
+ * @alias module:pbjs.getNoBidsForAdUnitCode
+ * @return {Object}           bidResponse object
+ */
+
+$$PREBID_GLOBAL$$.getNoBidsForAdUnitCode = function (adUnitCode) {
+  const bids = auctionManager.getNoBids().filter(bid => bid.adUnitCode === adUnitCode);
+  return { bids };
+};
+
 /**
  * This function returns the bid responses at the given moment.
  * @alias module:pbjs.getBidResponses

diff --git a/test/spec/api_spec.js b/test/spec/api_spec.js
@@ -43,10 +43,14 @@ describe('Publisher API', function () {
       assert.isFunction($$PREBID_GLOBAL$$.getBidResponses);
     });
 
-    it('should have function $$PREBID_GLOBAL$$.getBidResponses', function () {
+    it('should have function $$PREBID_GLOBAL$$.getNoBids', function () {
       assert.isFunction($$PREBID_GLOBAL$$.getNoBids);
     });
 
+    it('should have function $$PREBID_GLOBAL$$.getNoBidsForAdUnitCode', function () {
+      assert.isFunction($$PREBID_GLOBAL$$.getNoBidsForAdUnitCode);
+    });
+
     it('should have function $$PREBID_GLOBAL$$.getBidResponsesForAdUnitCode', function () {
       assert.isFunction($$PREBID_GLOBAL$$.getBidResponsesForAdUnitCode);
     });