prebid.js 7.22.0 → 7.24.0

package/modules/aaxBlockmeterRtdProvider.md

@@ -0,0 +1,48 @@
+## Overview
+
+Module Name: AAX Blockmeter Realtime Data Module  
+Module Type: Rtd Provider  
+Maintainer: product@aax.media  
+
+## Description
+
+The module enables publishers to measure traffic coming from visitors using adblockers. 
+
+AAX can also help publishers monetize this traffic by allowing them to serve [acceptable ads](https://acceptableads.com/about/) to these adblock visitors and recover their lost revenue. [Reach out to us](https://www.aax.media/try-blockmeter/) to know more.
+
+## Integration
+
+Build the AAX Blockmeter Realtime Data Module into the Prebid.js package with:
+
+```
+gulp build --modules=aaxBlockmeterRtdProvider,rtdModule
+```
+
+## Configuration
+
+This module is configured as part of the `realTimeData.dataProviders` object.
+
+|    Name    |  Scope   | Description                  |     Example     |  Type  |
+|:----------:|:--------:|:-----------------------------|:---------------:|:------:|
+|    `name`    | required | Real time data module name   | `'aaxBlockmeter'` | `string` |
+|   `params`   | required |                              |                 | `Object` |
+| `params.pub` | required | AAX to share pub ID, [Reach out to us](https://www.aax.media/try-blockmeter/) to know more! |   `'AAX00000'`    | `string` |
+| `params.url`     | optional | AAX Blockmeter Script Url. Defaults to `'c.aaxads.com/aax.js?ver=1.2'` | `'c.aaxads.com/aax.js?ver=1.2'`   | `string` |
+
+### Example
+
+```javascript
+pbjs.setConfig({
+        "realTimeData": {
+             "dataProviders": [
+                {
+                    "name": "aaxBlockmeter",
+                    "params": {
+                        "pub": "AAX00000",
+                        "url": "c.aaxads.com/aax.js?ver=1.2",
+                    }
+                }
+             ]
+        }
+})
+```

package/modules/admaticBidAdapter.js

@@ -0,0 +1,147 @@
+import { getValue, logError, deepAccess, getBidIdParameter, isArray } from '../src/utils.js';
+import { loadExternalScript } from '../src/adloader.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+
+const ENDPOINT_URL = 'https://layer.serve.admatic.com.tr/pb';
+const SYNC_URL = 'https://cdn.serve.admatic.com.tr/showad/sync.js';
+const BIDDER_CODE = 'admatic';
+
+export const spec = {
+  code: 'admatic',
+  supportedMediaTypes: ['video', 'banner'],
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {BidRequest} bid The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: function(bid) {
+    let isValid = false;
+    if (typeof bid.params !== 'undefined') {
+      let isValidNetworkId = _validateId(getValue(bid.params, 'networkId'));
+      isValid = isValidNetworkId;// && isValidTypeId;
+    }
+
+    if (!isValid) {
+      logError('AdMatic networkId parameters are required. Bid aborted.');
+    }
+    return isValid;
+  },
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {validBidRequests[]} an array of bids
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function(validBidRequests, bidderRequest) {
+    const bids = validBidRequests.map(buildRequestObject);
+    const networkId = getValue(validBidRequests[0].params, 'networkId');
+    const currency = getValue(validBidRequests[0].params, 'currency') || 'TRY';
+
+    setTimeout(() => {
+      loadExternalScript(SYNC_URL, BIDDER_CODE);
+    }, bidderRequest.timeout);
+
+    const payload = {
+      'user': {
+        'ua': navigator.userAgent
+      },
+      'blacklist': [],
+      'site': {
+        'page': location.href,
+        'ref': location.origin,
+        'publisher': {
+          'name': location.hostname,
+          'publisherId': networkId
+        }
+      },
+      imp: bids,
+      ext: {
+        'cur': currency,
+        'type': 'admatic'
+      }
+    };
+
+    const payloadString = JSON.stringify(payload);
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: payloadString,
+      options: {
+        contentType: 'application/json'
+      }
+    };
+  },
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {*} serverResponse A successful response from the server.
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
+  interpretResponse: (response, request) => {
+    const body = response.body || response;
+    const bidResponses = [];
+    if (body.data.length > 0) {
+      body.data.forEach(function (bid) {
+        const resbid = {
+          requestId: bid.id,
+          cpm: bid.price,
+          width: bid.width,
+          height: bid.height,
+          currency: body.cur,
+          netRevenue: true,
+          ad: bid.party_tag,
+          creativeId: bid.creative_id,
+          meta: {
+            advertiserDomains: bid && bid.adomain ? bid.adomain : []
+          },
+          ttl: 360,
+          bidder: 'admatic',
+          timeToRespond: 1,
+          requestTimestamp: 1
+        };
+        bidResponses.push(resbid);
+      });
+    };
+    return bidResponses;
+  }
+};
+
+function buildRequestObject(bid) {
+  const reqObj = {};
+  reqObj.size = getSizes(bid);
+  reqObj.id = getBidIdParameter('bidId', bid);
+  reqObj.floor = getValue(bid.params, 'floor') || 0.01;
+  return reqObj;
+}
+
+function getSizes(bid) {
+  return concatSizes(bid);
+}
+
+function concatSizes(bid) {
+  let playerSize = deepAccess(bid, 'mediaTypes.video.playerSize');
+  let videoSizes = deepAccess(bid, 'mediaTypes.video.sizes');
+  let bannerSizes = deepAccess(bid, 'mediaTypes.banner.sizes');
+
+  if (isArray(bannerSizes) || isArray(playerSize) || isArray(videoSizes)) {
+    let mediaTypesSizes = [bannerSizes, videoSizes, playerSize];
+    return mediaTypesSizes
+      .reduce(function(acc, currSize) {
+        if (isArray(currSize)) {
+          if (isArray(currSize[0])) {
+            currSize.forEach(function (childSize) {
+              acc.push({ w: childSize[0], h: childSize[1] });
+            })
+          }
+        }
+        return acc;
+      }, []);
+  }
+}
+
+function _validateId(id) {
+  return (parseInt(id) > 0);
+}
+
+registerBidder(spec);

package/modules/admaticBidAdapter.md

@@ -0,0 +1,48 @@
+# Overview
+
+**Module Name**: Admatic Bidder Adapter  
+**Module Type**: Bidder Adapter  
+**Maintainer**: prebid@admatic.com.tr
+
+# Description
+
+Use `admatic` as bidder.
+
+`networkId` is required and must be integer.
+
+## AdUnits configuration example
+```
+    var adUnits = [{
+      code: 'your-slot_1-div', //use exactly the same code as your slot div id.
+      sizes: [[300, 250]],
+      bids: [{
+          bidder: 'admatic',
+          params: { 
+              networkId: 12345,
+              floor: 0.5
+          }
+      }]
+    },{
+      code: 'your-slot_2-div', //use exactly the same code as your slot div id.
+      sizes: [[600, 800]],
+      bids: [{
+          bidder: 'admatic',
+          params: { 
+              networkId: 12345,
+              floor: 0.5
+          }
+      }]
+    }];
+```
+
+## UserSync example
+
+```
+pbjs.setConfig({
+  userSync: {
+    iframeEnabled: true,
+    syncEnabled: true,
+    syncDelay: 1
+  }
+});
+```

package/modules/amxBidAdapter.js

@@ -207,6 +207,7 @@ const isTrue = (boolValue) =>
 
 export const spec = {
   code: BIDDER_CODE,
+  gvlid: 737,
   supportedMediaTypes: [BANNER, VIDEO],
 
   isBidRequestValid(bid) {

package/modules/appnexusBidAdapter.js

@@ -43,7 +43,7 @@ const URL = 'https://ib.adnxs.com/ut/v3/prebid';
 const URL_SIMPLE = 'https://ib.adnxs-simple.com/ut/v3/prebid';
 const VIDEO_TARGETING = ['id', 'minduration', 'maxduration',
   'skippable', 'playback_method', 'frameworks', 'context', 'skipoffset'];
-const VIDEO_RTB_TARGETING = ['minduration', 'maxduration', 'skip', 'skipafter', 'playbackmethod', 'api'];
+const VIDEO_RTB_TARGETING = ['minduration', 'maxduration', 'skip', 'skipafter', 'playbackmethod', 'api', 'startdelay'];
 const USER_PARAMS = ['age', 'externalUid', 'segments', 'gender', 'dnt', 'language'];
 const APP_DEVICE_PARAMS = ['geo', 'device_id']; // appid is collected separately
 const DEBUG_PARAMS = ['enabled', 'dongle', 'member_id', 'debug_timeout'];
@@ -920,6 +920,17 @@ function bidToTag(bid) {
               tag['video_frameworks'] = apiTmp;
             }
             break;
+
+          case 'startdelay':
+          case 'placement':
+            const contextKey = 'context';
+            if (typeof tag.video[contextKey] !== 'number') {
+              const placement = videoMediaType['placement'];
+              const startdelay = videoMediaType['startdelay'];
+              const context = getContextFromPlacement(placement) || getContextFromStartDelay(startdelay);
+              tag.video[contextKey] = VIDEO_MAPPING[contextKey][context];
+            }
+            break;
         }
       });
   }
