prebid.js 7.31.0 → 7.32.0

package/modules/appushBidAdapter.js

@@ -0,0 +1,188 @@
+import { isFn, deepAccess, logMessage, logError } from '../src/utils.js';
+import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'appush';
+const AD_URL = 'https://hb.appush.com/pbjs';
+
+function isBidResponseValid(bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId || !bid.ttl || !bid.currency) {
+    return false;
+  }
+
+  switch (bid.mediaType) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad);
+    case VIDEO:
+      return Boolean(bid.vastUrl || bid.vastXml);
+    case NATIVE:
+      return Boolean(bid.native && bid.native.impressionTrackers && bid.native.impressionTrackers.length);
+    default:
+      return false;
+  }
+}
+
+function getPlacementReqData(bid) {
+  const { params, bidId, mediaTypes } = bid;
+  const schain = bid.schain || {};
+  const { placementId, endpointId } = params;
+  const bidfloor = getBidFloor(bid);
+
+  const placement = {
+    bidId,
+    schain,
+    bidfloor
+  };
+
+  if (placementId) {
+    placement.placementId = placementId;
+    placement.type = 'publisher';
+  } else if (endpointId) {
+    placement.endpointId = endpointId;
+    placement.type = 'network';
+  }
+
+  if (mediaTypes && mediaTypes[BANNER]) {
+    placement.adFormat = BANNER;
+    placement.sizes = mediaTypes[BANNER].sizes;
+  } else if (mediaTypes && mediaTypes[VIDEO]) {
+    placement.adFormat = VIDEO;
+    placement.playerSize = mediaTypes[VIDEO].playerSize;
+    placement.minduration = mediaTypes[VIDEO].minduration;
+    placement.maxduration = mediaTypes[VIDEO].maxduration;
+    placement.mimes = mediaTypes[VIDEO].mimes;
+    placement.protocols = mediaTypes[VIDEO].protocols;
+    placement.startdelay = mediaTypes[VIDEO].startdelay;
+    placement.placement = mediaTypes[VIDEO].placement;
+    placement.skip = mediaTypes[VIDEO].skip;
+    placement.skipafter = mediaTypes[VIDEO].skipafter;
+    placement.minbitrate = mediaTypes[VIDEO].minbitrate;
+    placement.maxbitrate = mediaTypes[VIDEO].maxbitrate;
+    placement.delivery = mediaTypes[VIDEO].delivery;
+    placement.playbackmethod = mediaTypes[VIDEO].playbackmethod;
+    placement.api = mediaTypes[VIDEO].api;
+    placement.linearity = mediaTypes[VIDEO].linearity;
+  } else if (mediaTypes && mediaTypes[NATIVE]) {
+    placement.native = mediaTypes[NATIVE];
+    placement.adFormat = NATIVE;
+  }
+
+  return placement;
+}
+
+function getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return deepAccess(bid, 'params.bidfloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (err) {
+    logError(err);
+    return 0;
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: (bid = {}) => {
+    const { params, bidId, mediaTypes } = bid;
+    let valid = Boolean(bidId && params && (params.placementId || params.endpointId));
+
+    if (mediaTypes && mediaTypes[BANNER]) {
+      valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);
+    } else if (mediaTypes && mediaTypes[VIDEO]) {
+      valid = valid && Boolean(mediaTypes[VIDEO] && mediaTypes[VIDEO].playerSize);
+    } else if (mediaTypes && mediaTypes[NATIVE]) {
+      valid = valid && Boolean(mediaTypes[NATIVE]);
+    } else {
+      valid = false;
+    }
+    return valid;
+  },
+
+  buildRequests: (validBidRequests = [], bidderRequest = {}) => {
+    // convert Native ORTB definition to old-style prebid native definition
+    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
+
+    let deviceWidth = 0;
+    let deviceHeight = 0;
+
+    let winLocation;
+    try {
+      const winTop = window.top;
+      deviceWidth = winTop.screen.width;
+      deviceHeight = winTop.screen.height;
+      winLocation = winTop.location;
+    } catch (e) {
+      logMessage(e);
+      winLocation = window.location;
+    }
+
+    const refferUrl = bidderRequest.refererInfo && bidderRequest.refererInfo.page;
+    let refferLocation;
+    try {
+      refferLocation = refferUrl && new URL(refferUrl);
+    } catch (e) {
+      logMessage(e);
+    }
+    // TODO: does the fallback make sense here?
+    let location = refferLocation || winLocation;
+    const language = (navigator && navigator.language) ? navigator.language.split('-')[0] : '';
+    const host = location.host;
+    const page = location.pathname;
+    const secure = location.protocol === 'https:' ? 1 : 0;
+    const placements = [];
+    const request = {
+      deviceWidth,
+      deviceHeight,
+      language,
+      secure,
+      host,
+      page,
+      placements,
+      coppa: config.getConfig('coppa') === true ? 1 : 0,
+      ccpa: bidderRequest.uspConsent || undefined,
+      gdpr: bidderRequest.gdprConsent || undefined,
+      tmax: config.getConfig('bidderTimeout')
+    };
+
+    const len = validBidRequests.length;
+    for (let i = 0; i < len; i++) {
+      const bid = validBidRequests[i];
+      placements.push(getPlacementReqData(bid));
+    }
+
+    return {
+      method: 'POST',
+      url: AD_URL,
+      data: request
+    };
+  },
+
+  interpretResponse: (serverResponse) => {
+    let response = [];
+    for (let i = 0; i < serverResponse.body.length; i++) {
+      let resItem = serverResponse.body[i];
+      if (isBidResponseValid(resItem)) {
+        const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
+        resItem.meta = { ...resItem.meta, advertiserDomains };
+
+        response.push(resItem);
+      }
+    }
+    return response;
+  }
+};
+
+registerBidder(spec);

