prebid.js 5.16.0 → 5.20.0

package/modules/glimpseBidAdapter.js

@@ -1,69 +1,181 @@
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js';
+import { BANNER } from '../src/mediaTypes.js'
+import { getStorageManager } from '../src/storageManager.js'
+import { isArray } from '../src/utils.js'
+import { registerBidder } from '../src/adapters/bidderFactory.js'
 
-const BIDDER_CODE = 'glimpse';
+const storageManager = getStorageManager()
 
-function transformEachBidResponse(glimpseBid) {
-  const bid = glimpseBid;
-  bid.meta = { advertiserDomains: [] };
-
-  if (glimpseBid.adomain) {
-    bid.meta.advertiserDomains = glimpseBid.adomain;
-  }
-
-  return bid;
+const BIDDER_CODE = 'glimpse'
+const ENDPOINT = 'https://api.glimpsevault.io/ads/serving/public/v1/prebid'
+const LOCAL_STORAGE_KEY = {
+  glimpse: {
+    jwt: 'gp_vault_jwt',
+  },
 }
 
 export const spec = {
   code: BIDDER_CODE,
-  url: 'https://api.glimpseprotocol.io/cloud/v1/vault/prebid',
   supportedMediaTypes: [BANNER],
 
+  /**
+   * Determines whether or not the given bid request is valid
+   * @param bid {BidRequest} The bid to validate
+   * @return {boolean}
+   */
   isBidRequestValid: (bid) => {
-    try {
-      const { placementId } = bid.params;
-      return typeof placementId === 'string' && placementId.length > 0;
-    } catch (error) {
-      return false;
-    }
+    return (
+      hasValue(bid) &&
+      hasValue(bid.params) &&
+      hasStringValue(bid.params.placementId)
+    )
   },
 
+  /**
+   * Builds http request for Glimpse bids
+   * @param validBidRequests {BidRequest[]}
+   * @param bidderRequest {BidderRequest}
+   * @returns {ServerRequest}
+   */
   buildRequests: (validBidRequests, bidderRequest) => {
-    const { url, code: bidderCode } = spec;
-
-    const bids = validBidRequests.map((request) => {
-      delete request.mediaTypes;
-      return request;
-    });
+    const networkId = window.networkId || -1
+    const bids = validBidRequests.map(processBidRequest)
+    const referer = getReferer(bidderRequest)
+    const gdprConsent = getGdprConsentChoice(bidderRequest)
+    const jwt = getVaultJwt()
 
-    const sdk = {
-      source: 'pbjs',
-      version: '$prebid.version$',
-    };
-
-    const payload = {
-      ...bidderRequest,
-      bidderCode,
-      bids,
-      sdk,
-    };
+    const data = {
+      auth: jwt,
+      data: {
+        bidderCode: spec.code,
+        networkId,
+        bids,
+        referer,
+        gdprConsent,
+      }
+    }
 
     return {
       method: 'POST',
-      url,
-      data: JSON.stringify(payload),
-    };
+      url: ENDPOINT,
+      data: JSON.stringify(data),
+      options: {},
+    }
   },
 
-  interpretResponse: (serverResponse, _) => {
-    let bids = [];
-    try {
-      const { body } = serverResponse;
-      bids = body.map(transformEachBidResponse);
-    } catch (error) {}
+  /**
+   * Parse response from Glimpse server
+   * @param bidResponse {ServerResponse}
+   * @param bidRequest {BidRequest}
+   * @returns {Bid[]}
+   */
+  interpretResponse: (bidResponse, bidRequest) => {
+    const isValidResponse = isValidBidResponse(bidResponse)
+
+    if (isValidResponse) {
+      const {auth, data} = bidResponse.body
+      setVaultJwt(auth)
+      return data.bids
+    }
 
-    return bids;
+    return []
   },
-};
+}
+
+function processBidRequest(bidRequest) {
+  const sizes = normalizeSizes(bidRequest.sizes)
+  const keywords = bidRequest.params.keywords || []
+
+  return {
+    bidId: bidRequest.bidId,
+    placementId: bidRequest.params.placementId,
+    unitCode: bidRequest.adUnitCode,
+    sizes,
+    keywords,
+  }
+}
+
+function normalizeSizes(sizes) {
+  const isSingleSize =
+    isArray(sizes) &&
+    sizes.length === 2 &&
+    !isArray(sizes[0]) &&
+    !isArray(sizes[1])
+
+  if (isSingleSize) {
+    return [sizes]
+  }
+
+  return sizes
+}
+
+function getReferer(bidderRequest) {
+  const hasReferer =
+    hasValue(bidderRequest) &&
+    hasValue(bidderRequest.refererInfo) &&
+    hasStringValue(bidderRequest.refererInfo.referer)
+
+  if (hasReferer) {
+    return bidderRequest.refererInfo.referer
+  }
+
+  return ''
+}
+
+function getGdprConsentChoice(bidderRequest) {
+  const hasGdprConsent =
+    hasValue(bidderRequest) &&
+    hasValue(bidderRequest.gdprConsent)
+
+  if (hasGdprConsent) {
+    return bidderRequest.gdprConsent
+  }
+
+  return {
+    consentString: '',
+    vendorData: {},
+    gdprApplies: false,
+  }
+}
+
+function setVaultJwt(auth) {
+  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.glimpse.jwt, auth)
+}
+
+function getVaultJwt() {
+  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.glimpse.jwt) || ''
+}
+
+function isValidBidResponse(bidResponse) {
+  return (
+    hasValue(bidResponse) &&
+    hasValue(bidResponse.body) &&
+    hasValue(bidResponse.body.data) &&
+    hasArrayValue(bidResponse.body.data.bids) &&
+    hasStringValue(bidResponse.body.auth)
+  )
+}
+
+function hasValue(value) {
+  return (
+    value !== undefined &&
+    value !== null
+  )
+}
+
+function hasStringValue(value) {
+  return (
+    hasValue(value) &&
+    typeof value === 'string' &&
+    value.length > 0
+  )
+}
+
+function hasArrayValue(value) {
+  return (
+    hasValue(value) &&
+    isArray(value) &&
+    value.length > 0
+  )
+}
 