@@ -967,6 +978,32 @@ function transformSizes(requestSizes) {
   return sizes;
 }
 
+function getContextFromPlacement(ortbPlacement) {
+  if (!ortbPlacement) {
+    return;
+  }
+
+  if (ortbPlacement === 2) {
+    return 'in-banner';
+  } else if (ortbPlacement > 2) {
+    return 'outstream';
+  }
+}
+
+function getContextFromStartDelay(ortbStartDelay) {
+  if (!ortbStartDelay) {
+    return;
+  }
+
+  if (ortbStartDelay === 0) {
+    return 'pre_roll';
+  } else if (ortbStartDelay === -1) {
+    return 'mid_roll';
+  } else if (ortbStartDelay === -2) {
+    return 'post_roll';
+  }
+}
+
 function hasUserInfo(bid) {
   return !!bid.params.user;
 }

package/modules/chtnwBidAdapter.js

@@ -0,0 +1,110 @@
+import {
+  generateUUID,
+  getDNT,
+  _each,
+} from '../src/utils.js';
+import { config } from '../src/config.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { ajax } from '../src/ajax.js';
+import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
+const ENDPOINT_URL = 'https://prebid.cht.hinet.net/api/v1';
+const BIDDER_CODE = 'chtnw';
+const COOKIE_NAME = '__htid';
+const storage = getStorageManager({bidderCode: BIDDER_CODE});
+
+const { getConfig } = config;
+
+function _isMobile() {
+  return (/(ios|ipod|ipad|iphone|android)/i).test(navigator.userAgent);
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+  isBidRequestValid: function(bid = {}) {
+    return !!(bid && bid.params);
+  },
+  buildRequests: function(validBidRequests = [], bidderRequest = {}) {
+    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
+    const chtnwId = (storage.getCookie(COOKIE_NAME) != undefined) ? storage.getCookie(COOKIE_NAME) : generateUUID();
+    if (storage.cookiesAreEnabled()) {
+      storage.setCookie(COOKIE_NAME, chtnwId);
+    }
+    const device = getConfig('device') || {};
+    device.w = device.w || window.innerWidth;
+    device.h = device.h || window.innerHeight;
+    device.ua = device.ua || navigator.userAgent;
+    device.dnt = getDNT() ? 1 : 0;
+    device.language = (navigator && navigator.language) ? navigator.language.split('-')[0] : '';
+    const bidParams = [];
+    _each(validBidRequests, function(bid) {
+      bidParams.push({
+        bidId: bid.bidId,
+        placement: bid.params.placementId,
+        sizes: bid.sizes,
+        adSlot: bid.adUnitCode
+      });
+    });
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL + '/request/prebid.json',
+      data: {
+        bids: bidParams,
+        uuid: chtnwId,
+        device: device,
+        version: {
+          prebid: '$prebid.version$',
+          adapter: '1.0.0',
+        },
+        site: {
+          numIframes: bidderRequest.refererInfo?.numIframes || 0,
+          isAmp: bidderRequest.refererInfo?.isAmp || false,
+          pageUrl: bidderRequest.refererInfo?.page || '',
+          ref: bidderRequest.refererInfo?.ref || '',
+        },
+      },
+      bids: validBidRequests
+    };
+  },
+  interpretResponse: function(serverResponse) {
+    const bidResponses = []
+    _each(serverResponse.body, function(response, i) {
+      bidResponses.push({
+        ...response
+      });
+    });
+    return bidResponses;
+  },
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {
+    const syncs = [];
+    if (syncOptions.pixelEnabled) {
+      const chtnwId = generateUUID()
+      const uuid = chtnwId
+      const type = (_isMobile()) ? 'dot' : 'pixel';
+      syncs.push({
+        type: 'image',
+        url: `https://t.ssp.hinet.net/${type}?bd=${uuid}&t=chtnw`
+      })
+    }
+    return syncs
+  },
+  onTimeout: function(timeoutData) {
+    if (timeoutData === null) {
+      return;
+    }
+    ajax(ENDPOINT_URL + '/trace/timeout/bid', null, JSON.stringify(timeoutData), {
+      method: 'POST',
+      withCredentials: false
+    });
+  },
+  onBidWon: function(bid) {
+    if (bid.nurl) {
+      ajax(bid.nurl, null);
+    }
+  },
+  onSetTargeting: function(bid) {
+  },
+}
+registerBidder(spec);

