prebid.js 5.20.0 → 6.3.0

package/modules/adheseBidAdapter.js

@@ -2,6 +2,7 @@
 
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'adhese';
 const GVLID = 553;
@@ -20,11 +21,15 @@ export const spec = {
     if (validBidRequests.length === 0) {
       return null;
     }
+
     const { gdprConsent, refererInfo } = bidderRequest;
 
+    const adheseConfig = config.getConfig('adhese');
     const gdprParams = (gdprConsent && gdprConsent.consentString) ? { xt: [gdprConsent.consentString] } : {};
     const refererParams = (refererInfo && refererInfo.referer) ? { xf: [base64urlEncode(refererInfo.referer)] } : {};
-    const commonParams = { ...gdprParams, ...refererParams };
+    const globalCustomParams = (adheseConfig && adheseConfig.globalTargets) ? cleanTargets(adheseConfig.globalTargets) : {};
+    const commonParams = { ...globalCustomParams, ...gdprParams, ...refererParams };
+    const vastContentAsUrl = !(adheseConfig && adheseConfig.vastContentAsUrl == false);
 
     const slots = validBidRequests.map(bid => ({
       slotname: bidToSlotName(bid),
@@ -34,7 +39,7 @@ export const spec = {
     const payload = {
       slots: slots,
       parameters: commonParams,
-      vastContentAsUrl: true,
+      vastContentAsUrl: vastContentAsUrl,
       user: {
         ext: {
           eids: getEids(validBidRequests),

package/modules/adkernelBidAdapter.js

@@ -75,6 +75,7 @@ export const spec = {
     {code: 'denakop'},
     {code: 'rtbanalytica'},
     {code: 'unibots'},
+    {code: 'catapultx'},
     {code: 'ergadx'},
     {code: 'turktelekom'}
   ],

package/modules/adlivetechBidAdapter.md

@@ -0,0 +1,61 @@
+# Overview
+
+Module Name: Adlivetech Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: grid-tech@themediagrid.com
+
+# Description
+
+Module that connects to Grid demand source to fetch bids.
+The adapter is GDPR compliant and supports banner and video (instream and outstream).
+
+# Test Parameters
+```
+    var adUnits = [
+           {
+               code: 'test-div',
+               sizes: [[300, 250]],
+               bids: [
+                   {
+                       bidder: "adlivetech",
+                       params: {
+                           uid: '1',
+                           bidFloor: 0.5
+                       }
+                   }
+               ]
+           },{
+               code: 'test-div',
+               sizes: [[728, 90]],
+               bids: [
+                   {
+                       bidder: "adlivetech",
+                       params: {
+                           uid: 2,
+                           keywords: {
+                               brandsafety: ['disaster'],
+                               topic: ['stress', 'fear']
+                           }
+                       }
+                   }
+               ]
+           },
+           {
+               code: 'test-div',
+               sizes: [[728, 90]],
+               mediaTypes: { video: {
+                   context: 'instream',
+                   playerSize: [728, 90],
+                   mimes: ['video/mp4']
+               },
+               bids: [
+                   {
+                       bidder: "adlivetech",
+                       params: {
+                           uid: 11
+                       }
+                   }
+               ]
+          }
+       ];
+```

package/modules/admanBidAdapter.js

@@ -108,6 +108,7 @@ export const spec = {
       }
       if (bid.userId) {
         getUserId(placement.eids, bid.userId.uid2 && bid.userId.uid2.id, 'uidapi.com');
+        getUserId(placement.eids, bid.userId.lotamePanoramaId, 'lotame.com');
       }
       if (traff === VIDEO) {
         placement.playerSize = bid.mediaTypes[VIDEO].playerSize;

package/modules/admixerBidAdapter.js

@@ -1,14 +1,15 @@
 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'];
+const ALIASES = ['go2net', 'adblender', 'adsyield', 'futureads'];
 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
 }
 
@@ -55,6 +56,8 @@ export const spec = {
     const requests = [];
     const request = [];
     const ortb2 = config.getConfig('ortb2');
+    const bidderConfig = config.getConfig();
+
     const adnMeta = handleMeta()
     const usi = getUsi(adnMeta, ortb2, bidderRequest)
     const segments = getSegmentsFromOrtb(ortb2);
@@ -67,7 +70,7 @@ export const spec = {
     if (gdprApplies !== undefined) request.push('consentString=' + consentString);
     if (segments.length > 0) request.push('segments=' + segments.join(','));
     if (usi) request.push('userId=' + usi);
-
+    if (bidderConfig.useCookie === false) request.push('noCookies=true')
     for (var i = 0; i < validBidRequests.length; i++) {
       const bid = validBidRequests[i]
       const network = bid.params.network || 'network';

package/modules/adomikAnalyticsAdapter.js

@@ -12,6 +12,7 @@ const bidRequested = CONSTANTS.EVENTS.BID_REQUESTED;
 const bidResponse = CONSTANTS.EVENTS.BID_RESPONSE;
 const bidWon = CONSTANTS.EVENTS.BID_WON;
 const bidTimeout = CONSTANTS.EVENTS.BID_TIMEOUT;
+const ua = navigator.userAgent;
 
 let adomikAdapter = Object.assign(adapter({}),
   {
@@ -47,7 +48,7 @@ let adomikAdapter = Object.assign(adapter({}),
               type: 'request',
               event: {
                 bidder: bid.bidder.toUpperCase(),
-                placementCode: bid.placementCode
+                placementCode: bid.adUnitCode
               }
             });
           });
@@ -67,6 +68,10 @@ adomikAdapter.initializeBucketEvents = function() {
   adomikAdapter.bucketEvents = [];
 }
 
+adomikAdapter.maxPartLength = function () {
+  return (ua.includes(' MSIE ')) ? 1600 : 60000;
+};
+
 adomikAdapter.sendTypedEvent = function() {
   const groupedTypedEvents = adomikAdapter.buildTypedEvents();
 
@@ -108,9 +113,10 @@ adomikAdapter.sendTypedEvent = function() {
   // Encode object in base64
   const encodedBuf = window.btoa(stringBulkEvents);
 
-  // Create final url and split it in 1600 characters max (+endpoint length)
+  // Create final url and split it (+endpoint length)
   const encodedUri = encodeURIComponent(encodedBuf);
-  const splittedUrl = encodedUri.match(/.{1,1600}/g);
+  const maxLength = adomikAdapter.maxPartLength();
+  const splittedUrl = encodedUri.match(new RegExp(`.{1,${maxLength}}`, 'g'));
 
   splittedUrl.forEach((split, i) => {
     const partUrl = `${split}&id=${adomikAdapter.currentContext.id}&part=${i}&on=${splittedUrl.length - 1}`;
@@ -121,7 +127,7 @@ adomikAdapter.sendTypedEvent = function() {
 
 adomikAdapter.sendWonEvent = function (wonEvent) {
   const stringWonEvent = JSON.stringify(wonEvent)
-  logInfo('Won event sent to adomik prebid analytic ' + wonEvent);
+  logInfo('Won event sent to adomik prebid analytic ' + stringWonEvent);
 
   // Encode object in base64
   const encodedBuf = window.btoa(stringWonEvent);

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",
+        },
+      },
+    ],
+  },
+];
+```