-registerBidder(spec);
+registerBidder(spec)

package/modules/glimpseBidAdapter.md

@@ -3,7 +3,7 @@
 ```
 Module Name:  Glimpse Protocol Bid Adapter
 Module Type:  Bidder Adapter
-Maintainer:   hello@glimpseprotocol.io
+Maintainer:   publisher@glimpseprotocol.io
 ```
 
 # Description
@@ -11,12 +11,12 @@ Maintainer:   hello@glimpseprotocol.io
 This module connects publishers to Glimpse Protocol's demand sources via Prebid.js. Our innovative marketplace protects
 consumer privacy while allowing precise targeting. It is compliant with GDPR, DPA and CCPA.
 
-This adapter supports Banner.
+The Glimpse Adapter supports banner formats.
 
 # Test Parameters
 
 ```javascript
-var adUnits = [
+const adUnits = [
   {
     code: 'banner-div-a',
     mediaTypes: {
@@ -24,78 +24,15 @@ var adUnits = [
         sizes: [[300, 250]],
       },
     },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-300x250',
+    bids: [{
+      bidder: 'glimpse',
+      params: {
+        placementId: 'e53a7f564f8f44cc913b',
+        keywords: {
+          country: 'uk',
         },
       },
-    ],
+    }],
   },
-  {
-    code: 'banner-div-b',
-    mediaTypes: {
-      banner: {
-        sizes: [[320, 50]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-320x50',
-        },
-      },
-    ],
-  },
-  {
-    code: 'banner-div-c',
-    mediaTypes: {
-      banner: {
-        sizes: [[970, 250]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-970x250',
-        },
-      },
-    ],
-  },
-  {
-    code: 'banner-div-d',
-    mediaTypes: {
-      banner: {
-        sizes: [[728, 90]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-728x90',
-        },
-      },
-    ],
-  },
-  {
-    code: 'banner-div-e',
-    mediaTypes: {
-      banner: {
-        sizes: [[300, 600]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          placementId: 'glimpse-demo-300x600',
-        },
-      },
-    ],
-  },
-];
+]
 ```

package/modules/gridBidAdapter.js