package/modules/appushBidAdapter.md

@@ -0,0 +1,79 @@
+# Overview
+
+```
+Module Name: Appush Bidder Adapter
+Module Type: Appush Bidder Adapter
+Maintainer: support@appush.com
+```
+
+# Description
+
+Connects to Appush exchange for bids.
+Appush bid adapter supports Banner, Video (instream and outstream) and Native.
+
+# Test Parameters
+```
+    var adUnits = [
+                // Will return static test banner
+                {
+                    code: 'adunit1',
+                    mediaTypes: {
+                        banner: {
+                            sizes: [ [300, 250], [320, 50] ],
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'appush',
+                            params: {
+                                placementId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit2',
+                    mediaTypes: {
+                        video: {
+                            playerSize: [ [640, 480] ],
+                            context: 'instream',
+                            minduration: 5,
+                            maxduration: 60,
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'appush',
+                            params: {
+                                placementId: 'testVideo',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit3',
+                    mediaTypes: {
+                        native: {
+                            title: {
+                                required: true
+                            },
+                            body: {
+                                required: true
+                            },
+                            icon: {
+                                required: true,
+                                size: [64, 64]
+                            }
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'appush',
+                            params: {
+                                placementId: 'testNative',
+                            }
+                        }
+                    ]
+                }
+            ];
+```

package/modules/asoBidAdapter.js

@@ -10,11 +10,11 @@ import {
   parseSizesInput,
   tryAppendQueryString
 } from '../src/utils.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {config} from '../src/config.js';
-import {BANNER, VIDEO} from '../src/mediaTypes.js';
-import {Renderer} from '../src/Renderer.js';
-import {parseDomain} from '../src/refererDetection.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { config } from '../src/config.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import { Renderer } from '../src/Renderer.js';
+import { parseDomain } from '../src/refererDetection.js';
 
 const BIDDER_CODE = 'aso';
 const DEFAULT_SERVER_URL = 'https://srv.aso1.net';
