prebid.js 6.1.0 → 6.5.0

package/modules/ipromBidAdapter.js

@@ -0,0 +1,79 @@
+import { logError } from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+
+const BIDDER_CODE = 'iprom';
+const ENDPOINT_URL = 'https://core.iprom.net/programmatic';
+const VERSION = 'v1.0.2';
+const DEFAULT_CURRENCY = 'EUR';
+const DEFAULT_NETREVENUE = true;
+const DEFAULT_TTL = 360;
+
+export const spec = {
+  code: BIDDER_CODE,
+  isBidRequestValid: function ({ bidder, params = {} } = {}) {
+    // id parameter checks
+    if (!params.id) {
+      logError(`${bidder}: Parameter 'id' missing`);
+      return false;
+    } else if (typeof params.id !== 'string') {
+      logError(`${bidder}: Parameter 'id' needs to be a string`);
+      return false;
+    }
+    // dimension parameter checks
+    if (!params.dimension) {
+      logError(`${bidder}: Required parameter 'dimension' missing`);
+      return false;
+    } else if (typeof params.dimension !== 'string') {
+      logError(`${bidder}: Parameter 'dimension' needs to be a string`);
+      return false;
+    }
+
+    return true;
+  },
+
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const payload = {
+      bids: validBidRequests,
+      referer: bidderRequest.refererInfo,
+      version: VERSION
+    };
+    const payloadString = JSON.stringify(payload);
+
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: payloadString
+    };
+  },
+
+  interpretResponse: function (serverResponse, request) {
+    let bids = serverResponse.body;
+
+    const bidResponses = [];
+
+    bids.forEach(bid => {
+      const b = {
+        ad: bid.ad,
+        requestId: bid.requestId,
+        cpm: bid.cpm,
+        width: bid.width,
+        height: bid.height,
+        creativeId: bid.creativeId,
+        currency: bid.currency || DEFAULT_CURRENCY,
+        netRevenue: bid.netRevenue || DEFAULT_NETREVENUE,
+        ttl: bid.ttl || DEFAULT_TTL,
+        meta: {},
+      };
+
+      if (bid.aDomains && bid.aDomains.length) {
+        b.meta.advertiserDomains = bid.aDomains;
+      }
+
+      bidResponses.push(b);
+    });
+
+    return bidResponses;
+  },
+}
+
+registerBidder(spec);

package/modules/ixBidAdapter.js

@@ -1,8 +1,8 @@
-import { deepAccess, parseGPTSingleSizeArray, inIframe, deepClone, logError, logWarn, isFn, contains, isInteger, isArray, deepSetValue, parseQueryStringParameters, isEmpty, mergeDeep, convertTypes } from '../src/utils.js';
+import { deepAccess, parseGPTSingleSizeArray, inIframe, deepClone, logError, logWarn, isFn, contains, isInteger, isArray, deepSetValue, parseQueryStringParameters, isEmpty, mergeDeep, convertTypes, hasDeviceAccess } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
-import { EVENTS } from '../src/constants.json';
-import { getStorageManager } from '../src/storageManager.js';
+import CONSTANTS from '../src/constants.json';
+import { getStorageManager, validateStorageEnforcement } from '../src/storageManager.js';
 import events from '../src/events.js';
 import find from 'core-js-pure/features/array/find.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
