prebid.js 7.3.0 → 7.6.0

package/modules/rasBidAdapter.md

@@ -0,0 +1,50 @@
+# Overview
+
+```
+Module Name: Ringier Axel Springer Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: support@ringpublishing.com
+```
+
+# Description
+
+Module that connects to Ringer Axel Springer demand sources.
+Only banner format is supported.
+
+# Test Parameters
+```js
+var adUnits = [{
+  code: 'test-div-ad',
+  mediaTypes: {
+    banner: {
+      sizes: [[300, 250], [300, 600]]
+    }
+  },
+  bids: [{
+    bidder: 'ras',
+    params: {
+      network: '4178463',
+      site: 'test',
+      area: 'areatest',
+      slot: 'slot'
+    }
+  }]
+}];
+```
+
+# Parameters
+
+| Name | Scope | Type | Description | Example
+| --- | --- | --- | --- | ---
+| network | required | String | Specific identifier provided by RAS | `"4178463"`
+| site | required | String | Specific identifier name (case-insensitive) that is associated with this ad unit and provided by RAS | `"example_com"`
+| area | required | String | Ad unit category name; only case-insensitive alphanumeric with underscores and hyphens are allowed | `"sport"`
+| slot | required | String | Ad unit placement name (case-insensitive) provided by RAS | `"slot"`
+| pageContext | optional | Object | Web page context data | `{}`
+| pageContext.dr | optional | String | Document referrer URL address | `"https://example.com/"`
+| pageContext.du | optional | String | Document URL address | `"https://example.com/sport/football/article.html?id=932016a5-02fc-4d5c-b643-fafc2f270f06"`
+| pageContext.dv | optional | String | Document virtual address as slash-separated path that may consist of any number of parts (case-insensitive alphanumeric with underscores and hyphens); first part should be the same as `site` value and second as `area` value; next parts may reflect website navigation | `"example_com/sport/football"`
+| pageContext.keyWords | optional | String[] | List of keywords associated with this ad unit; only case-insensitive alphanumeric with underscores and hyphens are allowed | `["euro", "lewandowski"]`
+| pageContext.keyValues | optional | Object | Key-values associated with this ad unit (case-insensitive); following characters are not allowed in the values: `" ' = ! + # * ~ ; ^ ( ) < > [ ] & @` | `{}`
+| pageContext.keyValues.ci | optional | String | Content unique identifier | `"932016a5-02fc-4d5c-b643-fafc2f270f06"`
+| pageContext.keyValues.adunit | optional | String | Ad unit name | `"example_com/sport"`

package/modules/readpeakBidAdapter.js

@@ -1,7 +1,7 @@
-import {logError, replaceAuctionPrice} from '../src/utils.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {config} from '../src/config.js';
-import {BANNER, NATIVE} from '../src/mediaTypes.js';
+import { logError, replaceAuctionPrice, triggerPixel, isStr } from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { config } from '../src/config.js';
+import { NATIVE, BANNER } from '../src/mediaTypes.js';
 
 export const ENDPOINT = 'https://app.readpeak.com/header/prebid';
 
@@ -64,8 +64,16 @@ export const spec = {
     };
   },
 