@@ -27,6 +27,9 @@ export const spec = {
 
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO],
+  aliases: [
+    {code: 'bcmint'}
+  ],
 
   isBidRequestValid: bid => {
     return !!bid.params && !!bid.params.zone;

package/modules/confiantRtdProvider.js

@@ -4,7 +4,7 @@
  *
  * The {@link module:modules/realTimeData} module is required
  * The module will inject a Confiant Inc. script into the page to monitor ad impressions
- * @module modules/cleanioRtdProvider
+ * @module modules/confiantRtdProvider
  * @requires module:modules/realTimeData
  */
 

package/modules/connectIdSystem.js

@@ -66,6 +66,11 @@ export const connectIdSubmodule = {
       us_privacy: consentData && consentData.uspConsent ? consentData.uspConsent : ''
     };
 
+    if (connectIdSubmodule.isUnderGPPJurisdiction(consentData)) {
+      data.gpp = consentData.gppConsent.gppString;
+      data.gpp_sid = encodeURIComponent(consentData.gppConsent.applicableSections.join(','));
+    }
+
     INPUT_PARAM_KEYS.forEach(key => {
       if (typeof params[key] != 'undefined') {
         data[key] = params[key];
@@ -98,7 +103,7 @@ export const connectIdSubmodule = {
   },
 
   /**
-   * Utility function that returns a boolean flag indicating if the opporunity
+   * Utility function that returns a boolean flag indicating if the opportunity
    * is subject to GDPR
    * @returns {Boolean}
    */
@@ -106,6 +111,15 @@ export const connectIdSubmodule = {
     return !!(consentData && consentData.gdpr && consentData.gdpr.gdprApplies);
   },
 
+  /**
+   * Utility function that returns a boolean flag indicating if the opportunity
+   * is subject to GPP jurisdiction.
+   * @returns {Boolean}
+   */
+  isUnderGPPJurisdiction(consentData) {
+    return !!(consentData && consentData.gppConsent && consentData.gppConsent.gppString);
+  },
+
   /**
    * Utility function that returns a boolean flag indicating if the user
    * has opeted out via the Yahoo easy-opt-out mechanism.

package/modules/feedadBidAdapter.js

@@ -7,7 +7,7 @@ import {ajax} from '../src/ajax.js';
  * Version of the FeedAd bid adapter
  * @type {string}
  */
-const VERSION = '1.0.4';
+const VERSION = '1.0.5';
 
 /**
  * @typedef {object} FeedAdApiBidRequest
@@ -16,7 +16,8 @@ const VERSION = '1.0.4';
  * @property {number} ad_type
  * @property {string} client_token
  * @property {string} placement_id
- * @property {string} sdk_version
+ * @property {string} prebid_adapter_version
+ * @property {string} prebid_sdk_version
  * @property {boolean} app_hybrid
  *
  * @property {string} [app_bundle_id]
@@ -181,7 +182,8 @@ function createApiBidRParams(request) {
     ad_type: 0,
     client_token: request.params.clientToken,
     placement_id: request.params.placementId,
-    sdk_version: `prebid_${VERSION}`,
+    prebid_adapter_version: VERSION,
+    prebid_sdk_version: '$prebid.version$',
     app_hybrid: false,
   });
 }
@@ -207,7 +209,6 @@ function buildRequests(validBidRequests, bidderRequest) {
     })
   });
   data.bids.forEach(bid => BID_METADATA[bid.bidId] = {
-    // TODO: is 'page' the right value here?
     referer: data.refererInfo.page,
     transactionId: bid.transactionId
   });
@@ -266,7 +267,8 @@ function createTrackingParams(data, klass) {
     prebid_bid_id: bidId,
     prebid_transaction_id: transactionId,
     referer,
-    sdk_version: VERSION
+    prebid_adapter_version: VERSION,
+    prebid_sdk_version: '$prebid.version$',
   };
 }
 

package/modules/holidBidAdapter.js

@@ -0,0 +1,170 @@
+import {
+  deepAccess,
+  getBidIdParameter,
+  isStr,
+  logMessage,
+  triggerPixel,
+} from '../src/utils.js'
+import * as events from '../src/events.js'
+import CONSTANTS from '../src/constants.json'
+import { BANNER } from '../src/mediaTypes.js'
+
+import { registerBidder } from '../src/adapters/bidderFactory.js'
+
+const BIDDER_CODE = 'holid'
+const GVLID = 1177
+const ENDPOINT = 'https://helloworld.holid.io/openrtb2/auction'
+const COOKIE_SYNC_ENDPOINT = 'https://null.holid.io/sync.html'
+const TIME_TO_LIVE = 300
+let wurlMap = {}
+
+events.on(CONSTANTS.EVENTS.BID_WON, bidWonHandler)
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  supportedMediaTypes: [BANNER],
+
+  isBidRequestValid: function (bid) {
+    return !!bid.params.adUnitID
+  },
+
+  buildRequests: function (validBidRequests, _bidderRequest) {
+    return validBidRequests.map((bid) => {
+      const requestData = {
+        ...bid.ortb2,
+        id: bid.auctionId,
+        imp: [getImp(bid)],
+      }
+
+      return {
+        method: 'POST',
+        url: ENDPOINT,
+        data: JSON.stringify(requestData),
+        bidId: bid.bidId,
+      }
+    })
+  },
+
+  interpretResponse: function (serverResponse, bidRequest) {
+    const bidResponses = []
+
+    if (!serverResponse.body.seatbid) {
+      return []
+    }
+
+    serverResponse.body.seatbid.map((response) => {
+      response.bid.map((bid) => {
+        const requestId = bidRequest.bidId
+        const auctionId = bidRequest.auctionId
+        const wurl = deepAccess(bid, 'ext.prebid.events.win')
+        const bidResponse = {
+          requestId,
+          cpm: bid.price,
+          width: bid.w,
+          height: bid.h,
+          ad: bid.adm,
+          creativeId: bid.crid,
+          currency: serverResponse.body.cur,
+          netRevenue: true,
+          ttl: TIME_TO_LIVE,
+        }
+
+        addWurl({ auctionId, requestId, wurl })
+
+        bidResponses.push(bidResponse)
+      })
+    })
+
+    return bidResponses
+  },
+
+  getUserSyncs(optionsType, serverResponse, gdprConsent, uspConsent) {
+    if (!serverResponse || serverResponse.length === 0) {
+      return []
+    }
+
+    const syncs = []
+
+    if (optionsType.iframeEnabled) {
+      const queryParams = []
+
+      queryParams.push('bidders=' + getBidders(serverResponse))
+      queryParams.push('gdpr=' + +gdprConsent.gdprApplies)
+      queryParams.push('gdpr_consent=' + gdprConsent.consentString)
+      queryParams.push('usp_consent=' + (uspConsent || ''))
+
+      let strQueryParams = queryParams.join('&')
+
+      if (strQueryParams.length > 0) {
+        strQueryParams = '?' + strQueryParams
+      }
+
+      syncs.push({
+        type: 'iframe',
+        url: COOKIE_SYNC_ENDPOINT + strQueryParams + '&type=iframe',
+      })
+
+      return syncs
+    }
+  },
+}
+
+function getImp(bid) {
+  const imp = {
+    ext: {
+      prebid: {
+        storedrequest: {
+          id: getBidIdParameter('adUnitID', bid.params),
+        },
+      },
+    },
+  }
+  const sizes =
+    bid.sizes && !Array.isArray(bid.sizes[0]) ? [bid.sizes] : bid.sizes
+
+  if (deepAccess(bid, 'mediaTypes.banner')) {
+    imp.banner = {
+      format: sizes.map((size) => {
+        return { w: size[0], h: size[1] }
+      }),
+    }
+  }
+
+  return imp
+}
+
+function getBidders(serverResponse) {
+  const bidders = serverResponse
+    .map((res) => Object.keys(res.body.ext.responsetimemillis))
+    .flat(1)
+
+  return encodeURIComponent(JSON.stringify([...new Set(bidders)]))
+}
+
+function addWurl(auctionId, adId, wurl) {
+  if ([auctionId, adId].every(isStr)) {
+    wurlMap[`${auctionId}${adId}`] = wurl
+  }
+}
+
+function removeWurl(auctionId, adId) {
+  delete wurlMap[`${auctionId}${adId}`]
+}
+
+function getWurl(auctionId, adId) {
+  if ([auctionId, adId].every(isStr)) {
+    return wurlMap[`${auctionId}${adId}`]
+  }
+}
+
+function bidWonHandler(bid) {
+  const wurl = getWurl(bid.auctionId, bid.adId)
+  if (wurl) {
+    logMessage(`Invoking image pixel for wurl on BID_WIN: "${wurl}"`)
+    triggerPixel(wurl)
+    removeWurl(bid.auctionId, bid.adId)
+  }
+}
+
+registerBidder(spec)

package/modules/holidBidAdapter.md

@@ -0,0 +1,36 @@
+# Overview
+
+```
+Module Name: Holid Bid Adapter
+Module Type: Bidder Adapter
+Maintainer: richard@holid.se
+```
+
+# Description
+
+Currently module supports only banner mediaType.
+
+# Test Parameters
+
+## Sample Banner Ad Unit
+
+```js
+var adUnits = [
+  {
+    code: 'bannerAdUnit',
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 250]],
+      },
+    },
+    bids: [
+      {
+        bidder: 'holid',
+        params: {
+          adUnitID: '12345',
+        },
+      },
+    ],
+  },
+]
+```

package/modules/jwplayerVideoProvider.js

@@ -47,19 +47,26 @@ export function JWPlayerProvider(config, jwplayer_, adState_, timeState_, callba
 
   function init() {
     if (!jwplayer) {
-      triggerSetupFailure(-1); // TODO: come up with code for player absent
+      triggerSetupFailure(-1); // TODO: come up with error code schema- player is absent
       return;
     }
 
     playerVersion = jwplayer.version;
 
     if (playerVersion < minimumSupportedPlayerVersion) {
-      triggerSetupFailure(-2); // TODO: come up with code for version not supported
+      triggerSetupFailure(-2); // TODO: come up with error code schema - version not supported
+      return;
+    }
+
+    if (!document.getElementById(divId)) {
+      triggerSetupFailure(-3); // TODO: come up with error code schema - missing div id
       return;
     }
 
     player = jwplayer(divId);
-    if (player.getState() === undefined) {
+    if (!player || !player.getState) {
+      triggerSetupFailure(-4); // TODO: come up with error code schema - factory function failure
+    } else if (player.getState() === undefined) {
       setupPlayer(playerConfig);
     } else {
       const payload = getSetupCompletePayload();

package/modules/kueezRtbBidAdapter.js

@@ -1,6 +1,6 @@
 import { _each, deepAccess, parseSizesInput, parseUrl, uniques, isFn } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { getStorageManager } from '../src/storageManager.js';
 
 const GVLID = 1165;
@@ -55,7 +55,7 @@ function isBidRequestValid(bid) {
 }
 
 function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
-  const { params, bidId, userId, adUnitCode, schain } = bid;
+  const { params, bidId, userId, adUnitCode, schain, mediaTypes } = bid;
   let { bidFloor, ext } = params;
   const hashUrl = hashCode(topWindowUrl);
   const uniqueDealId = getUniqueDealId(hashUrl);
@@ -89,7 +89,8 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
     bidderVersion: BIDDER_VERSION,
     prebidVersion: '$prebid.version$',
     res: `${screen.width}x${screen.height}`,
-    schain: schain
+    schain: schain,
+    mediaTypes: mediaTypes
   };
 
   appendUserIdsToRequestPayload(data, userId);
@@ -167,11 +168,12 @@ function interpretResponse(serverResponse, request) {
 
   try {
     results.forEach(result => {
-      const { creativeId, ad, price, exp, width, height, currency, advertiserDomains } = result;
+      const { creativeId, ad, price, exp, width, height, currency, advertiserDomains, mediaType = BANNER } = result;
       if (!ad || !price) {
         return;
       }
-      output.push({
+
+      const response = {
         requestId: bidId,
         cpm: price,
         width: width,
@@ -180,11 +182,22 @@ function interpretResponse(serverResponse, request) {
         currency: currency || CURRENCY,
         netRevenue: true,
         ttl: exp || TTL_SECONDS,
-        ad: ad,
         meta: {
           advertiserDomains: advertiserDomains || []
         }
-      })
+      };
+
+      if (mediaType === BANNER) {
+        Object.assign(response, {
+          ad: ad,
+        });
+      } else {
+        Object.assign(response, {
+          vastXml: ad,
+          mediaType: VIDEO
+        });
+      }
+      output.push(response);
     });
     return output;
   } catch (e) {
@@ -268,7 +281,7 @@ export const spec = {
   code: BIDDER_CODE,
   version: BIDDER_VERSION,
   gvlid: GVLID,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
   isBidRequestValid,
   buildRequests,
   interpretResponse,