prebid.js 6.1.0 → 6.2.0

package/README.md

@@ -274,7 +274,7 @@ As you make code changes, the bundles will be rebuilt and the page reloaded auto
 
 ## Contribute
 
-Many SSPs, bidders, and publishers have contributed to this project. [Hundreds of bidders](https://github.com/prebid/Prebid.js/tree/master/src/adapters) are supported by Prebid.js.
+Many SSPs, bidders, and publishers have contributed to this project. [Hundreds of bidders](https://github.com/prebid/Prebid.js/tree/master/modules) are supported by Prebid.js.
 
 For guidelines, see [Contributing](./CONTRIBUTING.md).
 

package/browsers.json

@@ -1,65 +1,49 @@
 {
-  "bs_edge_17_windows_10": {
+  "bs_edge_latest_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "edge",
-    "browser_version": "17.0",
+    "browser_version": "latest",
     "device": null,
     "os": "Windows"
   },
-  "bs_edge_90_windows_10": {
-    "base": "BrowserStack",
-    "os_version": "10",
-    "browser": "edge",
-    "browser_version": "90.0",
-    "device": null,
-    "os": "Windows"
-  },
-  "bs_chrome_90_windows_10": {
+  "bs_chrome_latest_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "chrome",
-    "browser_version": "90.0",
+    "browser_version": "latest",
     "device": null,
     "os": "Windows"
   },
-  "bs_chrome_79_windows_10": {
+  "bs_chrome_87_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "chrome",
-    "browser_version": "79.0",
-    "device": null,
-    "os": "Windows"
-  },
-  "bs_firefox_88_windows_10": {
-    "base": "BrowserStack",
-    "os_version": "10",
-    "browser": "firefox",
-    "browser_version": "88.0",
+    "browser_version": "87.0",
     "device": null,
     "os": "Windows"
   },
-  "bs_firefox_72_windows_10": {
+  "bs_firefox_latest_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "firefox",
-    "browser_version": "72.0",
+    "browser_version": "latest",
     "device": null,
     "os": "Windows"
   },
-  "bs_safari_14_mac_bigsur": {
+  "bs_safari_latest_mac_bigsur": {
     "base": "BrowserStack",
     "os_version": "Big Sur",
     "browser": "safari",
-    "browser_version": "14.0",
+    "browser_version": "latest",
     "device": null,
     "os": "OS X"
   },
-  "bs_safari_12_mac_mojave": {
+  "bs_safari_15_catalina": {
     "base": "BrowserStack",
-    "os_version": "Mojave",
+    "os_version": "Catalina",
     "browser": "safari",
-    "browser_version": "12.0",
+    "browser_version": "13.1",
     "device": null,
     "os": "OS X"
   }

package/karma.conf.maker.js

@@ -166,7 +166,7 @@ module.exports = function(codeCoverage, browserstack, watchMode, file) {
     browserNoActivityTimeout: 3e5, // default 10000
     captureTimeout: 3e5, // default 60000,
     browserDisconnectTolerance: 3,
-    concurrency: 5,
+    concurrency: 6,
 
     plugins: plugins
   }

package/modules/admixerBidAdapter.js

@@ -1,6 +1,7 @@
 import { logError } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
+import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'admixer';
 const ALIASES = ['go2net', 'adblender', 'adsyield'];
@@ -8,7 +9,7 @@ const ENDPOINT_URL = 'https://inv-nets.admixer.net/prebid.1.2.aspx';
 export const spec = {
   code: BIDDER_CODE,
   aliases: ALIASES,
-  supportedMediaTypes: ['banner', 'video'],
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
   /**
    * Determines whether or not the given bid request is valid.
    */

package/modules/adnuntiusBidAdapter.js

@@ -37,7 +37,8 @@ const handleMeta = function () {
 }
 
 const getUsi = function (meta, ortb2, bidderRequest) {
-  const usi = (meta !== null) ? meta.usi : false;
+  let usi = (meta !== null && meta.usi) ? meta.usi : false;
+  if (ortb2 && ortb2.user && ortb2.user.id) { usi = ortb2.user.id }
   return usi
 }
 

package/modules/adplusBidAdapter.js

@@ -0,0 +1,203 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import * as utils from '../src/utils.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { getStorageManager } from '../src/storageManager.js';
+
+// #region Constants
+export const BIDDER_CODE = 'adplus';
+export const ADPLUS_ENDPOINT = 'https://ssp.ad-plus.com.tr/server/headerBidding';
+export const DGID_CODE = 'adplus_dg_id';
+export const SESSION_CODE = 'adplus_s_id';
+export const storage = getStorageManager(undefined, BIDDER_CODE);
+const COOKIE_EXP = 1000 * 60 * 60 * 24; // 1 day
+// #endregion
+
+// #region Helpers
+export function isValidUuid (uuid) {
+  return /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(
+    uuid
+  );
+}
+
+function getSessionId() {
+  let sid = storage.cookiesAreEnabled() && storage.getCookie(SESSION_CODE);
+
+  if (
+    !sid || !isValidUuid(sid)
+  ) {
+    sid = utils.generateUUID();
+    setSessionId(sid);
+  }
+
+  return sid;
+}
+
+function setSessionId(sid) {
+  if (storage.cookiesAreEnabled()) {
+    const expires = new Date(Date.now() + COOKIE_EXP).toISOString();
+
+    storage.setCookie(SESSION_CODE, sid, expires);
+  }
+}
+// #endregion
+
+// #region Bid request validation
+function isBidRequestValid(bid) {
+  if (!bid) {
+    utils.logError(BIDDER_CODE, 'bid, can not be empty', bid);
+    return false;
+  }
+
+  if (!bid.params) {
+    utils.logError(BIDDER_CODE, 'bid.params is required.');
+    return false;
+  }
+
+  if (!bid.params.adUnitId || typeof bid.params.adUnitId !== 'string') {
+    utils.logError(
+      BIDDER_CODE,
+      'bid.params.adUnitId is missing or has wrong type.'
+    );
+    return false;
+  }
+
+  if (!bid.params.inventoryId || typeof bid.params.inventoryId !== 'string') {
+    utils.logError(
+      BIDDER_CODE,
+      'bid.params.inventoryId is missing or has wrong type.'
+    );
+    return false;
+  }
+
+  if (
+    !bid.mediaTypes ||
+    !bid.mediaTypes[BANNER] ||
+    !utils.isArray(bid.mediaTypes[BANNER].sizes) ||
+    bid.mediaTypes[BANNER].sizes.length <= 0 ||
+    !utils.isArrayOfNums(bid.mediaTypes[BANNER].sizes[0])
+  ) {
+    utils.logError(BIDDER_CODE, 'Wrong or missing size parameters.');
+    return false;
+  }
+
+  return true;
+}
+// #endregion
+
+// #region Building the bid requests
+/**
+ *
+ * @param {object} bid
+ * @returns
+ */
+function createBidRequest(bid) {
+  // Developer Params
+  const {
+    inventoryId,
+    adUnitId,
+    extraData,
+    yearOfBirth,
+    gender,
+    categories,
+    latitude,
+    longitude,
+    sdkVersion,
+  } = bid.params;
+
+  return {
+    method: 'GET',
+    url: ADPLUS_ENDPOINT,
+    data: utils.cleanObj({
+      bidId: bid.bidId,
+      inventoryId,
+      adUnitId,
+      adUnitWidth: bid.mediaTypes[BANNER].sizes[0][0],
+      adUnitHeight: bid.mediaTypes[BANNER].sizes[0][1],
+      extraData,
+      yearOfBirth,
+      gender,
+      categories,
+      latitude,
+      longitude,
+      sdkVersion: sdkVersion || '1',
+      session: getSessionId(),
+      interstitial: 0,
+      token: typeof window.top === 'object' && window.top[DGID_CODE] ? window.top[DGID_CODE] : undefined,
+      secure: window.location.protocol === 'https:' ? 1 : 0,
+      screenWidth: screen.width,
+      screenHeight: screen.height,
+      language: window.navigator.language || 'en-US',
+      pageUrl: window.location.href,
+      domain: window.location.hostname,
+      referrer: window.location.referrer,
+    }),
+  };
+}
+
+function buildRequests(validBidRequests, bidderRequest) {
+  return validBidRequests.map((req) => createBidRequest(req));
+}
+// #endregion
+
+// #region Interpreting Responses
+/**
+ *
+ * @param {HeaderBiddingResponse} responseData
+ * @param { object } bidParams
+ * @returns
+ */
+function createAdResponse(responseData, bidParams) {
+  return {
+    requestId: responseData.requestID,
+    cpm: responseData.cpm,
+    currency: responseData.currency,
+    width: responseData.width,
+    height: responseData.height,
+    creativeId: responseData.creativeID,
+    dealId: responseData.dealID,
+    netRevenue: responseData.netRevenue,
+    ttl: responseData.ttl,
+    ad: responseData.ad,
+    mediaType: responseData.mediaType,
+    meta: {
+      advertiserDomains: responseData.advertiserDomains,
+      primaryCatId: utils.isArray(responseData.categoryIDs) && responseData.categoryIDs.length > 0
+        ? responseData.categoryIDs[0] : undefined,
+      secondaryCatIds: responseData.categoryIDs,
+    },
+  };
+}
+
+function interpretResponse(response, request) {
+  // In case of empty response
+  if (
+    response.body == null ||
+    !utils.isArray(response.body) ||
+    response.body.length === 0
+  ) {
+    return [];
+  }
+  const bids = response.body.map((bid) => createAdResponse(bid));
+  return bids;
+}
+// #endregion
+
+// #region Bidder
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+  isBidRequestValid,
+  buildRequests,
+  interpretResponse,
+  onTimeout(timeoutData) {
+    utils.logError('Adplus adapter timed out for the auction.', timeoutData);
+  },
+  onBidWon(bid) {
+    utils.logInfo(
+      `Adplus adapter won the auction. Bid id: ${bid.bidId}, Ad Unit Id: ${bid.adUnitId}, Inventory Id: ${bid.inventoryId}`
+    );
+  },
+};
+
+registerBidder(spec);
+// #endregion

package/modules/adplusBidAdapter.md

@@ -0,0 +1,39 @@
+# Overview
+
+Module Name: AdPlus Bidder Adapter
+
+Module Type: Bidder Adapter
+
+Maintainer: adplus.destek@yaani.com.tr
+
+# Description
+
+AdPlus Prebid.js Bidder Adapter. Only banner formats are supported.
+
+About us : https://ssp.ad-plus.com.tr/
+
+# Test Parameters
+
+```javascript
+var adUnits = [
+  {
+    code: "div-adplus",
+    mediaTypes: {
+      banner: {
+        sizes: [
+          [300, 250],
+        ],
+      },
+    },
+    bids: [
+      {
+        bidder: "adplus",
+        params: {
+          inventoryId: "-1",
+          adUnitId: "-3",
+        },
+      },
+    ],
+  },
+];
+```

package/modules/adyoulikeBidAdapter.js

@@ -1,6 +1,7 @@
 import { deepAccess, buildUrl, parseSizesInput } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
+import { createEidsArray } from './userId/eids.js';
 import find from 'core-js-pure/features/array/find.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 
@@ -97,17 +98,21 @@ export const spec = {
       PageRefreshed: getPageRefreshed()
     };
 
-    if (bidderRequest && bidderRequest.gdprConsent) {
+    if (bidderRequest.gdprConsent) {
       payload.gdprConsent = {
         consentString: bidderRequest.gdprConsent.consentString,
         consentRequired: (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') ? bidderRequest.gdprConsent.gdprApplies : null
       };
     }
 
-    if (bidderRequest && bidderRequest.uspConsent) {
+    if (bidderRequest.uspConsent) {
       payload.uspConsent = bidderRequest.uspConsent;
     }
 
+    if (deepAccess(bidderRequest, 'userId')) {
+      payload.userId = createEidsArray(bidderRequest.userId);
+    }
+
     const data = JSON.stringify(payload);
     const options = {
       withCredentials: true

package/modules/appnexusBidAdapter.js

@@ -1,4 +1,4 @@
-import { convertCamelToUnderscore, isArray, isNumber, isPlainObject, logError, logInfo, deepAccess, logMessage, convertTypes, isStr, getParameterByName, deepClone, chunk, logWarn, getBidRequest, createTrackPixelHtml, isEmpty, transformBidderParamKeywords, getMaxValueFromArray, fill, getMinValueFromArray, isArrayOfNums, isFn } from '../src/utils.js';
+import { convertCamelToUnderscore, isArray, isNumber, isPlainObject, logError, logInfo, deepAccess, logMessage, convertTypes, isStr, getParameterByName, deepClone, chunk, logWarn, getBidRequest, createTrackPixelHtml, isEmpty, transformBidderParamKeywords, getMaxValueFromArray, fill, getMinValueFromArray, isArrayOfNums, isFn, isAllowZeroCpmBidsEnabled } from '../src/utils.js';
 import { Renderer } from '../src/Renderer.js';
 import { config } from '../src/config.js';
 import { registerBidder, getIabSubCategory } from '../src/adapters/bidderFactory.js';
@@ -293,7 +293,8 @@ export const spec = {
       serverResponse.tags.forEach(serverBid => {
         const rtbBid = getRtbBid(serverBid);
         if (rtbBid) {
-          if (rtbBid.cpm !== 0 && includes(this.supportedMediaTypes, rtbBid.ad_type)) {
+          const cpmCheck = (isAllowZeroCpmBidsEnabled(bidderRequest.bidderCode)) ? rtbBid.cpm >= 0 : rtbBid.cpm > 0;
+          if (cpmCheck && includes(this.supportedMediaTypes, rtbBid.ad_type)) {
             const bid = newBid(serverBid, rtbBid, bidderRequest);
             bid.mediaType = parseMediaType(rtbBid);
             bids.push(bid);
@@ -598,6 +599,22 @@ function newBid(serverBid, rtbBid, bidderRequest) {
     bid.meta = Object.assign({}, bid.meta, { advertiserId: rtbBid.advertiser_id });
   }
 
+  // temporary function; may remove at later date if/when adserver fully supports dchain
+  function setupDChain(rtbBid) {
+    let dchain = {
+      ver: '1.0',
+      complete: 0,
+      nodes: [{
+        bsid: rtbBid.buyer_member_id.toString()
+      }],
+    };
+
+    return dchain;
+  }
+  if (rtbBid.buyer_member_id) {
+    bid.meta = Object.assign({}, bid.meta, {dchain: setupDChain(rtbBid)});
+  }
+
   if (rtbBid.brand_id) {
     bid.meta = Object.assign({}, bid.meta, { brandId: rtbBid.brand_id });
   }

package/modules/beachfrontBidAdapter.js

@@ -1,4 +1,4 @@
-import { logWarn, deepAccess, isArray, parseSizesInput, isFn, parseUrl, getUniqueIdentifierStr } from '../src/utils.js';
+import { logWarn, deepAccess, deepSetValue, deepClone, isArray, parseSizesInput, isFn, parseUrl, getUniqueIdentifierStr } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { Renderer } from '../src/Renderer.js';
@@ -6,7 +6,7 @@ import { VIDEO, BANNER } from '../src/mediaTypes.js';
 import find from 'core-js-pure/features/array/find.js';
 import includes from 'core-js-pure/features/array/includes.js';
 
-const ADAPTER_VERSION = '1.18';
+const ADAPTER_VERSION = '1.19';
 const ADAPTER_NAME = 'BFIO_PREBID';
 const OUTSTREAM = 'outstream';
 const CURRENCY = 'USD';
@@ -360,6 +360,7 @@ function createVideoRequestData(bid, bidderRequest) {
   let tagid = getVideoBidParam(bid, 'tagid');
   let topLocation = getTopWindowLocation(bidderRequest);
   let eids = getEids(bid);
+  let ortb2 = deepClone(config.getConfig('ortb2'));
   let payload = {
     isPrebid: true,
     appId: appId,
@@ -378,6 +379,7 @@ function createVideoRequestData(bid, bidderRequest) {
       displaymanagerver: ADAPTER_VERSION
     }],
     site: {
+      ...deepAccess(ortb2, 'site', {}),
       page: topLocation.href,
       domain: topLocation.hostname
     },
@@ -389,39 +391,32 @@ function createVideoRequestData(bid, bidderRequest) {
       js: 1,
       geo: {}
     },
-    regs: {
-      ext: {}
-    },
-    source: {
-      ext: {}
-    },
-    user: {
-      ext: {}
-    },
+    app: deepAccess(ortb2, 'app'),
+    user: deepAccess(ortb2, 'user'),
     cur: [CURRENCY]
   };
 
   if (bidderRequest && bidderRequest.uspConsent) {
-    payload.regs.ext.us_privacy = bidderRequest.uspConsent;
+    deepSetValue(payload, 'regs.ext.us_privacy', bidderRequest.uspConsent);
   }
 
   if (bidderRequest && bidderRequest.gdprConsent) {
     let { gdprApplies, consentString } = bidderRequest.gdprConsent;
-    payload.regs.ext.gdpr = gdprApplies ? 1 : 0;
-    payload.user.ext.consent = consentString;
+    deepSetValue(payload, 'regs.ext.gdpr', gdprApplies ? 1 : 0);
+    deepSetValue(payload, 'user.ext.consent', consentString);
   }
 
   if (bid.schain) {
-    payload.source.ext.schain = bid.schain;
+    deepSetValue(payload, 'source.ext.schain', bid.schain);
   }
 
   if (eids.length > 0) {
-    payload.user.ext.eids = eids;
+    deepSetValue(payload, 'user.ext.eids', eids);
   }
 
   let connection = navigator.connection || navigator.webkitConnection;
   if (connection && connection.effectiveType) {
-    payload.device.connectiontype = connection.effectiveType;
+    deepSetValue(payload, 'device.connectiontype', connection.effectiveType);
   }
 
   return payload;
@@ -439,8 +434,10 @@ function createBannerRequestData(bids, bidderRequest) {
       sizes: getBannerSizes(bid)
     };
   });
+  let ortb2 = deepClone(config.getConfig('ortb2'));
   let payload = {
     slots: slots,
+    ortb2: ortb2,
     page: topLocation.href,
     domain: topLocation.hostname,
     search: topLocation.search,

package/modules/craftBidAdapter.js

@@ -5,6 +5,7 @@ import { auctionManager } from '../src/auctionManager.js';
 import find from 'core-js-pure/features/array/find.js';
 import includes from 'core-js-pure/features/array/includes.js';
 import { getStorageManager } from '../src/storageManager.js';
+import {ajax} from '../src/ajax.js';
 
 const BIDDER_CODE = 'craft';
 const URL_BASE = 'https://gacraft.jp/prebid-v3';
@@ -110,9 +111,10 @@ export const spec = {
   },
 
   onBidWon: function(bid) {
-    var xhr = new XMLHttpRequest();
-    xhr.open('POST', bid._prebidWon);
-    xhr.send();
+    ajax(bid._prebidWon, null, null, {
+      method: 'POST',
+      contentType: 'application/json'
+    });
   }
 };