@@ -29,6 +29,7 @@ let hasSynced = false;
 
 export const spec = {
   code: BIDDER_CODE,
+  aliases: ['playwire'],
   supportedMediaTypes: [ BANNER, VIDEO ],
   /**
    * Determines whether or not the given bid request is valid.

package/modules/gridNMBidAdapter.js

@@ -231,7 +231,7 @@ export const spec = {
     if (!errorMessage && serverResponse.seatbid) {
       const serverBid = _getBidFromResponse(serverResponse.seatbid[0]);
       if (serverBid) {
-        if (!serverBid.adm) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
+        if (!serverBid.adm && !serverBid.nurl) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
         else if (!serverBid.price) errorMessage = LOG_ERROR_MESS.noPrice + JSON.stringify(serverBid);
         else if (serverBid.content_type !== 'video') errorMessage = LOG_ERROR_MESS.wrongContentType + serverBid.content_type;
         if (!errorMessage) {
@@ -246,17 +246,18 @@ export const spec = {
             netRevenue: true,
             ttl: TIME_TO_LIVE,
             dealId: serverBid.dealid,
-            vastXml: serverBid.adm,
             mediaType: VIDEO,
             meta: {
               advertiserDomains: serverBid.adomain ? serverBid.adomain : []
-            },
-            adResponse: {
-              content: serverBid.adm
             }
           };
 
-          if (serverBid.nurl) {
+          if (serverBid.adm) {
+            bidResponse.vastXml = serverBid.adm;
+            bidResponse.adResponse = {
+              content: bidResponse.vastXml
+            };
+          } else if (serverBid.nurl) {
             bidResponse.vastUrl = serverBid.nurl;
           }
 

package/modules/gumgumBidAdapter.js

@@ -1,5 +1,6 @@
-import { logError, logWarn, parseSizesInput, _each, deepAccess } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import { _each, deepAccess, logError, logWarn, parseSizesInput } from '../src/utils.js';
+
 import { config } from '../src/config.js'
 import { getStorageManager } from '../src/storageManager.js';
 import includes from 'core-js-pure/features/array/includes';
@@ -293,6 +294,14 @@ function buildRequests(validBidRequests, bidderRequest) {
     let data = {};
     let gpid = '';
 
+    const date = new Date();
+    const lt = date && date.getTime();
+    const to = date && date.getTimezoneOffset();
+    if (to) {
+      lt && (data.lt = lt);
+      data.to = to;
+    }
+
     // ADTS-134 Retrieve ID envelopes
     for (const eid in eids) data[eid] = eids[eid];
 
@@ -488,7 +497,12 @@ function interpretResponse(serverResponse, bidRequest) {
   } else if (product === 5 && includes(sizes, '1x1')) {
     sizes = ['1x1'];
   } else if (product === 2 && includes(sizes, '1x1')) {
-    sizes = responseWidth && responseHeight ? [`${responseWidth}x${responseHeight}`] : parseSizesInput(bidRequest.sizes)
+    const requestSizesThatMatchResponse = (bidRequest.sizes && bidRequest.sizes.reduce((result, current) => {
+      const [ width, height ] = current;
+      if (responseWidth === width || responseHeight === height) result.push(current.join('x'));
+      return result
+    }, [])) || [];
+    sizes = requestSizesThatMatchResponse.length ? requestSizesThatMatchResponse : parseSizesInput(bidRequest.sizes)
   }
 
   let [width, height] = sizes[0].split('x');

package/modules/iasRtdProvider.js

@@ -1,13 +1,18 @@
-import { isArray, getAdUnitSizes, getKeys, logError } from '../src/utils.js';
 import { submodule } from '../src/hook.js';
+import * as utils from '../src/utils.js';
+import { ajax } from '../src/ajax.js';
 import { getGlobal } from '../src/prebidGlobal.js';
-import { ajaxBuilder } from '../src/ajax.js';
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
 const SUBMODULE_NAME = 'ias';
-
-let bidResponses = {};
+const IAS_HOST = 'https://pixel.adsafeprotected.com/services/pub';
+export let iasTargeting = {};
+const BRAND_SAFETY_OBJECT_FIELD_NAME = 'brandSafety';
+const FRAUD_FIELD_NAME = 'fr';
+const SLOTS_OBJECT_FIELD_NAME = 'slots';
+const CUSTOM_FIELD_NAME = 'custom';
+const IAS_KW = 'ias-kw';
 
 /**
  * Module init
@@ -16,12 +21,17 @@ let bidResponses = {};
  * @return {boolean}
  */
 export function init(config, userConsent) {
+  const params = config.params;
+  if (!params || !params.pubId) {
+    utils.logError('missing pubId param for IAS provider');
+    return false;
+  }
   return true;
 }
 
 function stringifySlotSizes(sizes) {
   let result = '';
-  if (isArray(sizes)) {
+  if (utils.isArray(sizes)) {
     result = sizes.reduce((acc, size) => {
       acc.push(size.join('.'));
       return acc;
@@ -31,13 +41,14 @@ function stringifySlotSizes(sizes) {
   return result;
 }
 
-function stringifySlot(bidRequest, adUnitPath) {
-  const sizes = getAdUnitSizes(bidRequest);
+function stringifySlot(bidRequest) {
+  const sizes = utils.getAdUnitSizes(bidRequest);
   const id = bidRequest.code;
   const ss = stringifySlotSizes(sizes);
-  const p = bidRequest.code;
+  const adSlot = utils.getGptSlotInfoForAdUnitCode(bidRequest.code);
+  const p = utils.isEmpty(adSlot) ? bidRequest.code : adSlot.gptSlot;
   const slot = { id, ss, p };
-  const keyValues = getKeys(slot).map(function (key) {
+  const keyValues = utils.getKeys(slot).map(function (key) {
     return [key, slot[key]].join(':');
   });
   return '{' + keyValues.join(',') + '}';
@@ -51,35 +62,29 @@ function stringifyScreenSize() {
   return [(window.screen && window.screen.width) || -1, (window.screen && window.screen.height) || -1].join('.');
 }
 
-function getPageLevelKeywords(response) {
+function formatTargetingData(adUnit) {
   let result = {};
-  if (response.brandSafety) {
-    shallowMerge(result, response.brandSafety);
+  if (iasTargeting[BRAND_SAFETY_OBJECT_FIELD_NAME]) {
+    utils.mergeDeep(result, iasTargeting[BRAND_SAFETY_OBJECT_FIELD_NAME]);
+  }
+  if (iasTargeting[FRAUD_FIELD_NAME]) {
+    result[FRAUD_FIELD_NAME] = iasTargeting[FRAUD_FIELD_NAME];
+  }
+  if (iasTargeting[CUSTOM_FIELD_NAME] && IAS_KW in iasTargeting[CUSTOM_FIELD_NAME]) {
+    result[IAS_KW] = iasTargeting[CUSTOM_FIELD_NAME][IAS_KW];
+  }
+  if (iasTargeting[SLOTS_OBJECT_FIELD_NAME] && adUnit in iasTargeting[SLOTS_OBJECT_FIELD_NAME]) {
+    utils.mergeDeep(result, iasTargeting[SLOTS_OBJECT_FIELD_NAME][adUnit]);
   }
-  result.fr = response.fr;
-  result.custom = response.custom;
   return result;
 }
 
-function shallowMerge(dest, src) {
-  getKeys(src).reduce((dest, srcKey) => {
-    dest[srcKey] = src[srcKey];
-    return dest;
-  }, dest);
-}
-
-function getBidRequestData(reqBidsConfigObj, callback, config) {
-  const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
-  let isFinish = false;
-
-  const IAS_HOST = 'https://pixel.adsafeprotected.com/services/pub';
-  const { pubId, adUnitPath } = config.params;
-  const anId = pubId;
+function constructQueryString(anId, adUnits) {
   let queries = [];
   queries.push(['anId', anId]);
 
   queries = queries.concat(adUnits.reduce(function (acc, request) {
-    acc.push(['slot', stringifySlot(request, adUnitPath)]);
+    acc.push(['slot', stringifySlot(request)]);
     return acc;
   }, []));
 
@@ -87,58 +92,69 @@ function getBidRequestData(reqBidsConfigObj, callback, config) {
   queries.push(['sr', stringifyScreenSize()]);
   queries.push(['url', encodeURIComponent(window.location.href)]);
 
-  const queryString = encodeURI(queries.map(qs => qs.join('=')).join('&'));
-
-  const ajax = ajaxBuilder();
-
-  ajax(`${IAS_HOST}?${queryString}`, {
-    success: function (response, request) {
-      if (!isFinish) {
-        if (request.status === 200) {
-          const iasResponse = JSON.parse(response);
-          const commonBidResponse = {};
-          shallowMerge(commonBidResponse, getPageLevelKeywords(iasResponse));
-          commonBidResponse.slots = iasResponse.slots;
-          bidResponses = commonBidResponse;
-          adUnits.forEach(adUnit => {
-            adUnit.bids.forEach(bid => {
-              const rtd = bid.rtd || {};
-              const iasRtd = {};
-              iasRtd[SUBMODULE_NAME] = Object.assign({}, rtd[SUBMODULE_NAME], bidResponses);
-              bid.rtd = Object.assign({}, rtd, iasRtd);
-            });
-          });
-        }
-        isFinish = true;
-      }
-      callback();
-    },
-    error: function () {
-      logError('failed to retrieve targeting information');
-      callback();
-    }
-  });
+  return encodeURI(queries.map(qs => qs.join('=')).join('&'));
+}
+
+function parseResponse(result) {
+  let iasResponse = {};
+  try {
+    iasResponse = JSON.parse(result);
+  } catch (err) {
+    utils.logError('error', err);
+  }
+  iasTargeting = iasResponse;
 }
 
 function getTargetingData(adUnits, config, userConsent) {
   const targeting = {};
-  Object.keys(bidResponses).forEach(key => bidResponses[key] === undefined ? delete bidResponses[key] : {});
   try {
-    adUnits.forEach(function(adUnit) {
-      targeting[adUnit] = bidResponses;
-    });
+    if (!utils.isEmpty(iasTargeting)) {
+      adUnits.forEach(function (adUnit) {
+        targeting[adUnit] = formatTargetingData(adUnit);
+      });
+    }
   } catch (err) {
-    logError('error', err);
+    utils.logError('error', err);
   }
+  utils.logInfo('IAS targeting', targeting);
   return targeting;
 }
 
+export function getApiCallback() {
+  return {
+    success: function (response, req) {
+      if (req.status === 200) {
+        try {
+          parseResponse(response);
+        } catch (e) {
+          utils.logError('Unable to parse IAS response.', e);
+        }
+      }
+    },
+    error: function () {
+      utils.logError('failed to retrieve IAS data');
+    }
+  }
+}
+
+function getBidRequestData(reqBidsConfigObj, callback, config, userConsent) {
+  const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
+  const { pubId } = config.params;
+  const queryString = constructQueryString(pubId, adUnits);
+  ajax(
+    `${IAS_HOST}?${queryString}`,
+    getApiCallback(),
+    undefined,
+    { method: 'GET' }
+  );
+}
+
 /** @type {RtdSubmodule} */
 export const iasSubModule = {
   name: SUBMODULE_NAME,
   init: init,
-  getBidRequestData: getBidRequestData,
-  getTargetingData: getTargetingData
+  getTargetingData: getTargetingData,
+  getBidRequestData: getBidRequestData
 };
 
 submodule(MODULE_NAME, iasSubModule);

package/modules/inskinBidAdapter.js

@@ -55,7 +55,11 @@ export const spec = {
       parallel: true
     }, validBidRequests[0].params);
 
-    if (data.publisherId) {
+    if (validBidRequests[0].schain) {
+      data.rtb = {
+        schain: validBidRequests[0].schain
+      };
+    } else if (data.publisherId) {
       data.rtb = {
         schain: {
           ext: {
@@ -63,10 +67,10 @@ export const spec = {
           }
         }
       };
-
-      delete data.publisherId;
     }
 
+    delete data.publisherId;
+
     data.keywords = data.keywords || [];
     const restrictions = [];
 

package/modules/ixBidAdapter.js

@@ -490,6 +490,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   r.ext.ixdiag.msd = 0;
   r.ext.ixdiag.msi = 0;
   r.imp = [];
+  r.at = 1;
 
   // getting ixdiags for adunits of the video, outstream & multi format (MF) style
   let ixdiag = buildIXDiag(validBidRequests);
@@ -645,7 +646,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
     }
 
     if (impressionObjects.length && BANNER in impressionObjects[0]) {
-      const { id, banner: { topframe } } = impressionObjects[0];
+      const { id, banner: { topframe }, ext } = impressionObjects[0];
       const _bannerImpression = {
         id,
         banner: {
@@ -654,6 +655,12 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
         },
       }
 
+      if (ext.dfp_ad_unit_code) {
+        _bannerImpression.ext = {
+          dfp_ad_unit_code: ext.dfp_ad_unit_code
+        }
+      }
+
       if ('bidfloor' in impressionObjects[0]) {
         _bannerImpression.bidfloor = impressionObjects[0].bidfloor;
       }