@@ -53,7 +53,12 @@ const SOURCE_RTI_MAPPING = {
   'neustar.biz': 'fabrickId',
   'zeotap.com': 'zeotapIdPlus',
   'uidapi.com': 'UID2',
-  'adserver.org': 'TDID'
+  'adserver.org': 'TDID',
+  'id5-sync.com': '', // ID5 Universal ID, configured as id5Id
+  'crwdcntrl.net': '', // Lotame Panorama ID, lotamePanoramaId
+  'epsilon.com': '', // Publisher Link, publinkId
+  'audigent.com': '', // Halo ID from Audigent, haloId
+  'pubcid.org': '' // SharedID, pubcid
 };
 const PROVIDERS = [
   'britepoolid',
@@ -69,7 +74,8 @@ const PROVIDERS = [
   'quantcastId',
   'pubcid',
   'TDID',
-  'flocId'
+  'flocId',
+  'pubProvidedId'
 ];
 const REQUIRED_VIDEO_PARAMS = ['mimes', 'minduration', 'maxduration']; // note: protocol/protocols is also reqd
 const VIDEO_PARAMS_ALLOW_LIST = [
@@ -194,7 +200,7 @@ function bidToImp(bid) {
   imp.id = bid.bidId;
 
   imp.ext = {};
-  imp.ext.siteID = bid.params.siteId;
+  imp.ext.siteID = bid.params.siteId.toString();
 
   if (bid.params.hasOwnProperty('id') &&
     (typeof bid.params.id === 'string' || typeof bid.params.id === 'number')) {
@@ -444,16 +450,19 @@ function getEidInfo(allEids, flocData) {
   let seenSources = {};
   if (isArray(allEids)) {
     for (const eid of allEids) {
-      if (SOURCE_RTI_MAPPING[eid.source] && deepAccess(eid, 'uids.0')) {
+      if (SOURCE_RTI_MAPPING.hasOwnProperty(eid.source) && deepAccess(eid, 'uids.0')) {
         seenSources[eid.source] = true;
-        eid.uids[0].ext = {
-          rtiPartner: SOURCE_RTI_MAPPING[eid.source]
-        };
+        if (SOURCE_RTI_MAPPING[eid.source] != '') {
+          eid.uids[0].ext = {
+            rtiPartner: SOURCE_RTI_MAPPING[eid.source]
+          };
+        }
         delete eid.uids[0].atype;
         toSend.push(eid);
       }
     }
   }
+
   const isValidFlocId = flocData && flocData.id && flocData.version;
   if (isValidFlocId) {
     const flocEid = {
@@ -466,6 +475,7 @@ function getEidInfo(allEids, flocData) {
 
   return { toSend, seenSources };
 }
+
 /**
  * Builds a request object to be sent to the ad server based on bid requests.
  *
@@ -680,6 +690,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
 
     if (impressionObjects.length && BANNER in impressionObjects[0]) {
       const { id, banner: { topframe }, ext } = impressionObjects[0];
+      const gpid = impressions[transactionIds[adUnitIndex]].gpid;
       const _bannerImpression = {
         id,
         banner: {
@@ -688,10 +699,10 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
         },
       }
 
-      if (ext.dfp_ad_unit_code) {
-        _bannerImpression.ext = {
-          dfp_ad_unit_code: ext.dfp_ad_unit_code
-        }
+      if (ext.dfp_ad_unit_code || gpid) {
+        _bannerImpression.ext = {};
+        _bannerImpression.ext.dfp_ad_unit_code = ext.dfp_ad_unit_code;
+        _bannerImpression.ext.gpid = gpid;
       }
 
       if ('bidfloor' in impressionObjects[0]) {
@@ -911,6 +922,7 @@ function createBannerImps(validBidRequest, missingBannerSizes, bannerImps) {
       bannerImps[validBidRequest.transactionId].ixImps = []
     }
     bannerImps[validBidRequest.transactionId].ixImps.push(imp);
+    bannerImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
   }
 
   if (ixConfig.hasOwnProperty('detectMissingSizes') && ixConfig.detectMissingSizes) {
@@ -991,7 +1003,7 @@ function createMissingBannerImp(bid, imp, newSize) {
  *
  * @param {ErrorData} data
  */
-function errorEventHandler(data) {
+function storeErrorEventData(data) {
   if (!storage.localStorageIsEnabled()) {
     return;
   }
@@ -1033,6 +1045,24 @@ function errorEventHandler(data) {
   storage.setDataInLocalStorage(LOCAL_STORAGE_KEY, JSON.stringify(currentStorage));
 }
 
+/**
+ * Event handler for storing data into local storage. It will only store data if
+ * local storage premissions are avaliable
+ */
+function localStorageHandler(data) {
+  if (data.type === 'ERROR' && data.arguments && data.arguments[1] && data.arguments[1].bidder === BIDDER_CODE) {
+    const DEFAULT_ENFORCEMENT_SETTINGS = {
+      hasEnforcementHook: false,
+      valid: hasDeviceAccess()
+    };
+    validateStorageEnforcement(GLOBAL_VENDOR_ID, BIDDER_CODE, DEFAULT_ENFORCEMENT_SETTINGS, (permissions) => {
+      if (permissions.valid) {
+        storeErrorEventData(data);
+      }
+    });
+  }
+}
+
 /**
  * Get ixdiag stored in LocalStorage and format to be added to request payload
  *
@@ -1129,8 +1159,8 @@ export const spec = {
    */
   isBidRequestValid: function (bid) {
     if (!hasRegisteredHandler) {
-      events.on(EVENTS.AUCTION_DEBUG, errorEventHandler);
-      events.on(EVENTS.AD_RENDER_FAILED, errorEventHandler);
+      events.on(CONSTANTS.EVENTS.AUCTION_DEBUG, localStorageHandler);
+      events.on(CONSTANTS.EVENTS.AD_RENDER_FAILED, localStorageHandler);
       hasRegisteredHandler = true;
     }
 
@@ -1168,7 +1198,12 @@ export const spec = {
     }
 
     if (typeof bid.params.siteId !== 'string' && typeof bid.params.siteId !== 'number') {
-      logError('IX Bid Adapter: siteId must be string or number value.', { bidder: BIDDER_CODE, code: ERROR_CODES.SITE_ID_INVALID_VALUE });
+      logError('IX Bid Adapter: siteId must be string or number type.', { bidder: BIDDER_CODE, code: ERROR_CODES.SITE_ID_INVALID_VALUE });
+      return false;
+    }
+
+    if (typeof bid.params.siteId !== 'string' && isNaN(Number(bid.params.siteId))) {
+      logError('IX Bid Adapter: siteId must valid value', { bidder: BIDDER_CODE, code: ERROR_CODES.SITE_ID_INVALID_VALUE });
       return false;
     }
 

package/modules/kinessoIdSystem.js

@@ -180,7 +180,7 @@ function kinessoSyncUrl(accountId, consentData) {
   const usPrivacyString = uspDataHandler.getConsentData();
   let kinessoSyncUrl = `${ID_SVC}?accountid=${accountId}`;
   if (usPrivacyString) {
-    kinessoSyncUrl = `${kinessoSyncUrl}?us_privacy=${usPrivacyString}`;
+    kinessoSyncUrl = `${kinessoSyncUrl}&us_privacy=${usPrivacyString}`;
   }
   if (!consentData || typeof consentData.gdprApplies !== 'boolean' || !consentData.gdprApplies) return kinessoSyncUrl;
 

package/modules/limelightDigitalBidAdapter.js

@@ -158,7 +158,9 @@ function buildPlacement(bidRequest) {
           height: size[1]
         }
       }),
-      type: bidRequest.params.adUnitType.toUpperCase()
+      type: bidRequest.params.adUnitType.toUpperCase(),
+      publisherId: bidRequest.params.publisherId,
+      userIdAsEids: bidRequest.userIdAsEids
     }
   }
 }

package/modules/livewrappedAnalyticsAdapter.js

@@ -114,6 +114,7 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
         let wonBid = cache.auctions[args.auctionId].bids[args.requestId];
         wonBid.won = true;
         wonBid.floorData = args.floorData;
+        wonBid.rUp = args.rUp;
         if (wonBid.sendStatus != 0) {
           livewrappedAnalyticsAdapter.sendEvents();
         }
@@ -288,7 +289,8 @@ function getWins(gdpr, auctionIds) {
           auctionId: auctionIdPos,
           auc: bid.auc,
           buc: bid.buc,
-          lw: bid.lw
+          lw: bid.lw,
+          rUp: bid.rUp
         });
       }
     });

package/modules/livewrappedBidAdapter.js

@@ -1,4 +1,4 @@
-import { isSafariBrowser, deepAccess, getWindowTop } from '../src/utils.js';
+import { isSafariBrowser, deepAccess, getWindowTop, mergeDeep } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import find from 'core-js-pure/features/array/find.js';
@@ -60,11 +60,17 @@ export const spec = {
     const bundle = find(bidRequests, hasBundleParam);
     const tid = find(bidRequests, hasTidParam);
     const schain = bidRequests[0].schain;
+    let ortb2 = config.getConfig('ortb2');
+    const eids = handleEids(bidRequests);
     bidUrl = bidUrl ? bidUrl.params.bidUrl : URL;
     url = url ? url.params.url : (getAppDomain() || getTopWindowLocation(bidderRequest));
     test = test ? test.params.test : undefined;
     var adRequests = bidRequests.map(bidToAdRequest);
 
+    if (eids) {
+      ortb2 = mergeDeep(ortb2 || {}, eids);
+    }
+
     const payload = {
       auctionId: auctionId ? auctionId.auctionId : undefined,
       publisherId: publisherId ? publisherId.params.publisherId : undefined,
@@ -86,7 +92,7 @@ export const spec = {
       cookieSupport: !isSafariBrowser() && storage.cookiesAreEnabled(),
       rcv: getAdblockerRecovered(),
       adRequests: [...adRequests],
-      rtbData: handleEids(bidRequests),
+      rtbData: ortb2,
       schain: schain
     };
 

package/modules/loglyliftBidAdapter.js

@@ -0,0 +1,79 @@
+import { config } from '../src/config.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { NATIVE } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'loglylift';
+const ENDPOINT_URL = 'https://bid.logly.co.jp/prebid/client/v1';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [NATIVE],
+
+  isBidRequestValid: function (bid) {
+    return !!(bid.params && bid.params.adspotId);
+  },
+
+  buildRequests: function (bidRequests, bidderRequest) {
+    const requests = [];
+    for (let i = 0, len = bidRequests.length; i < len; i++) {
+      const request = {
+        method: 'POST',
+        url: ENDPOINT_URL + '?adspot_id=' + bidRequests[i].params.adspotId,
+        data: JSON.stringify(newBidRequest(bidRequests[i], bidderRequest)),
+        options: {},
+        bidderRequest
+      };
+      requests.push(request);
+    }
+    return requests;
+  },
+
+  interpretResponse: function (serverResponse, { bidderRequest }) {
+    serverResponse = serverResponse.body;
+    const bidResponses = [];
+    if (!serverResponse || serverResponse.error) {
+      return bidResponses;
+    }
+    serverResponse.bids.forEach(function (bid) {
+      bidResponses.push(bid);
+    })
+    return bidResponses;
+  },
+
+  getUserSyncs: function (syncOptions, serverResponses) {
+    const syncs = [];
+
+    if (syncOptions.iframeEnabled && serverResponses.length > 0) {
+      syncs.push({
+        type: 'iframe',
+        url: 'https://sync.logly.co.jp/sync/sync.html'
+      });
+    }
+    return syncs;
+  }
+
+};
+
+function newBidRequest(bid, bidderRequest) {
+  const currencyObj = config.getConfig('currency');
+  const currency = (currencyObj && currencyObj.adServerCurrency) || 'USD';
+
+  return {
+    auctionId: bid.auctionId,
+    bidderRequestId: bid.bidderRequestId,
+    transactionId: bid.transactionId,
+    adUnitCode: bid.adUnitCode,
+    bidId: bid.bidId,
+    mediaTypes: bid.mediaTypes,
+    params: bid.params,
+    prebidJsVersion: '$prebid.version$',
+    url: window.location.href,
+    domain: config.getConfig('publisherDomain'),
+    referer: bidderRequest.refererInfo.referer,
+    auctionStartTime: bidderRequest.auctionStart,
+    currency: currency,
+    timeout: config.getConfig('bidderTimeout')
+  };
+}
+
+registerBidder(spec);

package/modules/loglyliftBidAdapter.md

@@ -0,0 +1,55 @@
+# Overview
+```
+Module Name: LOGLY lift for Publisher
+Module Type: Bidder Adapter
+Maintainer: dev@logly.co.jp
+```
+
+# Description
+Module that connects to Logly's demand sources.
+Currently module supports only native mediaType.
+
+# Test Parameters
+```
+var adUnits = [
+  // Native adUnit
+  {
+    code: 'test-native-code',
+    sizes: [[1, 1]],
+    mediaTypes: {
+      native: {
+        title: {
+          required: true
+        },
+        image: {
+          required: true
+        },
+        sponsoredBy: {
+          required: true
+        }
+      }
+    },
+    bids: [{
+      bidder: 'loglylift',
+      params: {
+        adspotId: 4302078
+      }
+    }]
+  }
+];
+```
+
+# UserSync example
+
+```
+pbjs.setConfig({
+  userSync: {
+    filterSettings: {
+      iframe: {
+        bidders: '*', // '*' represents all bidders
+        filter: 'include'
+      }
+    }
+  }
+});
+```

package/modules/lotamePanoramaIdSystem.js

@@ -4,10 +4,20 @@
  * @module modules/lotamePanoramaId
  * @requires module:modules/userId
  */
-import { timestamp, isStr, logError, isBoolean, buildUrl, isEmpty, isArray } from '../src/utils.js';
+import {
+  timestamp,
+  isStr,
+  logError,
+  isBoolean,
+  buildUrl,
+  isEmpty,
+  isArray,
+  isEmptyStr
+} from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { submodule } from '../src/hook.js';
 import { getStorageManager } from '../src/storageManager.js';
+import { uspDataHandler } from '../src/adapterManager.js';
 
 const KEY_ID = 'panoramaId';
 const KEY_EXPIRY = `${KEY_ID}_expiry`;
@@ -115,14 +125,23 @@ function saveLotameCache(
 
 /**
  * Retrieve all the cached values from cookies and/or local storage
+ * @param {Number} clientId
  */
-function getLotameLocalCache() {
+function getLotameLocalCache(clientId = undefined) {
   let cache = {
     data: getFromStorage(KEY_ID),
     expiryTimestampMs: 0,
+    clientExpiryTimestampMs: 0,
   };
 
   try {
+    if (clientId) {
+      const rawClientExpiry = getFromStorage(`${KEY_EXPIRY}_${clientId}`);
+      if (isStr(rawClientExpiry)) {
+        cache.clientExpiryTimestampMs = parseInt(rawClientExpiry, 10);
+      }
+    }
+
     const rawExpiry = getFromStorage(KEY_EXPIRY);
     if (isStr(rawExpiry)) {
       cache.expiryTimestampMs = parseInt(rawExpiry, 10);
@@ -191,11 +210,25 @@ export const lotamePanoramaIdSubmodule = {
    */
   getId(config, consentData, cacheIdObj) {
     cookieDomain = lotamePanoramaIdSubmodule.findRootDomain();
-    let localCache = getLotameLocalCache();
+    const configParams = (config && config.params) || {};
+    const clientId = configParams.clientId;
+    const hasCustomClientId = !isEmpty(clientId);
+    const localCache = getLotameLocalCache(clientId);
 
-    let refreshNeeded = Date.now() > localCache.expiryTimestampMs;
+    const hasExpiredPanoId = Date.now() > localCache.expiryTimestampMs;
+
+    if (hasCustomClientId) {
+      const hasFreshClientNoConsent = Date.now() < localCache.clientExpiryTimestampMs;
+      if (hasFreshClientNoConsent) {
+        // There is no consent
+        return {
+          id: undefined,
+          reason: 'NO_CLIENT_CONSENT',
+        };
+      }
+    }
 
-    if (!refreshNeeded) {
+    if (!hasExpiredPanoId) {
       return {
         id: localCache.data,
       };
@@ -203,6 +236,18 @@ export const lotamePanoramaIdSubmodule = {
 
     const storedUserId = getProfileId();
 
+    // Add CCPA Consent data handling
+    const usp = uspDataHandler.getConsentData();
+
+    let usPrivacy;
+    if (typeof usp !== 'undefined' && !isEmpty(usp) && !isEmptyStr(usp)) {
+      usPrivacy = usp;
+    }
+    if (!usPrivacy) {
+      // fallback to 1st party cookie
+      usPrivacy = getFromStorage('us_privacy');
+    }
+
     const resolveIdFunction = function (callback) {
       let queryParams = {};
       if (storedUserId) {
@@ -226,6 +271,17 @@ export const lotamePanoramaIdSubmodule = {
       if (consentString) {
         queryParams.gdpr_consent = consentString;
       }
+
+      // Add usPrivacy to the url
+      if (usPrivacy) {
+        queryParams.us_privacy = usPrivacy;
+      }
+
+      // Add clientId to the url
+      if (hasCustomClientId) {
+        queryParams.c = clientId;
+      }
+
       const url = buildUrl({
         protocol: 'https',
         host: `id.crwdcntrl.net`,
@@ -239,15 +295,31 @@ export const lotamePanoramaIdSubmodule = {
           if (response) {
             try {
               let responseObj = JSON.parse(response);
-              const shouldUpdateProfileId = !(
+              const hasNoConsentErrors = !(
                 isArray(responseObj.errors) &&
                 responseObj.errors.indexOf(MISSING_CORE_CONSENT) !== -1
               );
 
+              if (hasCustomClientId) {
+                if (hasNoConsentErrors) {
+                  clearLotameCache(`${KEY_EXPIRY}_${clientId}`);
+                } else if (isStr(responseObj.no_consent) && responseObj.no_consent === 'CLIENT') {
+                  saveLotameCache(
+                    `${KEY_EXPIRY}_${clientId}`,
+                    responseObj.expiry_ts,
+                    responseObj.expiry_ts
+                  );
+
+                  // End Processing
+                  callback();
+                  return;
+                }
+              }
+
               saveLotameCache(KEY_EXPIRY, responseObj.expiry_ts, responseObj.expiry_ts);
 
               if (isStr(responseObj.profile_id)) {
-                if (shouldUpdateProfileId) {
+                if (hasNoConsentErrors) {
                   setProfileId(responseObj.profile_id);
                 }
 
@@ -262,7 +334,7 @@ export const lotamePanoramaIdSubmodule = {
                   clearLotameCache(KEY_ID);
                 }
               } else {
-                if (shouldUpdateProfileId) {
+                if (hasNoConsentErrors) {
                   clearLotameCache(KEY_PROFILE);
                 }
                 clearLotameCache(KEY_ID);