-  interpretResponse: (response, request) =>
-    bidResponseAvailable(request, response)
+  interpretResponse: (response, request) => {
+    return bidResponseAvailable(request, response)
+  },
+
+  onBidWon: (bid) => {
+    if (bid.burl && isStr(bid.burl)) {
+      bid.burl = replaceAuctionPrice(bid.burl, bid.cpm);
+      triggerPixel(bid.burl);
+    }
+  },
 };
 
 function bidResponseAvailable(bidRequest, bidResponse) {
@@ -103,6 +111,7 @@ function bidResponseAvailable(bidRequest, bidResponse) {
         bid.ad = idToBidMap[id].adm
         bid.width = idToBidMap[id].w
         bid.height = idToBidMap[id].h
+        bid.burl = idToBidMap[id].burl
       }
       if (idToBidMap[id].adomain) {
         bid.meta = {

package/modules/relaidoBidAdapter.js

@@ -1,4 +1,4 @@
-import { deepAccess, logWarn, getBidIdParameter, parseQueryStringParameters, triggerPixel, generateUUID, isArray } from '../src/utils.js';
+import { deepAccess, logWarn, getBidIdParameter, parseQueryStringParameters, triggerPixel, generateUUID, isArray, isNumber } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { Renderer } from '../src/Renderer.js';
@@ -6,7 +6,7 @@ import { getStorageManager } from '../src/storageManager.js';
 
 const BIDDER_CODE = 'relaido';
 const BIDDER_DOMAIN = 'api.relaido.jp';
-const ADAPTER_VERSION = '1.0.7';
+const ADAPTER_VERSION = '1.0.8';
 const DEFAULT_TTL = 300;
 const UUID_KEY = 'relaido_uuid';
 
@@ -44,7 +44,10 @@ function buildRequests(validBidRequests, bidderRequest) {
     let height = 0;
 
     if (hasVideoMediaType(bidRequest) && isVideoValid(bidRequest)) {
-      const playerSize = getValidSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'));
+      let playerSize = getValidSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'));
+      if (playerSize.length === 0) {
+        playerSize = getValidSizes(deepAccess(bidRequest, 'params.video.playerSize'));
+      }
       width = playerSize[0][0];
       height = playerSize[0][1];
       mediaType = VIDEO;
@@ -253,7 +256,10 @@ function isBannerValid(bid) {
 }
 
 function isVideoValid(bid) {
-  const playerSize = getValidSizes(deepAccess(bid, 'mediaTypes.video.playerSize'));
+  let playerSize = getValidSizes(deepAccess(bid, 'mediaTypes.video.playerSize'));
+  if (playerSize.length === 0) {
+    playerSize = getValidSizes(deepAccess(bid, 'params.video.playerSize'));
+  }
   if (playerSize.length > 0) {
     const context = deepAccess(bid, 'mediaTypes.video.context');
     if (context && context === 'outstream') {
@@ -300,6 +306,15 @@ function getValidSizes(sizes) {
         if ((width >= 300 && height >= 250)) {
           result.push([width, height]);
         }
+      } else if (isNumber(sizes[i])) {
+        const width = sizes[0];
+        const height = sizes[1];
+        if (width == 1 && height == 1) {
+          return [[1, 1]];
+        }
+        if ((width >= 300 && height >= 250)) {
+          return [[width, height]];
+        }
       }
     }
   }

package/modules/seedtagBidAdapter.js

@@ -147,6 +147,36 @@ function buildBidResponse(seedtagBid) {
   return bid;
 }
 
+/**
+ *
+ * @returns Measure time to first byte implementation
+ * @see https://web.dev/ttfb/
+ *      https://developer.mozilla.org/en-US/docs/Web/API/Navigation_timing_API
+ */
+function ttfb() {
+  const ttfb = (() => {
+    // Timing API V2
+    try {
+      const entry = performance.getEntriesByType('navigation')[0];
+      return Math.round(entry.responseStart - entry.startTime);
+    } catch (e) {
+      // Timing API V1
+      try {
+        const entry = performance.timing;
+        return Math.round(entry.responseStart - entry.fetchStart);
+      } catch (e) {
+        // Timing API not available
+        return 0;
+      }
+    }
+  })();
+
+  // prevent negative or excessive value
+  // @see https://github.com/googleChrome/web-vitals/issues/162
+  //      https://github.com/googleChrome/web-vitals/issues/137
+  return ttfb >= 0 && ttfb <= performance.now() ? ttfb : 0;
+}
+
 export function getTimeoutUrl (data) {
   let queryParams = '';
   if (
@@ -195,7 +225,9 @@ export const spec = {
       timeout: bidderRequest.timeout,
       version: '$prebid.version$',
       connectionType: getConnectionType(),
-      bidRequests: _map(validBidRequests, buildBidRequest)
+      auctionStart: bidderRequest.auctionStart || Date.now(),
+      ttfb: ttfb(),
+      bidRequests: _map(validBidRequests, buildBidRequest),
     };
 
     if (payload.cmp) {
@@ -204,6 +236,10 @@ export const spec = {
       payload['cd'] = bidderRequest.gdprConsent.consentString;
     }
 
+    if (bidderRequest.uspConsent) {
+      payload['uspConsent'] = bidderRequest.uspConsent
+    }
+
     const payloadString = JSON.stringify(payload)
     return {
       method: 'POST',

package/modules/sharedIdSystem.js

@@ -5,13 +5,13 @@
  * @requires module:modules/userId
  */
 
-import {buildUrl, generateUUID, hasDeviceAccess, logInfo, parseUrl, triggerPixel} from '../src/utils.js';
+import { parseUrl, buildUrl, triggerPixel, logInfo, hasDeviceAccess, generateUUID } from '../src/utils.js';
 import {submodule} from '../src/hook.js';
-import {coppaDataHandler} from '../src/adapterManager.js';
+import { coppaDataHandler } from '../src/adapterManager.js';
 import {getStorageManager} from '../src/storageManager.js';
 
-const MODULE_TYPE = 'fpid-module';
-export const storage = getStorageManager({moduleName: 'pubCommonId', moduleType: MODULE_TYPE});
+const GVLID = 887;
+export const storage = getStorageManager({gvlid: GVLID, moduleName: 'pubCommonId'});
 const COOKIE = 'cookie';
 const LOCAL_STORAGE = 'html5';
 const OPTOUT_NAME = '_pubcid_optout';
@@ -74,6 +74,11 @@ export const sharedIdSystemSubmodule = {
    */
   name: 'sharedId',
   aliasName: 'pubCommonId',
+  /**
+   * Vendor id of prebid
+   * @type {Number}
+   */
+  gvlid: GVLID,
 
   /**
    * decode the stored id value for passing to bid requests
@@ -88,7 +93,8 @@ export const sharedIdSystemSubmodule = {
       return undefined;
     }
     logInfo(' Decoded value PubCommonId ' + value);
-    return {'pubcid': value};
+    const idObj = {'pubcid': value};
+    return idObj;
   },
   /**
    * performs action to obtain id

package/modules/sharethroughBidAdapter.js

@@ -4,7 +4,7 @@ import { config } from '../src/config.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { createEidsArray } from './userId/eids.js';
 
-const VERSION = '4.1.0';
+const VERSION = '4.1.1';
 const BIDDER_CODE = 'sharethrough';
 const SUPPLY_ID = 'WYu2BXv1';
 
@@ -34,9 +34,8 @@ export const sharethroughAdapterSpec = {
       cur: ['USD'],
       tmax: timeout,
       site: {
-        // TODO: do the fallbacks make sense here?
-        domain: deepAccess(bidderRequest, 'refererInfo.domain') || window.location.hostname,
-        page: deepAccess(bidderRequest, 'refererInfo.page') || window.location.href,
+        domain: deepAccess(bidderRequest, 'refererInfo.domain', window.location.hostname),
+        page: deepAccess(bidderRequest, 'refererInfo.page', window.location.href),
         ref: deepAccess(bidderRequest, 'refererInfo.ref'),
         ...firstPartyData.site,
       },
@@ -66,7 +65,7 @@ export const sharethroughAdapterSpec = {
 
     req.user = nullish(firstPartyData.user, {});
     if (!req.user.ext) req.user.ext = {};
-    req.user.ext.eids = userIdAsEids(bidRequests[0]);
+    req.user.ext.eids = createEidsArray(deepAccess(bidRequests[0], 'userId')) || [];
 
     if (bidderRequest.gdprConsent) {
       const gdprApplies = bidderRequest.gdprConsent.gdprApplies === true;
@@ -181,21 +180,12 @@ export const sharethroughAdapterSpec = {
     });
   },
 
-  getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
-    const syncParams = uspConsent ? `&us_privacy=${uspConsent}` : '';
-    const syncs = [];
-    const shouldCookieSync = syncOptions.pixelEnabled &&
-      serverResponses.length > 0 &&
-      serverResponses[0].body &&
-      serverResponses[0].body.cookieSyncUrls;
-
-    if (shouldCookieSync) {
-      serverResponses[0].body.cookieSyncUrls.forEach(url => {
-        syncs.push({ type: 'image', url: url + syncParams });
-      });
-    }
+  getUserSyncs: (syncOptions, serverResponses) => {
+    const shouldCookieSync = syncOptions.pixelEnabled && deepAccess(serverResponses, '0.body.cookieSyncUrls') !== undefined;
 
-    return syncs;
+    return shouldCookieSync
+      ? serverResponses[0].body.cookieSyncUrls.map(url => ({ type: 'image', url: url }))
+      : [];
   },
 
   // Empty implementation for prebid core to be able to find it
@@ -244,11 +234,6 @@ function getBidRequestFloor(bid) {
   return floor !== null ? floor : bid.params.floor;
 }
 
-function userIdAsEids(bidRequest) {
-  const eids = createEidsArray(deepAccess(bidRequest, 'userId')) || [];
-  return eids;
-}
-
 function getProtocol() {
   return window.location.protocol;
 }