package/modules/chtnwBidAdapter.md

@@ -0,0 +1,31 @@
+# Overview
+
+```
+Module Name: CHT Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: chtdsp@cht.com.tw
+```
+
+# Description
+
+Module that connects to CHT's demand sources
+
+# Test Parameters
+```
+var adUnits = [
+   {
+        code: 'adunit-code',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]]
+            }
+        },
+        bids: [{
+            bidder: 'chtnw',
+            params: {
+                placementId: '38EL412LO82XR9O6'
+            }
+        }]
+   }
+];
+```

package/modules/concertBidAdapter.js

@@ -34,6 +34,9 @@ export const spec = {
   buildRequests: function(validBidRequests, bidderRequest) {
     logMessage(validBidRequests);
     logMessage(bidderRequest);
+
+    const eids = [];
+
     let payload = {
       meta: {
         prebidVersion: '$prebid.version$',
@@ -49,6 +52,10 @@ export const spec = {
     };
 
     payload.slots = validBidRequests.map(bidRequest => {
+      collectEid(eids, bidRequest);
+      const adUnitElement = document.getElementById(bidRequest.adUnitCode)
+      const coordinates = getOffset(adUnitElement)
+
       let slot = {
         name: bidRequest.adUnitCode,
         bidId: bidRequest.bidId,
@@ -59,12 +66,15 @@ export const spec = {
         adSlot: bidRequest.params.slot || bidRequest.adUnitCode,
         placementId: bidRequest.params.placementId || '',
         site: bidRequest.params.site || bidderRequest.refererInfo.page,
-        ref: bidderRequest.refererInfo.ref
-      };
+        ref: bidderRequest.refererInfo.ref,
+        offsetCoordinates: { x: coordinates?.left, y: coordinates?.top }
+      }
 
       return slot;
     });
 
+    payload.meta.eids = eids.filter(Boolean);
+
     logMessage(payload);
 
     return {
@@ -216,3 +226,35 @@ function consentAllowsPpid(bidderRequest) {
 
   return (uspConsent || gdprConsent);
 }
+
+function collectEid(eids, bid) {
+  if (bid.userId) {
+    const eid = getUserId(bid.userId.uid2 && bid.userId.uid2.id, 'uidapi.com', undefined, 3)
+    eids.push(eid)
+  }
+}
+
+function getUserId(id, source, uidExt, atype) {
+  if (id) {
+    const uid = { id, atype };
+
+    if (uidExt) {
+      uid.ext = uidExt;
+    }
+
+    return {
+      source,
+      uids: [ uid ]
+    };
+  }
+}
+
+function getOffset(el) {
+  if (el) {
+    const rect = el.getBoundingClientRect();
+    return {
+      left: rect.left + window.scrollX,
+      top: rect.top + window.scrollY
+    };
+  }
+}

package/modules/connectIdSystem.js

@@ -15,18 +15,7 @@ const VENDOR_ID = 25;
 const PLACEHOLDER = '__PIXEL_ID__';
 const UPS_ENDPOINT = `https://ups.analytics.yahoo.com/ups/${PLACEHOLDER}/fed`;
 const OVERRIDE_OPT_OUT_KEY = 'connectIdOptOut';
-
-function isEUConsentRequired(consentData) {
-  return !!(consentData && consentData.gdpr && consentData.gdpr.gdprApplies);
-}
-
-function userHasOptedOut() {
-  try {
-    return localStorage.getItem(OVERRIDE_OPT_OUT_KEY) === '1';
-  } catch {
-    return false;
-  }
-}
+const INPUT_PARAM_KEYS = ['pixelId', 'he', 'puid'];
 
 /** @type {Submodule} */
 export const connectIdSubmodule = {
@@ -45,7 +34,7 @@ export const connectIdSubmodule = {
    * @returns {{connectId: string} | undefined}
    */
   decode(value) {
-    if (userHasOptedOut()) {
+    if (connectIdSubmodule.userHasOptedOut()) {
       return undefined;
     }
     return (typeof value === 'object' && value.connectid)
@@ -59,27 +48,29 @@ export const connectIdSubmodule = {
    * @returns {IdResponse|undefined}
    */
   getId(config, consentData) {
-    if (userHasOptedOut()) {
+    if (connectIdSubmodule.userHasOptedOut()) {
       return;
     }
     const params = config.params || {};
-    if (!params || typeof params.he !== 'string' ||
-      (typeof params.pixelId === 'undefined' && typeof params.endpoint === 'undefined')) {
-      logError('The connectId submodule requires the \'he\' and \'pixelId\' parameters to be defined.');
+    if (!params || (typeof params.he !== 'string' && typeof params.puid !== 'string') ||
+        (typeof params.pixelId === 'undefined' && typeof params.endpoint === 'undefined')) {
+      logError('The connectId submodule requires the \'pixelId\' and at least one of the \'he\' ' +
+               'or \'puid\' parameters to be defined.');
       return;
     }
 
     const data = {
       '1p': includes([1, '1', true], params['1p']) ? '1' : '0',
-      he: params.he,
-      gdpr: isEUConsentRequired(consentData) ? '1' : '0',
-      gdpr_consent: isEUConsentRequired(consentData) ? consentData.gdpr.consentString : '',
+      gdpr: connectIdSubmodule.isEUConsentRequired(consentData) ? '1' : '0',
+      gdpr_consent: connectIdSubmodule.isEUConsentRequired(consentData) ? consentData.gdpr.consentString : '',
       us_privacy: consentData && consentData.uspConsent ? consentData.uspConsent : ''
     };
 
-    if (params.pixelId) {
-      data.pixelId = params.pixelId
-    }
+    INPUT_PARAM_KEYS.forEach(key => {
+      if (typeof params[key] != 'undefined') {
+        data[key] = params[key];
+      }
+    });
 
     const resp = function (callback) {
       const callbacks = {
@@ -106,6 +97,28 @@ export const connectIdSubmodule = {
     return {callback: resp};
   },
 
+  /**
+   * Utility function that returns a boolean flag indicating if the opporunity
+   * is subject to GDPR
+   * @returns {Boolean}
+   */
+  isEUConsentRequired(consentData) {
+    return !!(consentData && consentData.gdpr && consentData.gdpr.gdprApplies);
+  },
+
+  /**
+   * Utility function that returns a boolean flag indicating if the user
+   * has opeted out via the Yahoo easy-opt-out mechanism.
+   * @returns {Boolean}
+   */
+  userHasOptedOut() {
+    try {
+      return localStorage.getItem(OVERRIDE_OPT_OUT_KEY) === '1';
+    } catch {
+      return false;
+    }
+  },
+
   /**
    * Return the function used to perform XHR calls.
    * Utilised for each of testing.

package/modules/connectIdSystem.md

@@ -29,5 +29,6 @@ The below parameters apply only to the Yahoo ConnectID user ID Module.
 | --- | --- | --- | --- | --- |
 | name | Required | String | ID value for the Yahoo ConnectID module - `"connectId"` | `"connectId"` |
 | params | Required | Object | Data for Yahoo ConnectID initialization. | |
-| params.pixelId | Required | Number | The Yahoo supplied publisher specific pixel Id  | `8976` |
-| params.he | Required | String | The SHA-256 hashed user email address | `"529cb86de31e9547a712d9f380146e98bbd39beec"` |
+| params.pixelId | Required | Number | The Yahoo supplied publisher specific pixel Id.  | `8976` |
+| params.he | Optional | String | The SHA-256 hashed user email address. One of either the `he` parameter or the `puid` parameter must be supplied. | `"529cb86de31e9547a712d9f380146e98bbd39beec"` |
+| params.puid | Optional | String | The publisher-supplied user identifier. One of either the `he` parameter or the `puid` parameter must be supplied. | `"P-975484817"` |

package/modules/consentManagement.js

@@ -4,11 +4,12 @@
  * and make it available for any GDPR supported adapters to read/pass this information to
  * their system.
  */
-import {isNumber, isPlainObject, isStr, logError, logInfo, logWarn} from '../src/utils.js';
+import {deepSetValue, isNumber, isPlainObject, isStr, logError, logInfo, logWarn} from '../src/utils.js';
 import {config} from '../src/config.js';
 import {gdprDataHandler} from '../src/adapterManager.js';
 import {includes} from '../src/polyfill.js';
 import {timedAuctionHook} from '../src/utils/perfMetrics.js';
+import {registerOrtbProcessor, REQUEST} from '../src/pbjsORTB.js';
 
 const DEFAULT_CMP = 'iab';
 const DEFAULT_CONSENT_TIMEOUT = 10000;
@@ -354,3 +355,23 @@ export function setConsentConfig(config) {
   loadConsentData(); // immediately look up consent data to make it available without requiring an auction
 }
 config.getConfig('consentManagement', config => setConsentConfig(config.consentManagement));
+
+export function setOrtbGdpr(ortbRequest, bidderRequest) {
+  const consent = bidderRequest.gdprConsent;
+  if (consent) {
+    if (typeof consent.gdprApplies === 'boolean') {
+      deepSetValue(ortbRequest, 'regs.ext.gdpr', consent.gdprApplies ? 1 : 0);
+    }
+    deepSetValue(ortbRequest, 'user.ext.consent', consent.consentString);
+  }
+}
+
+export function setOrtbAdditionalConsent(ortbRequest, bidderRequest) {
+  const addtl = bidderRequest.gdprConsent?.addtlConsent;
+  if (addtl && typeof addtl === 'string') {
+    deepSetValue(ortbRequest, 'user.ext.ConsentedProvidersSettings.consented_providers', addtl);
+  }
+}
+
+registerOrtbProcessor({type: REQUEST, name: 'gdpr', fn: setOrtbGdpr});
+registerOrtbProcessor({type: REQUEST, name: 'gdprAddtlConsent', fn: setOrtbAdditionalConsent})