Merge branch 'master' into prebid-8

Author: dgirardi

integrationExamples/gpt/userId_example.html

@@ -251,17 +251,31 @@
             {
               "name": "uid2",
               "params": {
+                "uid2ApiBase": "https://operator-integ.uidapi.com", // Omit this setting for production
                 "uid2Token": {
-                  "advertising_token": "example token",
-                  "refresh_token": "aslkdjaslkjdaslkhj",
-                  "identity_expires": Date.now() + 60*1000,
+                  "advertising_token": "advertising token goes here",
+                  "refresh_token": "refresh token goes here",
+                  "identity_expires": Date.now() + 60*1000, // These timestamps should be from the token generate response
                   "refresh_from": Date.now() - 10*1000,
                   "refresh_expires": Date.now() + 12*60*60*1000,
-                  "refresh_response_key": null
+                  "refresh_response_key": "refresh key goes here"
                 }
               }
-            }
-            ,
+            },
+            {
+              "name": "euid",
+              "params": {
+                "euidApiBase": "https://integ.euid.eu", // Omit this setting for production
+                "euidToken": {
+                  "advertising_token": "advertising token goes here",
+                  "refresh_token": "refresh token goes here",
+                  "identity_expires": Date.now() + 60*1000, // These timestamps should be from the token generate response
+                  "refresh_from": Date.now() - 10*1000,
+                  "refresh_expires": Date.now() + 12*60*60*1000,
+                  "refresh_response_key": "refresh key goes here"
+                }
+              }
+            },
             {
               "name": "imuid",
               "params": {

modules/.submodules.json

@@ -40,6 +40,7 @@
       "tncIdSystem",
       "utiqSystem",
       "uid2IdSystem",
+      "euidIdSystem",
       "unifiedIdSystem",
       "verizonMediaIdSystem",
       "zeotapIdPlusIdSystem",

modules/adagioBidAdapter.js

@@ -44,7 +44,11 @@ const ADAGIO_TAG_URL = 'https://script.4dex.io/localstore.js';
 const ADAGIO_LOCALSTORAGE_KEY = 'adagioScript';
 const GVLID = 617;
 export const storage = getStorageManager({bidderCode: BIDDER_CODE});
-export const RENDERER_URL = 'https://script.4dex.io/outstream-player.js';
+
+const BB_PUBLICATION = 'adagio';
+const BB_RENDERER_DEFAULT = 'renderer';
+export const BB_RENDERER_URL = `https://${BB_PUBLICATION}.bbvms.com/r/$RENDERER.js`;
+
 const MAX_SESS_DURATION = 30 * 60 * 1000;
 const ADAGIO_PUBKEY = 'AL16XT44Sfp+8SHVF1UdC7hydPSMVLMhsYknKDdwqq+0ToDSJrP0+Qh0ki9JJI2uYm/6VEYo8TJED9WfMkiJ4vf02CW3RvSWwc35bif2SK1L8Nn/GfFYr/2/GG/Rm0vUsv+vBHky6nuuYls20Og0HDhMgaOlXoQ/cxMuiy5QSktp';
 const ADAGIO_PUBKEY_E = 65537;
@@ -62,7 +66,7 @@ export const ORTB_VIDEO_PARAMS = {
   'startdelay': (value) => isInteger(value),
   'placement': (value) => isInteger(value),
   'linearity': (value) => isInteger(value),
-  'skip': (value) => isInteger(value),
+  'skip': (value) => [1, 0].includes(value),
   'skipmin': (value) => isInteger(value),
   'skipafter': (value) => isInteger(value),
   'sequence': (value) => isInteger(value),
@@ -443,16 +447,6 @@ function _buildVideoBidRequest(bidRequest) {
   });
 }
 
-function _renderer(bid) {
-  bid.renderer.push(() => {
-    if (typeof window.ADAGIO.outstreamPlayer === 'function') {
-      window.ADAGIO.outstreamPlayer(bid);
-    } else {
-      logError(`${LOG_PREFIX} Adagio outstream player is not defined`);
-    }
-  });
-}
-
 function _parseNativeBidResponse(bid) {
   if (!bid.admNative || !Array.isArray(bid.admNative.assets)) {
     logError(`${LOG_PREFIX} Invalid native response`);
@@ -882,6 +876,77 @@ function storeRequestInAdagioNS(bidRequest) {
   };
 }
 
+// See https://support.bluebillywig.com/developers/vast-renderer/
+const OUTSTREAM_RENDERER = {
+  bootstrapPlayer: function(bid) {
+    const rendererCode = bid.outstreamRendererCode;
+
+    const config = {
+      code: bid.adUnitCode,
+    };
+
+    if (bid.vastXml) {
+      config.vastXml = bid.vastXml;
+    } else if (bid.vastUrl) {
+      config.vastUrl = bid.vastUrl;
+    }
+
+    if (!bid.vastXml && !bid.vastUrl) {
+      logError(`${LOG_PREFIX} no vastXml or vastUrl on bid`);
+      return;
+    }
+
+    if (!window.bluebillywig || !window.bluebillywig.renderers || !window.bluebillywig.renderers.length) {
+      logError(`${LOG_PREFIX} no BlueBillywig renderers found!`);
+      return;
+    }
+
+    const rendererId = this.getRendererId(BB_PUBLICATION, rendererCode);
+
+    const override = {}
+    if (bid.skipOffset) {
+      override.skipOffset = bid.skipOffset.toString()
+    }
+
+    const renderer = window.bluebillywig.renderers.find(bbr => bbr._id === rendererId);
+    if (!renderer) {
+      logError(`${LOG_PREFIX} couldn't find a renderer with ID ${rendererId}`);
+      return;
+    }
+
+    const el = document.getElementById(bid.adUnitCode);
+
+    renderer.bootstrap(config, el, override);
+  },
+  newRenderer: function(adUnitCode, rendererCode) {
+    const rendererUrl = BB_RENDERER_URL.replace('$RENDERER', rendererCode);
+
+    const renderer = Renderer.install({
+      url: rendererUrl,
+      loaded: false,
+      adUnitCode
+    });
+
+    try {
+      renderer.setRender(this.outstreamRender);
+    } catch (err) {
+      logError(`${LOG_PREFIX} error trying to setRender`, err);
+    }
+
+    return renderer;
+  },
+  outstreamRender: function(bid) {
+    bid.renderer.push(() => {
+      OUTSTREAM_RENDERER.bootstrapPlayer(bid)
+    });
+  },
+  getRendererId: function(publication, renderer) {
+    // By convention, the RENDERER_ID is always the publication name (adagio) and the ad unit code (eg. renderer)
+    // joined together by a dash. It's used to identify the correct renderer instance on the page in case there's multiple.
+    return `${publication}-${renderer}`;
+  }
+};
+
 export const spec = {
   code: BIDDER_CODE,
   gvlid: GVLID,
@@ -1111,21 +1176,18 @@ export const spec = {
                 const mediaTypeContext = deepAccess(bidReq, 'mediaTypes.video.context');
                 // Adagio SSP returns a `vastXml` only. No `vastUrl` nor `videoCacheKey`.
                 if (!bidObj.vastUrl && bidObj.vastXml) {
-                  bidObj.vastUrl = 'data:text/xml;charset=utf-8;base64,' + btoa(bidObj.vastXml.replace(/\\"/g, '"'));
+                  bidObj.vastUrl = 'data:text/xml;charset=utf-8;base64,' + window.btoa(bidObj.vastXml.replace(/\\"/g, '"'));
                 }
 
                 if (mediaTypeContext === OUTSTREAM) {
-                  bidObj.renderer = Renderer.install({
-                    id: bidObj.requestId,
-                    adUnitCode: bidObj.adUnitCode,
-                    url: bidObj.urlRenderer || RENDERER_URL,
-                    config: {
-                      ...deepAccess(bidReq, 'mediaTypes.video'),
-                      ...deepAccess(bidObj, 'outstream', {})
-                    }
-                  });
-
-                  bidObj.renderer.setRender(_renderer);
+                  bidObj.outstreamRendererCode = deepAccess(bidReq, 'params.rendererCode', BB_RENDERER_DEFAULT)
+
+                  if (deepAccess(bidReq, 'mediaTypes.video.skip')) {
+                    const skipOffset = deepAccess(bidReq, 'mediaTypes.video.skipafter', 5) // default 5s.
+                    bidObj.skipOffset = skipOffset
+                  }
+
+                  bidObj.renderer = OUTSTREAM_RENDERER.newRenderer(bidObj.adUnitCode, bidObj.outstreamRendererCode);
                 }
               }
 

modules/airgridRtdProvider.js

@@ -12,8 +12,9 @@ import {
   deepAccess,
 } from '../src/utils.js';
 import { getGlobal } from '../src/prebidGlobal.js';
-import {getStorageManager} from '../src/storageManager.js';
-import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { loadExternalScript } from '../src/adloader.js';
+import { MODULE_TYPE_RTD } from '../src/activities/modules.js';
 
 const MODULE_NAME = 'realTimeData';
 const SUBMODULE_NAME = 'airgrid';
@@ -25,6 +26,11 @@ export const storage = getStorageManager({
   moduleName: SUBMODULE_NAME,
 });
 
+function getModuleUrl(accountId) {
+  const path = accountId ?? 'sdk';
+  return `https://cdn.edkt.io/${path}/edgekit.min.js`;
+}
+
 /**
  * Attach script tag to DOM
  * @param {Object} rtdConfig
@@ -33,19 +39,12 @@ export const storage = getStorageManager({
 export function attachScriptTagToDOM(rtdConfig) {
   var edktInitializor = (window.edktInitializor = window.edktInitializor || {});
   if (!edktInitializor.invoked) {
-    edktInitializor.invoked = true;
     edktInitializor.accountId = rtdConfig.params.accountId;
     edktInitializor.publisherId = rtdConfig.params.publisherId;
     edktInitializor.apiKey = rtdConfig.params.apiKey;
-    edktInitializor.load = function (e) {
-      var p = e || 'sdk';
-      var n = document.createElement('script');
-      n.type = 'module';
-      n.async = true;
-      n.src = 'https://cdn.edkt.io/' + p + '/edgekit.min.js';
-      document.getElementsByTagName('head')[0].appendChild(n);
-    };
-    edktInitializor.load(edktInitializor.accountId);
+    edktInitializor.invoked = true;
+    const moduleSrc = getModuleUrl(rtdConfig.params.accountId);
+    loadExternalScript(moduleSrc, SUBMODULE_NAME);
   }
 }
 

modules/criteoBidAdapter.js

@@ -28,7 +28,7 @@ const LOG_PREFIX = 'Criteo: ';
   Unminified source code can be found in the privately shared repo: https://github.com/Prebid-org/prebid-js-external-js-criteo/blob/master/dist/prod.js
 */
 const FAST_BID_VERSION_PLACEHOLDER = '%FAST_BID_VERSION%';
-export const FAST_BID_VERSION_CURRENT = 135;
+export const FAST_BID_VERSION_CURRENT = 136;
 const FAST_BID_VERSION_LATEST = 'latest';
 const FAST_BID_VERSION_NONE = 'none';
 const PUBLISHER_TAG_URL_TEMPLATE = 'https://static.criteo.net/js/ld/publishertag.prebid' + FAST_BID_VERSION_PLACEHOLDER + '.js';

modules/euidIdSystem.js

@@ -0,0 +1,121 @@
+/**
+ * This module adds EUID ID support to the User ID module. It shares significant functionality with the UID2 module.
+ * The {@link module:modules/userId} module is required.
+ * @module modules/euidIdSystem
+ * @requires module:modules/userId
+ */
+
+import { logInfo, logWarn, deepAccess } from '../src/utils.js';
+import {submodule} from '../src/hook.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
+
+// RE below lint exception: UID2 and EUID are separate modules, but the protocol is the same and shared code makes sense here.
+// eslint-disable-next-line prebid/validate-imports
+import { Uid2GetId, Uid2CodeVersion } from './uid2IdSystem_shared.js';
+
+const MODULE_NAME = 'euid';
+const MODULE_REVISION = Uid2CodeVersion;
+const PREBID_VERSION = '$prebid.version$';
+const EUID_CLIENT_ID = `PrebidJS-${PREBID_VERSION}-EUIDModule-${MODULE_REVISION}`;
+const GVLID_TTD = 21; // The Trade Desk
+const LOG_PRE_FIX = 'EUID: ';
+const ADVERTISING_COOKIE = '__euid_advertising_token';
+
+// eslint-disable-next-line no-unused-vars
+const EUID_TEST_URL = 'https://integ.euid.eu';
+const EUID_PROD_URL = 'https://prod.euid.eu';
+const EUID_BASE_URL = EUID_PROD_URL;
+
+function createLogger(logger, prefix) {
+  return function (...strings) {
+    logger(prefix + ' ', ...strings);
+  }
+}
+const _logInfo = createLogger(logInfo, LOG_PRE_FIX);
+const _logWarn = createLogger(logWarn, LOG_PRE_FIX);
+
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
+
+function hasWriteToDeviceConsent(consentData) {
+  const gdprApplies = consentData?.gdprApplies === true;
+  const localStorageConsent = deepAccess(consentData, `vendorData.purpose.consents.1`)
+  const prebidVendorConsent = deepAccess(consentData, `vendorData.vendor.consents.${GVLID_TTD.toString()}`)
+  if (gdprApplies && (!localStorageConsent || !prebidVendorConsent)) {
+    return false;
+  }
+  return true;
+}
+
+/** @type {Submodule} */
+export const euidIdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+
+  /**
+   * Vendor id of The Trade Desk
+   * @type {Number}
+   */
+  gvlid: GVLID_TTD,
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {string} value
+   * @returns {{euid:{ id: string } }} or undefined if value doesn't exists
+   */
+  decode(value) {
+    const result = decodeImpl(value);
+    _logInfo('EUID decode returned', result);
+    return result;
+  },
+
+  /**
+   * performs action to obtain id and return a value.
+   * @function
+   * @param {SubmoduleConfig} [configparams]
+   * @param {ConsentData|undefined} consentData
+   * @returns {euidId}
+   */
+  getId(config, consentData) {
+    if (consentData?.gdprApplies !== true) {
+      logWarn('EUID is intended for use within the EU. The module will not run when GDPR does not apply.');
+      return;
+    }
+    if (!hasWriteToDeviceConsent(consentData)) {
+      // The module cannot operate without this permission.
+      _logWarn(`Unable to use EUID module due to insufficient consent. The EUID module requires storage permission.`)
+      return;
+    }
+
+    const mappedConfig = {
+      apiBaseUrl: config?.params?.euidApiBase ?? EUID_BASE_URL,
+      paramToken: config?.params?.euidToken,
+      serverCookieName: config?.params?.euidCookie,
+      storage: config?.params?.storage ?? 'localStorage',
+      clientId: EUID_CLIENT_ID,
+      internalStorage: ADVERTISING_COOKIE
+    };
+
+    const result = Uid2GetId(mappedConfig, storage, _logInfo, _logWarn);
+    _logInfo(`EUID getId returned`, result);
+    return result;
+  },
+};
+
+function decodeImpl(value) {
+  if (typeof value === 'string') {
+    _logInfo('Found server-only token. Refresh is unavailable for this token.');
+    const result = { euid: { id: value } };
+    return result;
+  }
+  if (Date.now() < value.latestToken.identity_expires) {
+    return { euid: { id: value.latestToken.advertising_token } };
+  }
+  return null;
+}
+
+// Register submodule for userId
+submodule('userId', euidIdSubmodule);