1plusX RTD Module for Prebid
+ +
+
+
+
+
+
diff --git a/integrationExamples/gpt/airgridRtdProvider_example.html b/integrationExamples/gpt/airgridRtdProvider_example.html
index a8fd989f682..657eae8f481 100644
--- a/integrationExamples/gpt/airgridRtdProvider_example.html
+++ b/integrationExamples/gpt/airgridRtdProvider_example.html
@@ -108,10 +108,7 @@
var gads = document.createElement("script");
gads.async = true;
gads.type = "text/javascript";
- var useSSL = "https:" == document.location.protocol;
- gads.src =
- (useSSL ? "https:" : "http:") +
- "//www.googletagservices.com/tag/js/gpt.js";
+ gads.src = 'https://securepubads.g.doubleclick.net/tag/js/gpt.js';
var node = document.getElementsByTagName("script")[0];
node.parentNode.insertBefore(gads, node);
})();
diff --git a/integrationExamples/gpt/akamaidap_email_example.html b/integrationExamples/gpt/akamaidap_email_example.html
deleted file mode 100755
index 828b2add787..00000000000
--- a/integrationExamples/gpt/akamaidap_email_example.html
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Prebid.js Test
-Div-1
-
-
-
-User IDs Sent to Bidding Adapter
- - - diff --git a/integrationExamples/gpt/akamaidap_signature_example.html b/integrationExamples/gpt/akamaidap_signature_example.html deleted file mode 100644 index e4c7c617653..00000000000 --- a/integrationExamples/gpt/akamaidap_signature_example.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - - - - - - - - -Prebid.js Test
-Div-1
-
-
-
-User IDs Sent to Bidding Adapter
- - - diff --git a/integrationExamples/gpt/akamaidap_x1_example.html b/integrationExamples/gpt/akamaidap_x1_example.html deleted file mode 100755 index b1f16acc560..00000000000 --- a/integrationExamples/gpt/akamaidap_x1_example.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - - - - - - - - - -Prebid.js Test
-Div-1
-
-
-
-User IDs Sent to Bidding Adapter
- - - diff --git a/integrationExamples/gpt/amp/remote.html b/integrationExamples/gpt/amp/remote.html index 785d854766f..4ee2cdcb2f6 100644 --- a/integrationExamples/gpt/amp/remote.html +++ b/integrationExamples/gpt/amp/remote.html @@ -33,7 +33,7 @@ // load Prebid.js (function () { - var d = document, pbs = d.createElement("script"), pro = d.location.protocal; + var d = document, pbs = d.createElement("script"); pbs.type = "text/javascript"; pbs.src = prebidSrc; var target = document.getElementsByTagName("head")[0]; diff --git a/integrationExamples/gpt/blueconicRtdProvider_example.html b/integrationExamples/gpt/blueconicRtdProvider_example.html new file mode 100644 index 00000000000..598a7569d8e --- /dev/null +++ b/integrationExamples/gpt/blueconicRtdProvider_example.html @@ -0,0 +1,121 @@ + + + + + + + + + + + + + + + +BlueConic RTD Prebid
+ +
+
+
+
+
+
+BlueConic Real-Time Data:
+
+
+
+
diff --git a/integrationExamples/gpt/gdpr_hello_world.html b/integrationExamples/gpt/gdpr_hello_world.html
index 2d70af8d34f..c62569cfc4f 100644
--- a/integrationExamples/gpt/gdpr_hello_world.html
+++ b/integrationExamples/gpt/gdpr_hello_world.html
@@ -1,83 +1,19 @@
-
-
+ window._iub = window._iub || {};
+ _iub.csConfiguration = {
+ cookiePolicyId: 417383,
+ siteId: 1,
+ logLevel: 'error',
+ lang: 'en',
+ enableTcf: true,
+ };
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
- Prebid.js Test
-Div-1
-
-
-
-
-
diff --git a/integrationExamples/gpt/hadronRtdProvider_example.html b/integrationExamples/gpt/hadronRtdProvider_example.html
index 065c8379956..f90ce21921c 100644
--- a/integrationExamples/gpt/hadronRtdProvider_example.html
+++ b/integrationExamples/gpt/hadronRtdProvider_example.html
@@ -88,9 +88,7 @@
var gads = document.createElement('script');
gads.async = true;
gads.type = 'text/javascript';
- var useSSL = 'https:' == document.location.protocol;
- gads.src = (useSSL ? 'https:' : 'http:') +
- '//www.googletagservices.com/tag/js/gpt.js';
+ gads.src = 'https://securepubads.g.doubleclick.net/tag/js/gpt.js';
var node = document.getElementsByTagName('script')[0];
node.parentNode.insertBefore(gads, node);
})();
diff --git a/integrationExamples/gpt/inskin_example.html b/integrationExamples/gpt/inskin_example.html
index 197a5b1ffe1..45fd448cf48 100644
--- a/integrationExamples/gpt/inskin_example.html
+++ b/integrationExamples/gpt/inskin_example.html
@@ -72,9 +72,7 @@
var gads = document.createElement('script');
gads.async = true;
gads.type = 'text/javascript';
- var useSSL = 'https:' == document.location.protocol;
- gads.src = (useSSL ? 'https:' : 'http:') +
- '//www.googletagservices.com/tag/js/gpt.js';
+ gads.src = 'https://securepubads.g.doubleclick.net/tag/js/gpt.js';
var node = document.getElementsByTagName('script')[0];
node.parentNode.insertBefore(gads, node);
})();
diff --git a/integrationExamples/gpt/permutiveRtdProvider_example.html b/integrationExamples/gpt/permutiveRtdProvider_example.html
index dbb4d2af0d6..118cc678726 100644
--- a/integrationExamples/gpt/permutiveRtdProvider_example.html
+++ b/integrationExamples/gpt/permutiveRtdProvider_example.html
@@ -23,7 +23,7 @@
}
}
- setLocalStorageData()
+ setLocalStorageData();
var div_1_sizes = [
[300, 250],
diff --git a/integrationExamples/gpt/prebidServer_example.html b/integrationExamples/gpt/prebidServer_example.html
index 37902edd979..f23554369bc 100644
--- a/integrationExamples/gpt/prebidServer_example.html
+++ b/integrationExamples/gpt/prebidServer_example.html
@@ -12,9 +12,7 @@
var gads = document.createElement('script');
gads.async = true;
gads.type = 'text/javascript';
- var useSSL = 'https:' == document.location.protocol;
- gads.src = (useSSL ? 'https:' : 'http:') +
- '//www.googletagservices.com/tag/js/gpt.js';
+ gads.src = 'https://securepubads.g.doubleclick.net/tag/js/gpt.js';
var node = document.getElementsByTagName('script')[0];
node.parentNode.insertBefore(gads, node);
})();
diff --git a/integrationExamples/gpt/prebidServer_native_example.html b/integrationExamples/gpt/prebidServer_native_example.html
index 16c7d38a427..c590f0bcee5 100644
--- a/integrationExamples/gpt/prebidServer_native_example.html
+++ b/integrationExamples/gpt/prebidServer_native_example.html
@@ -133,8 +133,8 @@
-
\ No newline at end of file
+
diff --git a/karma.conf.maker.js b/karma.conf.maker.js
index b5c6b44e4fd..fd8f2e6fdd8 100644
--- a/karma.conf.maker.js
+++ b/karma.conf.maker.js
@@ -7,7 +7,7 @@ var _ = require('lodash');
var webpackConf = require('./webpack.conf.js');
var karmaConstants = require('karma').constants;
-function newWebpackConfig(codeCoverage) {
+function newWebpackConfig(codeCoverage, disableFeatures) {
// Make a clone here because we plan on mutating this object, and don't want parallel tasks to trample each other.
var webpackConfig = _.cloneDeep(webpackConf);
@@ -22,20 +22,9 @@ function newWebpackConfig(codeCoverage) {
.flatMap((r) => r.use)
.filter((use) => use.loader === 'babel-loader')
.forEach((use) => {
- use.options = babelConfig(true);
+ use.options = babelConfig({test: true, codeCoverage, disableFeatures});
});
- if (codeCoverage) {
- webpackConfig.module.rules.push({
- enforce: 'post',
- exclude: /(node_modules)|(test)|(integrationExamples)|(build)|polyfill.js|(src\/adapters\/analytics\/ga.js)/,
- use: {
- loader: '@jsdevtools/coverage-istanbul-loader',
- options: { esModules: true }
- },
- test: /\.js$/
- })
- }
return webpackConfig;
}
@@ -92,7 +81,9 @@ function setBrowsers(karmaConf, browserstack) {
karmaConf.browserStack = {
username: process.env.BROWSERSTACK_USERNAME,
accessKey: process.env.BROWSERSTACK_ACCESS_KEY,
- build: 'Prebidjs Unit Tests ' + new Date().toLocaleString()
+ build: 'Prebidjs Unit Tests ' + new Date().toLocaleString(),
+ startTunnel: false,
+ localIdentifier: process.env.CIRCLE_WORKFLOW_JOB_ID
}
if (process.env.TRAVIS) {
karmaConf.browserStack.startTunnel = false;
@@ -117,8 +108,8 @@ function setBrowsers(karmaConf, browserstack) {
}
}
-module.exports = function(codeCoverage, browserstack, watchMode, file) {
- var webpackConfig = newWebpackConfig(codeCoverage);
+module.exports = function(codeCoverage, browserstack, watchMode, file, disableFeatures) {
+ var webpackConfig = newWebpackConfig(codeCoverage, disableFeatures);
var plugins = newPluginsArray(browserstack);
var files = file ? ['test/test_deps.js', file] : ['test/test_index.js'];
@@ -164,6 +155,12 @@ module.exports = function(codeCoverage, browserstack, watchMode, file) {
reporters: ['mocha'],
+ client: {
+ mocha: {
+ timeout: 3000
+ }
+ },
+
mochaReporter: {
showDiff: true,
output: 'minimal'
@@ -179,7 +176,7 @@ module.exports = function(codeCoverage, browserstack, watchMode, file) {
concurrency: 6,
plugins: plugins
- }
+ };
// To ensure that, we are able to run single spec file
// here we are adding preprocessors, when file is passed
diff --git a/karmaRunner.js b/karmaRunner.js
new file mode 100644
index 00000000000..96259069966
--- /dev/null
+++ b/karmaRunner.js
@@ -0,0 +1,23 @@
+const karma = require('karma');
+const process = require('process');
+const karmaConfMaker = require('./karma.conf.maker.js');
+
+process.on('message', function(options) {
+ try {
+ let cfg = karmaConfMaker(options.coverage, options.browserstack, options.watch, options.file, options.disableFeatures);
+ if (options.browsers && options.browsers.length) {
+ cfg.browsers = options.browsers;
+ }
+ if (options.oneBrowser) {
+ cfg.browsers = [cfg.browsers.find((b) => b.toLowerCase().includes(options.oneBrowser.toLowerCase())) || cfg.browsers[0]]
+ }
+ cfg = karma.config.parseConfig(null, cfg);
+ new karma.Server(cfg, (exitCode) => {
+ process.exit(exitCode);
+ }).start();
+ } catch (e) {
+ // eslint-disable-next-line
+ console.error(e);
+ process.exit(1);
+ }
+});
diff --git a/libraries/LIBRARIES.md b/libraries/LIBRARIES.md
new file mode 100644
index 00000000000..e4d8fcc4f98
--- /dev/null
+++ b/libraries/LIBRARIES.md
@@ -0,0 +1,5 @@
+## Cross-module libraries
+
+Each directory under this one is packaged into a "library" during the build.
+
+Modules may share code by simply importing from a common library file; if the module is included in the build, any libraries they import from will also be included.
diff --git a/src/AnalyticsAdapter.js b/libraries/analyticsAdapter/AnalyticsAdapter.js
similarity index 90%
rename from src/AnalyticsAdapter.js
rename to libraries/analyticsAdapter/AnalyticsAdapter.js
index ae891966ee1..277a1455a75 100644
--- a/src/AnalyticsAdapter.js
+++ b/libraries/analyticsAdapter/AnalyticsAdapter.js
@@ -1,7 +1,7 @@
-import CONSTANTS from './constants.json';
-import { ajax } from './ajax.js';
-import { logMessage, _each } from './utils.js';
-import * as events from './events.js'
+import CONSTANTS from '../../src/constants.json';
+import { ajax } from '../../src/ajax.js';
+import { logMessage, _each } from '../../src/utils.js';
+import * as events from '../../src/events.js'
export const _internal = {
ajax
@@ -31,19 +31,19 @@ const {
const ENDPOINT = 'endpoint';
const BUNDLE = 'bundle';
-var _sampled = true;
-
export default function AnalyticsAdapter({ url, analyticsType, global, handler }) {
- var _queue = [];
- var _eventCount = 0;
- var _enableCheck = true;
- var _handlers;
+ const _queue = [];
+ let _eventCount = 0;
+ let _enableCheck = true;
+ let _handlers;
+ let _enabled = false;
+ let _sampled = true;
if (analyticsType === ENDPOINT || BUNDLE) {
_emptyQueue();
}
- return {
+ return Object.defineProperties({
track: _track,
enqueue: _enqueue,
enableAnalytics: _enable,
@@ -52,7 +52,11 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
getGlobal: () => global,
getHandler: () => handler,
getUrl: () => url
- };
+ }, {
+ enabled: {
+ get: () => _enabled
+ }
+ });
function _track({ eventType, args }) {
if (this.getAdapterType() === BUNDLE) {
@@ -140,6 +144,7 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
this.enableAnalytics = function _enable() {
return logMessage(`Analytics adapter for "${global}" already enabled, unnecessary call to \`enableAnalytics\`.`);
};
+ _enabled = true;
}
function _disable() {
@@ -147,6 +152,7 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
events.off(event, handler);
});
this.enableAnalytics = this._oldEnable ? this._oldEnable : _enable;
+ _enabled = false;
}
function _emptyQueue() {
diff --git a/src/adapters/analytics/example.js b/libraries/analyticsAdapter/examples/example.js
similarity index 85%
rename from src/adapters/analytics/example.js
rename to libraries/analyticsAdapter/examples/example.js
index 1321612b688..c6907907b23 100644
--- a/src/adapters/analytics/example.js
+++ b/libraries/analyticsAdapter/examples/example.js
@@ -2,7 +2,7 @@
* example.js - analytics adapter for Example Analytics Library example
*/
-import adapter from '../../AnalyticsAdapter.js';
+import adapter from '../AnalyticsAdapter.js';
export default adapter(
{
diff --git a/src/adapters/analytics/example2.js b/libraries/analyticsAdapter/examples/example2.js
similarity index 92%
rename from src/adapters/analytics/example2.js
rename to libraries/analyticsAdapter/examples/example2.js
index eadf994ce36..d95a3f54283 100644
--- a/src/adapters/analytics/example2.js
+++ b/libraries/analyticsAdapter/examples/example2.js
@@ -5,7 +5,7 @@ import { ajax } from '../../../src/ajax.js';
* example2.js - analytics adapter for Example2 Analytics Endpoint example
*/
-import adapter from '../../AnalyticsAdapter.js';
+import adapter from '../AnalyticsAdapter.js';
const url = 'https://httpbin.org/post';
const analyticsType = 'endpoint';
diff --git a/src/adapters/analytics/libraries/example.js b/libraries/analyticsAdapter/examples/libraries/example.js
similarity index 95%
rename from src/adapters/analytics/libraries/example.js
rename to libraries/analyticsAdapter/examples/libraries/example.js
index 0d758fd5513..f2bfd612193 100644
--- a/src/adapters/analytics/libraries/example.js
+++ b/libraries/analyticsAdapter/examples/libraries/example.js
@@ -31,8 +31,8 @@ events.init();
// overwrite example object and handle 'on' callbacks
window[window.ExampleAnalyticsGlobalObject] = example = utils.errorless(function() {
if (arguments[0] && arguments[0] === 'on') {
- var eventName = arguments[1] && arguments[1];
- var args = arguments[2] && arguments[2];
+ var eventName = arguments[1];
+ var args = arguments[2];
if (eventName && args) {
if (eventName === 'bidAdjustment') {
pbjsHandlers.onBidAdjustment.apply(this, [args]);
diff --git a/src/adapters/analytics/libraries/example2.js b/libraries/analyticsAdapter/examples/libraries/example2.js
similarity index 95%
rename from src/adapters/analytics/libraries/example2.js
rename to libraries/analyticsAdapter/examples/libraries/example2.js
index 68e814b1417..9a7106a48e0 100644
--- a/src/adapters/analytics/libraries/example2.js
+++ b/libraries/analyticsAdapter/examples/libraries/example2.js
@@ -31,8 +31,8 @@ events.init();
// overwrite example object and handle 'on' callbacks
window[window.ExampleAnalyticsGlobalObject2] = example = utils.errorless(function() {
if (arguments[0] && arguments[0] === 'on') {
- var eventName = arguments[1] && arguments[1];
- var args = arguments[2] && arguments[2];
+ var eventName = arguments[1];
+ var args = arguments[2];
if (eventName && args) {
if (eventName === 'bidAdjustment') {
pbjsHandlers.onBidAdjustment.apply(this, [args]);
diff --git a/libraries/getOrigin/index.js b/libraries/getOrigin/index.js
new file mode 100644
index 00000000000..c37a913db07
--- /dev/null
+++ b/libraries/getOrigin/index.js
@@ -0,0 +1,11 @@
+/**
+ * Returns the origin
+ */
+export function getOrigin() {
+ // IE10 does not have this property. https://gist.github.com/hbogs/7908703
+ if (!window.location.origin) {
+ return window.location.protocol + '//' + window.location.hostname + (window.location.port ? ':' + window.location.port : '');
+ } else {
+ return window.location.origin;
+ }
+}
diff --git a/modules/.submodules.json b/modules/.submodules.json
index 8d62f30d7c4..d3665dd38f4 100644
--- a/modules/.submodules.json
+++ b/modules/.submodules.json
@@ -1,75 +1,79 @@
{
- "userId": [
- "33acrossIdSystem",
- "admixerIdSystem",
- "adtelligentIdSystem",
- "akamaiDAPIdSystem",
- "amxIdSystem",
- "britepoolIdSystem",
- "connectIdSystem",
- "cpexIdSystem",
- "criteoIdSystem",
- "dacIdSystem",
- "deepintentDpesIdSystem",
- "dmdIdSystem",
- "fabrickIdSystem",
- "flocIdSystem",
- "hadronIdSystem",
- "haloIdSystem",
- "id5IdSystem",
- "ftrackIdSystem",
- "identityLinkIdSystem",
- "idxIdSystem",
- "imuIdSystem",
- "intentIqIdSystem",
- "justIdSystem",
- "kinessoIdSystem",
- "liveIntentIdSystem",
- "lotamePanoramaIdSystem",
- "merkleIdSystem",
- "mwOpenLinkIdSystem",
- "naveggIdSystem",
- "netIdSystem",
- "nextrollIdSystem",
- "novatiqIdSystem",
- "parrableIdSystem",
- "pubProvidedIdSystem",
- "publinkIdSystem",
- "quantcastIdSystem",
- "sharedIdSystem",
- "tapadIdSystem",
- "trustpidSystem",
- "uid2IdSystem",
- "unifiedIdSystem",
- "verizonMediaIdSystem",
- "zeotapIdPlusIdSystem",
- "adqueryIdSystem",
- "gravitoIdSystem"
- ],
- "adpod": [
- "freeWheelAdserverVideo",
- "dfpAdServerVideo"
- ],
- "rtdModule": [
- "airgridRtdProvider",
- "akamaiDapRtdProvider",
- "browsiRtdProvider",
- "dgkeywordRtdProvider",
- "geoedgeRtdProvider",
- "hadronRtdProvider",
- "haloRtdProvider",
- "iasRtdProvider",
- "jwplayerRtdProvider",
- "medianetRtdProvider",
- "optimeraRtdProvider",
- "permutiveRtdProvider",
- "reconciliationRtdProvider",
- "sirdataRtdProvider",
- "timeoutRtdProvider",
- "weboramaRtdProvider"
- ],
- "fpdModule": [
- "enrichmentFpdModule",
- "validationFpdModule"
- ]
-}
+ "parentModules": {
+ "userId": [
+ "33acrossIdSystem",
+ "admixerIdSystem",
+ "adtelligentIdSystem",
+ "amxIdSystem",
+ "britepoolIdSystem",
+ "connectIdSystem",
+ "cpexIdSystem",
+ "criteoIdSystem",
+ "dacIdSystem",
+ "deepintentDpesIdSystem",
+ "dmdIdSystem",
+ "fabrickIdSystem",
+ "hadronIdSystem",
+ "id5IdSystem",
+ "ftrackIdSystem",
+ "identityLinkIdSystem",
+ "idxIdSystem",
+ "imuIdSystem",
+ "intentIqIdSystem",
+ "justIdSystem",
+ "kinessoIdSystem",
+ "liveIntentIdSystem",
+ "lotamePanoramaIdSystem",
+ "merkleIdSystem",
+ "mwOpenLinkIdSystem",
+ "naveggIdSystem",
+ "netIdSystem",
+ "novatiqIdSystem",
+ "oneKeyIdSystem",
+ "parrableIdSystem",
+ "pubProvidedIdSystem",
+ "publinkIdSystem",
+ "quantcastIdSystem",
+ "sharedIdSystem",
+ "tapadIdSystem",
+ "tncIdSystem",
+ "trustpidSystem",
+ "uid2IdSystem",
+ "unifiedIdSystem",
+ "verizonMediaIdSystem",
+ "zeotapIdPlusIdSystem",
+ "adqueryIdSystem",
+ "gravitoIdSystem"
+ ],
+ "adpod": [
+ "freeWheelAdserverVideo",
+ "dfpAdServerVideo"
+ ],
+ "rtdModule": [
+ "1plusXRtdProvider",
+ "airgridRtdProvider",
+ "akamaiDapRtdProvider",
+ "blueconicRtdProvider",
+ "browsiRtdProvider",
+ "dgkeywordRtdProvider",
+ "geoedgeRtdProvider",
+ "hadronRtdProvider",
+ "haloRtdProvider",
+ "iasRtdProvider",
+ "jwplayerRtdProvider",
+ "medianetRtdProvider",
+ "oneKeyRtdProvider",
+ "optimeraRtdProvider",
+ "permutiveRtdProvider",
+ "reconciliationRtdProvider",
+ "sirdataRtdProvider",
+ "timeoutRtdProvider",
+ "weboramaRtdProvider"
+ ],
+ "fpdModule": [
+ "enrichmentFpdModule",
+ "validationFpdModule",
+ "topicsFpdModule"
+ ]
+ }
+}
\ No newline at end of file
diff --git a/modules/1plusXRtdProvider.js b/modules/1plusXRtdProvider.js
new file mode 100644
index 00000000000..9d010c8d298
--- /dev/null
+++ b/modules/1plusXRtdProvider.js
@@ -0,0 +1,251 @@
+import { submodule } from '../src/hook.js';
+import { config } from '../src/config.js';
+import { ajax } from '../src/ajax.js';
+import {
+ logMessage, logError,
+ deepAccess, mergeDeep,
+ isNumber, isArray, deepSetValue
+} from '../src/utils.js';
+
+// Constants
+const REAL_TIME_MODULE = 'realTimeData';
+const MODULE_NAME = '1plusX';
+const ORTB2_NAME = '1plusX.com'
+const PAPI_VERSION = 'v1.0';
+const LOG_PREFIX = '[1plusX RTD Module]: ';
+const LEGACY_SITE_KEYWORDS_BIDDERS = ['appnexus'];
+export const segtaxes = {
+ // cf. https://github.com/InteractiveAdvertisingBureau/openrtb/pull/108
+ AUDIENCE: 526,
+ CONTENT: 527,
+};
+// Functions
+/**
+ * Extracts the parameters for 1plusX RTD module from the config object passed at instanciation
+ * @param {Object} moduleConfig Config object passed to the module
+ * @param {Object} reqBidsConfigObj Config object for the bidders; each adapter has its own entry
+ * @returns {Object} Extracted configuration parameters for the module
+ */
+export const extractConfig = (moduleConfig, reqBidsConfigObj) => {
+ // CustomerId
+ const customerId = deepAccess(moduleConfig, 'params.customerId');
+ if (!customerId) {
+ throw new Error('Missing parameter customerId in moduleConfig');
+ }
+ // Timeout
+ const tempTimeout = deepAccess(moduleConfig, 'params.timeout');
+ const timeout = isNumber(tempTimeout) && tempTimeout > 300 ? tempTimeout : 1000;
+
+ // Bidders
+ const biddersTemp = deepAccess(moduleConfig, 'params.bidders');
+ if (!isArray(biddersTemp) || !biddersTemp.length) {
+ throw new Error('Missing parameter bidders in moduleConfig');
+ }
+
+ const adUnitBidders = reqBidsConfigObj.adUnits
+ .flatMap(({ bids }) => bids.map(({ bidder }) => bidder))
+ .filter((e, i, a) => a.indexOf(e) === i);
+ if (!isArray(adUnitBidders) || !adUnitBidders.length) {
+ throw new Error('Missing parameter bidders in bidRequestConfig');
+ }
+
+ const bidders = biddersTemp.filter(bidder => adUnitBidders.includes(bidder));
+ if (!bidders.length) {
+ throw new Error('No bidRequestConfig bidder found in moduleConfig bidders');
+ }
+
+ return { customerId, timeout, bidders };
+}
+
+/**
+ * Gets the URL of Profile Api from which targeting data will be fetched
+ * @param {Object} config
+ * @param {string} config.customerId
+ * @returns {string} URL to access 1plusX Profile API
+ */
+const getPapiUrl = ({ customerId }) => {
+ // https://[yourClientId].profiles.tagger.opecloud.com/[VERSION]/targeting?url=
+ const currentUrl = encodeURIComponent(window.location.href);
+ const papiUrl = `https://${customerId}.profiles.tagger.opecloud.com/${PAPI_VERSION}/targeting?url=${currentUrl}`;
+ return papiUrl;
+}
+
+/**
+ * Fetches targeting data. It contains the audience segments & the contextual topics
+ * @param {string} papiUrl URL of profile API
+ * @returns {Promise} Promise object resolving with data fetched from Profile API
+ */
+const getTargetingDataFromPapi = (papiUrl) => {
+ return new Promise((resolve, reject) => {
+ const requestOptions = {
+ customHeaders: {
+ 'Accept': 'application/json'
+ }
+ }
+ const callbacks = {
+ success(responseText, response) {
+ resolve(JSON.parse(response.response));
+ },
+ error(error) {
+ reject(error);
+ }
+ };
+ ajax(papiUrl, callbacks, null, requestOptions)
+ })
+}
+
+/**
+ * Prepares the update for the ORTB2 object
+ * @param {Object} targetingData Targeting data fetched from Profile API
+ * @param {string[]} segments Represents the audience segments of the user
+ * @param {string[]} topics Represents the topics of the page
+ * @returns {Object} Object describing the updates to make on bidder configs
+ */
+export const buildOrtb2Updates = ({ segments = [], topics = [] }, bidder) => {
+ // Currently appnexus bidAdapter doesn't support topics in `site.content.data.segment`
+ // Therefore, writing them in `site.keywords` until it's supported
+ // Other bidAdapters do fine with `site.content.data.segment`
+ const writeToLegacySiteKeywords = LEGACY_SITE_KEYWORDS_BIDDERS.includes(bidder);
+ if (writeToLegacySiteKeywords) {
+ const site = {
+ keywords: topics.join(',')
+ };
+ return { site };
+ }
+
+ const userData = {
+ name: ORTB2_NAME,
+ segment: segments.map((segmentId) => ({ id: segmentId }))
+ };
+ const siteContentData = {
+ name: ORTB2_NAME,
+ segment: topics.map((topicId) => ({ id: topicId })),
+ ext: { segtax: segtaxes.CONTENT }
+ }
+ return { userData, siteContentData };
+}
+
+/**
+ * Merges the targeting data with the existing config for bidder and updates
+ * @param {string} bidder Bidder for which to set config
+ * @param {Object} ortb2Updates Updates to be applied to bidder config
+ * @param {Object} bidderConfigs All current bidder configs
+ * @returns {Object} Updated bidder config
+ */
+export const updateBidderConfig = (bidder, ortb2Updates, bidderConfigs) => {
+ const { site, siteContentData, userData } = ortb2Updates;
+ const bidderConfigCopy = mergeDeep({}, bidderConfigs[bidder]);
+
+ if (site) {
+ // Legacy : cf. comment on buildOrtb2Updates first lines
+ const currentSite = deepAccess(bidderConfigCopy, 'ortb2.site');
+ const updatedSite = mergeDeep(currentSite, site);
+ deepSetValue(bidderConfigCopy, 'ortb2.site', updatedSite);
+ }
+
+ if (siteContentData) {
+ const siteDataPath = 'ortb2.site.content.data';
+ const currentSiteContentData = deepAccess(bidderConfigCopy, siteDataPath) || [];
+ const updatedSiteContentData = [
+ ...currentSiteContentData.filter(({ name }) => name != siteContentData.name),
+ siteContentData
+ ];
+ deepSetValue(bidderConfigCopy, siteDataPath, updatedSiteContentData);
+ }
+
+ if (userData) {
+ const userDataPath = 'ortb2.user.data';
+ const currentUserData = deepAccess(bidderConfigCopy, userDataPath) || [];
+ const updatedUserData = [
+ ...currentUserData.filter(({ name }) => name != userData.name),
+ userData
+ ];
+ deepSetValue(bidderConfigCopy, userDataPath, updatedUserData);
+ }
+
+ return bidderConfigCopy;
+};
+
+const setAppnexusAudiences = (audiences) => {
+ config.setConfig({
+ appnexusAuctionKeywords: {
+ '1plusX': audiences,
+ },
+ });
+}
+
+/**
+ * Updates bidder configs with the targeting data retreived from Profile API
+ * @param {Object} papiResponse Response from Profile API
+ * @param {Object} config Module configuration
+ * @param {string[]} config.bidders Bidders specified in module's configuration
+ */
+export const setTargetingDataToConfig = (papiResponse, { bidders }) => {
+ const bidderConfigs = config.getBidderConfig();
+ const { s: segments, t: topics } = papiResponse;
+
+ for (const bidder of bidders) {
+ const ortb2Updates = buildOrtb2Updates({ segments, topics }, bidder);
+ const updatedBidderConfig = updateBidderConfig(bidder, ortb2Updates, bidderConfigs);
+ if (updatedBidderConfig) {
+ config.setBidderConfig({
+ bidders: [bidder],
+ config: updatedBidderConfig
+ });
+ }
+ if (bidder === 'appnexus') {
+ // Do the legacy stuff for appnexus with segments
+ setAppnexusAudiences(segments);
+ }
+ }
+}
+
+// Functions exported in submodule object
+/**
+ * Init
+ * @param {Object} config Module configuration
+ * @param {boolean} userConsent
+ * @returns true
+ */
+const init = (config, userConsent) => {
+ return true;
+}
+
+/**
+ *
+ * @param {Object} reqBidsConfigObj Bid request configuration object
+ * @param {Function} callback Called on completion
+ * @param {Object} moduleConfig Configuration for 1plusX RTD module
+ * @param {boolean} userConsent
+ */
+const getBidRequestData = (reqBidsConfigObj, callback, moduleConfig, userConsent) => {
+ try {
+ // Get the required config
+ const { customerId, bidders } = extractConfig(moduleConfig, reqBidsConfigObj);
+ // Get PAPI URL
+ const papiUrl = getPapiUrl({ customerId })
+ // Call PAPI
+ getTargetingDataFromPapi(papiUrl)
+ .then((papiResponse) => {
+ logMessage(LOG_PREFIX, 'Get targeting data request successful');
+ setTargetingDataToConfig(papiResponse, { bidders });
+ callback();
+ })
+ .catch((error) => {
+ throw error;
+ })
+ } catch (error) {
+ logError(LOG_PREFIX, error);
+ callback();
+ }
+}
+
+// The RTD submodule object to be exported
+export const onePlusXSubmodule = {
+ name: MODULE_NAME,
+ init,
+ getBidRequestData
+}
+
+// Register the onePlusXSubmodule as submodule of realTimeData
+submodule(REAL_TIME_MODULE, onePlusXSubmodule);
diff --git a/modules/1plusXRtdProvider.md b/modules/1plusXRtdProvider.md
new file mode 100644
index 00000000000..6a6211b37cc
--- /dev/null
+++ b/modules/1plusXRtdProvider.md
@@ -0,0 +1,65 @@
+# 1plusX Real-time Data Submodule
+
+## Overview
+
+ Module Name: 1plusX Rtd Provider
+ Module Type: Rtd Provider
+ Maintainer: dc-team-1px@triplelift.com
+
+## Description
+
+The 1plusX RTD module appends User and Contextual segments to the bidding object.
+
+## Usage
+
+### Build
+```
+gulp build --modules="rtdModule,1plusXRtdProvider,appnexusBidAdapter,..."
+```
+
+> Note that the global RTD module, `rtdModule`, is a prerequisite of the 1plusX RTD module.
+
+### Configuration
+
+Use `setConfig` to instruct Prebid.js to initilize the 1plusX RTD module, as specified below.
+
+This module is configured as part of the `realTimeData.dataProviders`
+
+```javascript
+var TIMEOUT = 1000;
+pbjs.setConfig({
+ realTimeData: {
+ auctionDelay: TIMEOUT,
+ dataProviders: [{
+ name: '1plusX',
+ waitForIt: true,
+ params: {
+ customerId: 'acme',
+ bidders: ['appnexus', 'rubicon'],
+ timeout: TIMEOUT
+ }
+ }]
+ }
+});
+```
+
+### Parameters
+
+| Name | Type | Description | Default |
+| :---------------- | :------------ | :--------------------------------------------------------------- |:----------------- |
+| name | String | Real time data module name | Always '1plusX' |
+| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) | `false` |
+| params | Object | | |
+| params.customerId | String | Your 1plusX customer id | |
+| params.bidders | Array- `true`: Allow the player to float.
Note: If you set floatOnScroll to true, Index updates the placement value to `5`.
- `false`: Do not allow the player to float (default). +| video.playerConfig.floatSize | Optional | Integer[] | The height and width of the floating player in pixels. If you do not specify a float size, the player adjusts to the aspect ratio of the player size that is defined when it is not floating. Index recommends that you review and test the float size to your user experience preference. + +## Native + +| Key | Scope | Type | Description +| --- | --- | --- | --- +| sendTargetingKeys | Optional | Boolean | Defines whether or not to send the hb_native_ASSET targeting keys to the ad server. Defaults to true. +| adTemplate | Optional | String | Used in the ‘AdUnit-Defined Creative Scenario’, this value controls the Native template right in the page. +| rendererUrl | Optional | String | Used in the ‘Custom Renderer Scenario’, this points to javascript code that will produce the Native template. +| title | Optional | Title asset | The title of the ad, usually a call to action or a brand name. +| body | Optional | Data asset | Text of the ad copy. +| body2 | Optional | Data asset | Additional Text of the ad copy. +| sponsoredBy | Optional | Data asset | The name of the brand associated with the ad. +| icon | Optional | Image asset | The brand icon that will appear with the ad. +| image | Optional | Image asset | A picture that is associated with the brand, or grabs the user’s attention. +| displayUrl | Optional | Data asset | Text that can be displayed instead of the raw click URL. e.g, “Example.com/Specials” +| cta | Optional | Data asset | Call to Action text, e.g., “Click here for more information”. +| rating | Optional | Data asset | Rating information, e.g., “4” out of 5. +| downloads | Optional | Data asset | The total downloads of the advertised application/product. +| likes | Optional | Data asset | The total number of individuals who like the advertised application/product. +| price | Optional | Data asset | The non-sale price of the advertised application/product. +| salePrice | Optional | Data asset | The sale price of the advertised application/product. +| address | Optional | Data asset | Address of the Buyer/Store. e.g, “123 Main Street, Anywhere USA” +| phone | Optional | Data asset | Phone Number of the Buyer/Store. e.g, “(123) 456-7890” + +#### Title Asset + +| Key | Scope | Type | Description +| --- | --- | --- | --- +| required | Required | Boolean | Specify whether or not a title is required. +| len | Optional | Integer | Maximum number of characters (defaults to 25 if omitted). +| ext | Optional | Object | Arbitrary additional parameters to send to the bidder. + +#### Data Asset + +| Key | Scope | Type | Description +| --- | --- | --- | --- +| required | Required | Boolean | Specify whether or not the asset is required. +| len | Optional | Integer | Maximum number of characters. +| ext | Optional | Object | Arbitrary additional parameters to send to the bidder. + +#### Image Asset + +| Key | Scope | Type | Description +| --- | --- | --- | --- +| required | Required | Boolean | Specify whether or not the asset is required. +| sizes | Optional | Integer[] | Minimum size requested for the image, e.g., [100, 100] +| mimes | Optional | String[] | Whitelist of content MIME types supported, e.g., ["image/jpg", "image/gif"] +| ext | Optional | Object | Arbitrary additional parameters to send to the bidder. + +### Rendering Native Ad + +Native ad can be rendered by setting up GAM or setup custom native renderer. Reference [Prebid implementing the native template](https://docs.prebid.org/prebid/native-implementation.html#4-implementing-the-native-template) for more information. ## Deprecation warning @@ -247,13 +313,19 @@ var adUnits = [{ minduration: 5, maxduration: 30, mimes: ['video/mp4', 'application/javascript'], - placement: 3 + placement: 5 } }, bids: [{ bidder: 'ix', params: { siteId: '715964' + video: { + playerConfig: { + floatOnScroll: true, + floatSize: [300,250] + } + } } }] }]; @@ -290,24 +362,33 @@ pbjs.setConfig({ }); ``` #### The **detectMissingSizes** feature -By default, the IX bidding adapter bids on all banner sizes available in the ad unit when configured to at least one banner size. If you want the IX bidding adapter to only bid on the banner size it’s configured to, switch off this feature using `detectMissingSizes`. -``` -pbjs.setConfig({ - ix: { - detectMissingSizes: false - } -}); -``` -OR -``` -pbjs.setBidderConfig({ - bidders: ["ix"], - config: { - ix: { - detectMissingSizes: false +`detectMissingSize` config is now deprecated and IX bidding adapter bids on all banner sizes available in the ad unit when configured to at least one banner size. + +**Native** + +```javascript +var adUnits = [{ + code: 'native-div-a', + mediaTypes: { + native: { + title: { + required: true + }, + image: { + required: true + }, + sponsoredBy: { + required: false + } } - } -}); + }, + bids: [{ + bidder: 'ix', + params: { + siteId: '715966' + } + }] +}]; ``` ### 2. Include `ixBidAdapter` in your build process @@ -403,11 +484,8 @@ to `'ix'` across all ad units that bids are being requested for does not exceed ### Time-To-Live (TTL) -Banner bids from IX have a TTL of 300 seconds while video bids have a TTL of 1 hour, after which time they become -invalid. - -If an invalid bid wins, and its associated ad is rendered, it will not count -towards total impressions on IX's side. +Banner bids from Index have a TTL of 600 seconds while video bids have a TTL of three hours, after which time they become invalid. +**Note:** Index supports the `bid.exp` attribute in the bid response which allows our adapter to specify the maximum number of seconds allowed between the auction and billing notice. In the absence of the `bid.exp` attribute, the TTL provided above applies. FAQs ==== @@ -423,4 +501,4 @@ The `size` parameter is no longer a required field, the `siteId` will now be ass In your browser of choice, create a new tab and open the developer tools. In developer tools, select the network tab. Then, navigate to a page where IX is setup to bid. Now, in the network tab, search for requests to -`casalemedia.com/cygnus`. These are the bid requests. +`casalemedia.com/openrtb/pbjs`. These are the bid requests. diff --git a/modules/jcmBidAdapter.md b/modules/jcmBidAdapter.md deleted file mode 100644 index 53a2356df2f..00000000000 --- a/modules/jcmBidAdapter.md +++ /dev/null @@ -1,40 +0,0 @@ -#Overview - -``` -Module Name: JCM Bidder Adapter -Module Type: Bidder Adapter -Maintainer: george@jcartermarketing.com -``` - -# Description - -Module that connects to J Carter Marketing demand sources - -# Test Parameters -``` - var adUnits = [ - { - code: 'test-div1', - sizes: [[300, 250]], // display 300x250 - bids: [ - { - bidder: 'jcm', - params: { - siteId: '3608' - } - } - ] - },{ - code: 'test-div2', - sizes: [[728, 90]], // display 728x90 - bids: [ - { - bidder: 'jcm', - params: { - siteId: '3608' - } - } - ] - } - ]; - diff --git a/modules/jixieBidAdapter.js b/modules/jixieBidAdapter.js index fb55add910f..f6f58883990 100644 --- a/modules/jixieBidAdapter.js +++ b/modules/jixieBidAdapter.js @@ -1,11 +1,11 @@ -import { logWarn, parseUrl, deepAccess, isArray, getDNT } from '../src/utils.js'; -import { config } from '../src/config.js'; -import { registerBidder } from '../src/adapters/bidderFactory.js'; -import { getStorageManager } from '../src/storageManager.js'; -import { BANNER, VIDEO } from '../src/mediaTypes.js'; -import { ajax } from '../src/ajax.js'; -import { getRefererInfo } from '../src/refererDetection.js'; -import { Renderer } from '../src/Renderer.js'; +import {deepAccess, getDNT, isArray, logWarn} from '../src/utils.js'; +import {config} from '../src/config.js'; +import {registerBidder} from '../src/adapters/bidderFactory.js'; +import {getStorageManager} from '../src/storageManager.js'; +import {BANNER, VIDEO} from '../src/mediaTypes.js'; +import {ajax} from '../src/ajax.js'; +import {getRefererInfo} from '../src/refererDetection.js'; +import {Renderer} from '../src/Renderer.js'; import {createEidsArray} from './userId/eids.js'; const BIDDER_CODE = 'jixie'; @@ -28,14 +28,14 @@ function setIds_(clientId, sessionId) { let expC = (new Date(new Date().setFullYear(new Date().getFullYear() + 1))).toUTCString(); let expS = (new Date(new Date().setMinutes(new Date().getMinutes() + sidTTLMins_))).toUTCString(); - storage.setCookie('_jx', clientId, expC, 'None', null); - storage.setCookie('_jx', clientId, expC, 'None', dd); + storage.setCookie('_jxx', clientId, expC, 'None', null); + storage.setCookie('_jxx', clientId, expC, 'None', dd); - storage.setCookie('_jxs', sessionId, expS, 'None', null); - storage.setCookie('_jxs', sessionId, expS, 'None', dd); + storage.setCookie('_jxxs', sessionId, expS, 'None', null); + storage.setCookie('_jxxs', sessionId, expS, 'None', dd); - storage.setDataInLocalStorage('_jx', clientId); - storage.setDataInLocalStorage('_jxs', sessionId); + storage.setDataInLocalStorage('_jxx', clientId); + storage.setDataInLocalStorage('_jxxs', sessionId); } catch (error) {} } @@ -47,14 +47,14 @@ function fetchIds_() { session_id_ls: '' }; try { - let tmp = storage.getCookie('_jx'); + let tmp = storage.getCookie('_jxx'); if (tmp) ret.client_id_c = tmp; - tmp = storage.getCookie('_jxs'); + tmp = storage.getCookie('_jxxs'); if (tmp) ret.session_id_c = tmp; - tmp = storage.getDataFromLocalStorage('_jx'); + tmp = storage.getDataFromLocalStorage('_jxx'); if (tmp) ret.client_id_ls = tmp; - tmp = storage.getDataFromLocalStorage('_jxs'); + tmp = storage.getDataFromLocalStorage('_jxxs'); if (tmp) ret.session_id_ls = tmp; } catch (error) {} return ret; @@ -116,10 +116,12 @@ function getMiscDims_() { mkeywords: '' } try { + // TODO: this should pick refererInfo from bidderRequest let refererInfo_ = getRefererInfo(); - let url_ = ((refererInfo_ && refererInfo_.referer) ? refererInfo_.referer : window.location.href); + // TODO: does the fallback make sense here? + let url_ = refererInfo_?.page || window.location.href ret.pageurl = url_; - ret.domain = parseUrl(url_).host; + ret.domain = refererInfo_?.domain || window.location.host ret.device = getDevice_(); let keywords = document.getElementsByTagName('meta')['keywords']; if (keywords && keywords.content) { diff --git a/modules/justpremiumBidAdapter.js b/modules/justpremiumBidAdapter.js index e2ba92d51d9..7f154614e4d 100644 --- a/modules/justpremiumBidAdapter.js +++ b/modules/justpremiumBidAdapter.js @@ -25,7 +25,8 @@ export const spec = { }).filter((value, index, self) => { return self.indexOf(value) === index }), - referer: bidderRequest.refererInfo.referer, + // TODO: is 'page' the right value here? + referer: bidderRequest.refererInfo.page, sw: dim.screenWidth, sh: dim.screenHeight, ww: dim.innerWidth, diff --git a/modules/jwplayerRtdProvider.js b/modules/jwplayerRtdProvider.js index 6cccd660854..342531ba26e 100644 --- a/modules/jwplayerRtdProvider.js +++ b/modules/jwplayerRtdProvider.js @@ -12,7 +12,7 @@ import {submodule} from '../src/hook.js'; import {config} from '../src/config.js'; import {ajaxBuilder} from '../src/ajax.js'; -import {logError} from '../src/utils.js'; +import {deepAccess, logError} from '../src/utils.js'; import {find} from '../src/polyfill.js'; import {getGlobal} from '../src/prebidGlobal.js'; @@ -130,7 +130,7 @@ function onRequestCompleted(mediaID, success) { function enrichBidRequest(bidReqConfig, onDone) { activeRequestCount = 0; const adUnits = bidReqConfig.adUnits || getGlobal().adUnits; - enrichAdUnits(adUnits); + enrichAdUnits(adUnits, bidReqConfig.ortb2Fragments); if (activeRequestCount <= 0) { onDone(); } else { @@ -142,10 +142,10 @@ function enrichBidRequest(bidReqConfig, onDone) { * get targeting data and write to bids * @function * @param {adUnit[]} adUnits - * @param {function} onDone + * @param ortb2Fragments */ -export function enrichAdUnits(adUnits) { - const fpdFallback = config.getConfig('ortb2.site.ext.data.jwTargeting'); +export function enrichAdUnits(adUnits, ortb2Fragments = {}) { + const fpdFallback = deepAccess(ortb2Fragments.global, 'site.ext.data.jwTargeting'); adUnits.forEach(adUnit => { const jwTargeting = extractPublisherParams(adUnit, fpdFallback); if (!jwTargeting || !Object.keys(jwTargeting).length) { @@ -162,11 +162,7 @@ export function enrichAdUnits(adUnits) { const contentData = getContentData(mediaId, contentSegments); const targeting = formatTargetingResponse(vat); enrichBids(adUnit.bids, targeting, contentId, contentData); - let ortb2 = config.getConfig('ortb2'); - ortb2 = getOrtbSiteContent(ortb2, contentId, contentData); - if (ortb2) { - config.setConfig({ ortb2 }); - } + addOrtbSiteContent(ortb2Fragments.global, contentId, contentData); }; loadVat(jwTargeting, onVatResponse); }); @@ -309,12 +305,12 @@ export function getContentData(mediaId, segments) { return contentData; } -export function getOrtbSiteContent(ortb2, contentId, contentData) { +export function addOrtbSiteContent(ortb2, contentId, contentData) { if (!contentId && !contentData) { return; } - if (!ortb2) { + if (ortb2 == null) { ortb2 = {}; } @@ -345,10 +341,6 @@ function enrichBids(bids, targeting, contentId, contentData) { bids.forEach(bid => { addTargetingToBid(bid, targeting); - const ortb2 = getOrtbSiteContent(bid.ortb2, contentId, contentData); - if (ortb2) { - bid.ortb2 = ortb2; - } }); } diff --git a/modules/kargoAnalyticsAdapter.js b/modules/kargoAnalyticsAdapter.js index 83c20846c0d..652e105167d 100644 --- a/modules/kargoAnalyticsAdapter.js +++ b/modules/kargoAnalyticsAdapter.js @@ -1,14 +1,96 @@ -import adapter from '../src/AnalyticsAdapter.js'; +import { logError } from '../src/utils.js'; +import { ajax } from '../src/ajax.js'; +import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js'; import adapterManager from '../src/adapterManager.js'; +import CONSTANTS from '../src/constants.json'; -var kargoAdapter = adapter({ - analyticsType: 'endpoint', - url: 'https://krk.kargo.com/api/v1/event/prebid' -}); +const EVENT_URL = 'https://krk.kargo.com/api/v1/event'; +const KARGO_BIDDER_CODE = 'kargo'; + +const analyticsType = 'endpoint'; + +let _initOptions = {}; + +let _logBidResponseData = { + auctionId: '', + auctionTimeout: 0, + responseTime: 0, +}; + +let _bidResponseDataLogged = []; + +var kargoAnalyticsAdapter = Object.assign( + adapter({ analyticsType }), { + track({ eventType, args }) { + switch (eventType) { + case CONSTANTS.EVENTS.AUCTION_INIT: { + _logBidResponseData.auctionTimeout = args.timeout; + break; + } + case CONSTANTS.EVENTS.BID_RESPONSE: { + handleBidResponseData(args); + break; + } + } + } + } +); + +// handleBidResponseData: Get auction data for Kargo bids and send to server +function handleBidResponseData (bidResponse) { + // Verify this is Kargo and we haven't seen this auction data yet + if (bidResponse.bidder !== KARGO_BIDDER_CODE || _bidResponseDataLogged.includes(bidResponse.auctionId) !== false) { + return + } + + _logBidResponseData.auctionId = bidResponse.auctionId; + _logBidResponseData.responseTime = bidResponse.timeToRespond; + sendAuctionData(_logBidResponseData); +} + +// sendAuctionData: Send auction data to the server +function sendAuctionData (data) { + try { + _bidResponseDataLogged.push(data.auctionId); + + if (!shouldFireEventRequest()) { + return; + } + + ajax( + `${EVENT_URL}/auction-data`, + null, + { + aid: data.auctionId, + ato: data.auctionTimeout, + rt: data.responseTime, + it: 0, + }, + { + method: 'GET', + } + ); + } catch (err) { + logError('Error sending auction data: ', err); + } +} + +// Sampling rate out of 100 +function shouldFireEventRequest () { + const samplingRate = (_initOptions && _initOptions.sampling) || 100; + return ((Math.floor(Math.random() * 100) + 1) <= parseInt(samplingRate)); +} + +kargoAnalyticsAdapter.originEnableAnalytics = kargoAnalyticsAdapter.enableAnalytics; + +kargoAnalyticsAdapter.enableAnalytics = function (config) { + _initOptions = config.options; + kargoAnalyticsAdapter.originEnableAnalytics(config); +}; adapterManager.registerAnalyticsAdapter({ - adapter: kargoAdapter, + adapter: kargoAnalyticsAdapter, code: 'kargo' }); -export default kargoAdapter; +export default kargoAnalyticsAdapter; diff --git a/modules/kargoAnalyticsAdapter.md b/modules/kargoAnalyticsAdapter.md new file mode 100644 index 00000000000..5a1e538902a --- /dev/null +++ b/modules/kargoAnalyticsAdapter.md @@ -0,0 +1,33 @@ +# Overview + +Module Name: Kargo Analytics Adapter +Module Type: Analytics Adapter +Maintainer: support@kargo.com + +# Description + +Analytics adapter for Kargo. Contact support@kargo.com for information. + +# Usage + +The simplest way to enable the analytics adapter is this + +```javascript +pbjs.enableAnalytics([{ + provider: 'kargo', + options: { + sampling: 100 // value out of 100 + } +}]); +``` + +# Test Parameters + +``` +{ + provider: 'kargo', + options: { + sampling: 100 + } +} +``` \ No newline at end of file diff --git a/modules/kargoBidAdapter.js b/modules/kargoBidAdapter.js index 80b3d83167e..f4563081aa7 100644 --- a/modules/kargoBidAdapter.js +++ b/modules/kargoBidAdapter.js @@ -9,7 +9,7 @@ const HOST = 'https://krk.kargo.com'; const SYNC = 'https://crb.kargo.com/api/v1/initsyncrnd/{UUID}?seed={SEED}&idx={INDEX}&gdpr={GDPR}&gdpr_consent={GDPR_CONSENT}&us_privacy={US_PRIVACY}'; const SYNC_COUNT = 5; const GVLID = 972; -const SUPPORTED_MEDIA_TYPES = [BANNER, VIDEO] +const SUPPORTED_MEDIA_TYPES = [BANNER, VIDEO]; const storage = getStorageManager({gvlid: GVLID, bidderCode: BIDDER_CODE}); let sessionId, @@ -60,7 +60,14 @@ export const spec = { height: window.screen.height }, prebidRawBidRequests: validBidRequests - }, spec._getAllMetadata(tdid, bidderRequest.uspConsent, bidderRequest.gdprConsent)); + }, spec._getAllMetadata(bidderRequest, tdid)); + + // Pull Social Canvas segments and embed URL + if (validBidRequests.length > 0 && validBidRequests[0].params.socialCanvas) { + transformedParams.socialCanvasSegments = validBidRequests[0].params.socialCanvas.segments; + transformedParams.socialEmbedURL = validBidRequests[0].params.socialCanvas.embedURL; + } + const encodedParams = encodeURIComponent(JSON.stringify(transformedParams)); return Object.assign({}, bidderRequest, { method: 'GET', @@ -88,6 +95,7 @@ export const spec = { } const bidResponse = { + ad: adUnit.adm, requestId: bidId, cpm: Number(adUnit.cpm), width: adUnit.width, @@ -103,8 +111,6 @@ export const spec = { if (meta.mediaType == VIDEO) { bidResponse.vastXml = adUnit.adm; - } else { - bidResponse.ad = adUnit.adm; } bidResponses.push(bidResponse); @@ -147,31 +153,9 @@ export const spec = { }); }, - // PRIVATE - _readCookie(name) { - if (!storage.cookiesAreEnabled()) { - return null; - } - let nameEquals = `${name}=`; - let cookies = document.cookie.split(';'); - - for (let i = 0; i < cookies.length; i++) { - let cookie = cookies[i]; - while (cookie.charAt(0) === ' ') { - cookie = cookie.substring(1, cookie.length); - } - - if (cookie.indexOf(nameEquals) === 0) { - return cookie.substring(nameEquals.length, cookie.length); - } - } - - return null; - }, - _getCrbFromCookie() { try { - const crb = JSON.parse(decodeURIComponent(spec._readCookie('krg_crb'))); + const crb = JSON.parse(storage.getCookie('krg_crb')); if (crb && crb.v) { let vParsed = JSON.parse(atob(crb.v)); if (vParsed) { @@ -238,11 +222,11 @@ export const spec = { return crb.clientId; }, - _getAllMetadata(tdid, usp, gdpr) { + _getAllMetadata(bidderRequest, tdid) { return { - userIDs: spec._getUserIds(tdid, usp, gdpr), - pageURL: window.location.href, - rawCRB: spec._readCookie('krg_crb'), + userIDs: spec._getUserIds(tdid, bidderRequest.uspConsent, bidderRequest.gdprConsent), + pageURL: bidderRequest.refererInfo && bidderRequest.refererInfo.page, + rawCRB: storage.getCookie('krg_crb'), rawCRBLocalStorage: spec._getLocalStorageSafely('krg_crb') }; }, diff --git a/modules/koblerBidAdapter.js b/modules/koblerBidAdapter.js index 5fc28c47ac5..1dc22d0099a 100644 --- a/modules/koblerBidAdapter.js +++ b/modules/koblerBidAdapter.js @@ -102,21 +102,23 @@ export const onTimeout = function (timeoutDataArray) { } }; -function getPageUrlFromRefererInfo() { - const refererInfo = getRefererInfo(); - return (refererInfo && refererInfo.referer) - ? refererInfo.referer - : window.location.href; -} - function getPageUrlFromRequest(validBidRequest, bidderRequest) { // pageUrl is considered only when testing to ensure that non-test requests always contain the correct URL if (isTest(validBidRequest) && config.getConfig('pageUrl')) { + // TODO: it's not clear what the intent is here - but all adapters should always respect pageUrl. + // With prebid 7, using `refererInfo.page` will do that automatically. return config.getConfig('pageUrl'); } - return (bidderRequest.refererInfo && bidderRequest.refererInfo.referer) - ? bidderRequest.refererInfo.referer + return (bidderRequest.refererInfo && bidderRequest.refererInfo.page) + ? bidderRequest.refererInfo.page + : window.location.href; +} + +function getPageUrlFromRefererInfo() { + const refererInfo = getRefererInfo(); + return (refererInfo && refererInfo.page) + ? refererInfo.page : window.location.href; } diff --git a/modules/komoonaBidAdapter.md b/modules/komoonaBidAdapter.md deleted file mode 100644 index 6f88c19dfa6..00000000000 --- a/modules/komoonaBidAdapter.md +++ /dev/null @@ -1,29 +0,0 @@ -# Overview - -**Module Name**: Komoona Bidder Adapter -**Module Type**: Bidder Adapter -**Maintainer**: support@komoona.com - -# Description - -Connects to Komoona demand source to fetch bids. - -# Test Parameters -``` - var adUnits = [{ - code: 'banner-ad-div', - sizes: [[300, 250]], - - // Replace this object to test a new Adapter! - bids: [{ - bidder: 'komoona', - params: { - placementId: 'e69148e0ba6c4c07977dc2daae5e1577', - hbid: '1f5b2c10e66e419580bd943b9af692ab', - floorPrice: 0.5 - } - }] - }]; -``` - - diff --git a/modules/konduitAnalyticsAdapter.js b/modules/konduitAnalyticsAdapter.js index f8a44d7cc94..a1a586b25db 100644 --- a/modules/konduitAnalyticsAdapter.js +++ b/modules/konduitAnalyticsAdapter.js @@ -1,6 +1,6 @@ import { parseSizesInput, logError, uniques } from '../src/utils.js'; import { ajax } from '../src/ajax.js'; -import adapter from '../src/AnalyticsAdapter.js'; +import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js'; import adapterManager from '../src/adapterManager.js'; import { targeting } from '../src/targeting.js'; import { config } from '../src/config.js'; diff --git a/modules/krushmediaBidAdapter.js b/modules/krushmediaBidAdapter.js index da68bddcb7b..876f0ebabc6 100644 --- a/modules/krushmediaBidAdapter.js +++ b/modules/krushmediaBidAdapter.js @@ -1,6 +1,7 @@ import { isFn, deepAccess, logMessage } from '../src/utils.js'; import {registerBidder} from '../src/adapters/bidderFactory.js'; import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js'; +import { convertOrtbRequestToProprietaryNative } from '../src/native.js'; const BIDDER_CODE = 'krushmedia'; const AD_URL = 'https://ads4.krushmedia.com/?c=rtb&m=hb'; @@ -49,10 +50,14 @@ export const spec = { }, buildRequests: (validBidRequests = [], bidderRequest) => { + // convert Native ORTB definition to old-style prebid native definition + validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests); + let winTop = window; let location; + // TODO: this odd try-catch block was copied in several adapters; it doesn't seem to be correct for cross-origin try { - location = new URL(bidderRequest.refererInfo.referer) + location = new URL(bidderRequest.refererInfo.page); winTop = window.top; } catch (e) { location = winTop.location; @@ -75,7 +80,7 @@ export const spec = { request.ccpa = bidderRequest.uspConsent; } if (bidderRequest.gdprConsent) { - request.gdpr = bidderRequest.gdprConsent + request.gdpr = bidderRequest.gdprConsent; } } diff --git a/modules/kubientBidAdapter.js b/modules/kubientBidAdapter.js index 46360572576..57cbe6acd07 100644 --- a/modules/kubientBidAdapter.js +++ b/modules/kubientBidAdapter.js @@ -67,8 +67,9 @@ export const spec = { data.coppa = 1 } - if (bidderRequest.refererInfo && bidderRequest.refererInfo.referer) { - data.referer = bidderRequest.refererInfo.referer + if (bidderRequest?.refererInfo?.page) { + // TODO: is 'page' the right value here? + data.referer = bidderRequest.refererInfo.page } if (bidderRequest.gdprConsent && bidderRequest.gdprConsent.consentString) { @@ -151,15 +152,7 @@ function encodeQueryData(data) { function kubientGetConsentGiven(gdprConsent) { let consentGiven = 0; if (typeof gdprConsent !== 'undefined') { - let apiVersion = deepAccess(gdprConsent, `apiVersion`); - switch (apiVersion) { - case 1: - consentGiven = deepAccess(gdprConsent, `vendorData.vendorConsents.${VENDOR_ID}`) ? 1 : 0; - break; - case 2: - consentGiven = deepAccess(gdprConsent, `vendorData.vendor.consents.${VENDOR_ID}`) ? 1 : 0; - break; - } + consentGiven = deepAccess(gdprConsent, `vendorData.vendor.consents.${VENDOR_ID}`) ? 1 : 0; } return consentGiven; } diff --git a/modules/kueezBidAdapter.js b/modules/kueezBidAdapter.js new file mode 100644 index 00000000000..24d339d1938 --- /dev/null +++ b/modules/kueezBidAdapter.js @@ -0,0 +1,471 @@ +import { logWarn, logInfo, isArray, isFn, deepAccess, isEmpty, contains, timestamp, getBidIdParameter, triggerPixel, isInteger } from '../src/utils.js'; +import { registerBidder } from '../src/adapters/bidderFactory.js'; +import { BANNER, VIDEO } from '../src/mediaTypes.js'; +import { config } from '../src/config.js'; + +const BIDDER_ENDPOINT = 'https://hb.kueezssp.com/hb-kz-multi'; +const BIDDER_TEST_ENDPOINT = 'https://hb.kueezssp.com/hb-multi-kz-test' +const BIDDER_CODE = 'kueez'; +const MAIN_CURRENCY = 'USD'; +const MEDIA_TYPES = [BANNER, VIDEO]; +const TTL = 420; +const VERSION = '1.0.0'; +const SUPPORTED_SYNC_METHODS = { + IFRAME: 'iframe', + PIXEL: 'pixel' +} + +export const spec = { + code: BIDDER_CODE, + version: VERSION, + supportedMediaTypes: MEDIA_TYPES, + isBidRequestValid: function (bidRequest) { + return validateParams(bidRequest); + }, + buildRequests: function (validBidRequests, bidderRequest) { + const [ sharedParams ] = validBidRequests; + const testMode = sharedParams.params.testMode; + const bidsToSend = prepareBids(validBidRequests, sharedParams, bidderRequest); + + return { + method: 'POST', + url: getBidderEndpoint(testMode), + data: bidsToSend + } + }, + interpretResponse: function ({body}) { + const bidResponses = body?.bids; + + if (!bidResponses || !bidResponses.length) { + return []; + } + + return parseBidResponses(bidResponses); + }, + getUserSyncs: function (syncOptions, serverResponses) { + const syncs = []; + for (const response of serverResponses) { + if (syncOptions.pixelEnabled && isArray(response.body.params.userSyncPixels)) { + const pixels = response.body.params.userSyncPixels.map(pixel => { + return { + type: 'image', + url: pixel + } + }) + syncs.push(...pixels) + } + if (syncOptions.iframeEnabled && response.body.params.userSyncURL) { + syncs.push({ + type: 'iframe', + url: response.body.params.userSyncURL + }); + } + } + return syncs; + }, + onBidWon: function (bid) { + if (bid == null) { + return; + } + + logInfo('onBidWon:', bid); + if (bid.hasOwnProperty('nurl') && bid.nurl.length > 0) { + triggerPixel(bid.nurl); + } + } +}; + +registerBidder(spec); + +/** + * Get schain string value + * @param schainObject {Object} + * @returns {string} + */ +function getSupplyChain(schainObject) { + if (isEmpty(schainObject)) { + return ''; + } + let scStr = `${schainObject.ver},${schainObject.complete}`; + schainObject.nodes.forEach((node) => { + scStr += '!'; + scStr += `${getEncodedValIfNotEmpty(node.asi)},`; + scStr += `${getEncodedValIfNotEmpty(node.sid)},`; + scStr += `${node.hp ? encodeURIComponent(node.hp) : ''},`; + scStr += `${getEncodedValIfNotEmpty(node.rid)},`; + scStr += `${getEncodedValIfNotEmpty(node.name)},`; + scStr += `${getEncodedValIfNotEmpty(node.domain)}`; + }); + return scStr; +} + +/** + * Get the encoded value + * @param val {string} + * @returns {string} + */ +function getEncodedValIfNotEmpty(val) { + return !isEmpty(val) ? encodeURIComponent(val) : ''; +} + +/** + * get device type + * @returns {string} + */ +function getDeviceType() { + const ua = navigator.userAgent; + if (/ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle/i + .test(ua.toLowerCase())) { + return '5'; + } + if (/iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i + .test(ua.toLowerCase())) { + return '4'; + } + if (/smart[-_\s]?tv|hbbtv|appletv|googletv|hdmi|netcast|viera|nettv|roku|\bdtv\b|sonydtv|inettvbrowser|\btv\b/i + .test(ua.toLowerCase())) { + return '3'; + } + return '1'; +} + +/** + * Get floor price + * @param bid {bid} + * @param mediaType {string} + * @returns {Number} + */ +function getFloorPrice(bid, mediaType) { + let floor = 0; + + if (isFn(bid.getFloor)) { + let floorResult = bid.getFloor({ + currency: MAIN_CURRENCY, + mediaType: mediaType, + size: '*' + }); + floor = floorResult.currency === MAIN_CURRENCY && floorResult.floor ? floorResult.floor : 0; + } + + return floor; +} + +/** + * Get the ad sizes array from the bid + * @param bid {bid} + * @param mediaType {string} + * @returns {Array} + */ +function getSizesArray(bid, mediaType) { + let sizes = [] + + if (deepAccess(bid, `mediaTypes.${mediaType}.sizes`)) { + sizes = bid.mediaTypes[mediaType].sizes; + } else if (Array.isArray(bid.sizes) && bid.sizes.length > 0) { + sizes = bid.sizes; + } + + return sizes; +} + +/** + * Get the preferred user-sync method + * @param filterSettings {filterSettings} + * @param bidderCode {string} + * @returns {string} + */ +function getSyncMethod(filterSettings, bidderCode) { + const iframeConfigs = ['all', 'iframe']; + const pixelConfig = 'image'; + if (filterSettings && iframeConfigs.some(config => isSyncMethodAllowed(filterSettings[config], bidderCode))) { + return SUPPORTED_SYNC_METHODS.IFRAME; + } + if (!filterSettings || !filterSettings[pixelConfig] || isSyncMethodAllowed(filterSettings[pixelConfig], bidderCode)) { + return SUPPORTED_SYNC_METHODS.PIXEL; + } +} + +/** + * Check sync rule support + * @param filterSetting {Object} + * @param bidderCode {string} + * @returns {boolean} + */ +function isSyncMethodAllowed(filterSetting, bidderCode) { + if (!filterSetting) { + return false; + } + const bidders = isArray(filterSetting.bidders) ? filterSetting.bidders : [bidderCode]; + return filterSetting.filter === 'include' && contains(bidders, bidderCode); +} + +/** + * Get the bidder endpoint + * @param testMode {boolean} + * @returns {string} + */ +function getBidderEndpoint(testMode) { + return testMode ? BIDDER_TEST_ENDPOINT : BIDDER_ENDPOINT; +} + +/** + * Generates the bidder parameters + * @param validBidRequests {Array} + * @param bidderRequest {bidderRequest} + * @returns {Array} + */ +function generateBidParams(validBidRequests, bidderRequest) { + const bidsArray = []; + + if (validBidRequests.length) { + validBidRequests.forEach(bid => { + bidsArray.push(generateBidParameters(bid, bidderRequest)); + }); + } + + return bidsArray; +} + +/** + * Generate bid specific parameters + * @param bid {bid} + * @param bidderRequest {bidderRequest} + * @returns {Object} bid specific params object + */ +function generateBidParameters(bid, bidderRequest) { + const {params} = bid; + const mediaType = isBanner(bid) ? BANNER : VIDEO; + const sizesArray = getSizesArray(bid, mediaType); + const gpid = deepAccess(bid, `ortb2Imp.ext.gpid`); + const pos = deepAccess(bid, `mediaTypes.${mediaType}.pos`); + const placementId = params.placementId || deepAccess(bid, `mediaTypes.${mediaType}.name`); + const paramsFloorPrice = isNaN(params.floorPrice) ? 0 : params.floorPrice; + + const bidObject = { + adUnitCode: getBidIdParameter('adUnitCode', bid), + bidId: getBidIdParameter('bidId', bid), + loop: getBidIdParameter('bidderRequestsCount', bid), + bidderRequestId: getBidIdParameter('bidderRequestId', bid), + floorPrice: Math.max(getFloorPrice(bid, mediaType), paramsFloorPrice), + mediaType, + sizes: sizesArray, + transactionId: getBidIdParameter('transactionId', bid) + }; + + if (pos) { + bidObject.pos = pos; + } + + if (gpid) { + bidObject.gpid = gpid; + } + + if (placementId) { + bidObject.placementId = placementId; + } + + if (mediaType === VIDEO) { + populateVideoParams(bidObject, bid); + } + + return bidObject; +} + +/** + * Checks if the media type is a banner + * @param bid {bid} + * @returns {boolean} + */ +function isBanner(bid) { + return bid.mediaTypes && bid.mediaTypes.banner; +} + +/** + * Generate params that are common between all bids + * @param sharedParams {sharedParams} + * @param bidderRequest {bidderRequest} + * @returns {object} the common params object + */ +function generateSharedParams(sharedParams, bidderRequest) { + const {bidderCode} = bidderRequest; + const {syncEnabled, filterSettings} = config.getConfig('userSync') || {}; + const domain = window.location.hostname; + const generalBidParams = getBidIdParameter('params', sharedParams); + const userIds = getBidIdParameter('userId', sharedParams); + const ortb2Metadata = bidderRequest.ortb2 || {}; + const timeout = config.getConfig('bidderTimeout'); + + const params = { + adapter_version: VERSION, + auction_start: timestamp(), + device_type: getDeviceType(), + dnt: (navigator.doNotTrack === 'yes' || navigator.doNotTrack === '1' || navigator.msDoNotTrack === '1') ? 1 : 0, + publisher_id: generalBidParams.org, + publisher_name: domain, + session_id: getBidIdParameter('auctionId', sharedParams), + site_domain: domain, + tmax: timeout, + ua: navigator.userAgent, + wrapper_type: 'prebidjs', + wrapper_vendor: '$$PREBID_GLOBAL$$', + wrapper_version: '$prebid.version$' + }; + + if (syncEnabled) { + const allowedSyncMethod = getSyncMethod(filterSettings, bidderCode); + if (allowedSyncMethod) { + params.cs_method = allowedSyncMethod; + } + } + + if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) { + params.gdpr = bidderRequest.gdprConsent.gdprApplies; + params.gdpr_consent = bidderRequest.gdprConsent.consentString; + } + + if (bidderRequest.uspConsent) { + params.us_privacy = bidderRequest.uspConsent; + } + + if (generalBidParams.ifa) { + params.ifa = generalBidParams.ifa; + } + + if (ortb2Metadata.site) { + params.site_metadata = JSON.stringify(ortb2Metadata.site); + } + + if (ortb2Metadata.user) { + params.user_metadata = JSON.stringify(ortb2Metadata.user); + } + + if (bidderRequest && bidderRequest.refererInfo) { + params.referrer = deepAccess(bidderRequest, 'refererInfo.ref'); + params.page_url = deepAccess(bidderRequest, 'refererInfo.page') || deepAccess(window, 'location.href'); + } + + if (sharedParams.schain) { + params.schain = getSupplyChain(sharedParams.schain); + } + + if (userIds) { + params.userIds = JSON.stringify(userIds); + } + + return params; +} + +/** + * Validates the bidder params + * @param bidRequest {bidRequest} + * @returns {boolean} + */ +function validateParams(bidRequest) { + let isValid = true; + + if (!bidRequest.params) { + logWarn('Kueez adapter - missing params'); + isValid = false; + } + + if (!bidRequest.params.org) { + logWarn('Kueez adapter - org is a required param'); + isValid = false; + } + + return isValid; +} + +/** + * Validates the bidder params + * @param validBidRequests {Array} + * @param sharedParams {sharedParams} + * @param bidderRequest {bidderRequest} + * @returns {Object} + */ +function prepareBids(validBidRequests, sharedParams, bidderRequest) { + return { + params: generateSharedParams(sharedParams, bidderRequest), + bids: generateBidParams(validBidRequests, bidderRequest) + } +} + +function getPlaybackMethod(bid) { + const playbackMethod = deepAccess(bid, `mediaTypes.video.playbackmethod`); + + if (Array.isArray(playbackMethod) && isInteger(playbackMethod[0])) { + return playbackMethod[0]; + } else if (isInteger(playbackMethod)) { + return playbackMethod; + } +} + +function populateVideoParams(params, bid) { + const linearity = deepAccess(bid, `mediaTypes.video.linearity`); + const maxDuration = deepAccess(bid, `mediaTypes.video.maxduration`); + const minDuration = deepAccess(bid, `mediaTypes.video.minduration`); + const placement = deepAccess(bid, `mediaTypes.video.placement`); + const playbackMethod = getPlaybackMethod(bid); + const skip = deepAccess(bid, `mediaTypes.video.skip`); + + if (linearity) { + params.linearity = linearity; + } + + if (maxDuration) { + params.maxDuration = maxDuration; + } + + if (minDuration) { + params.minDuration = minDuration; + } + + if (placement) { + params.placement = placement; + } + + if (playbackMethod) { + params.playbackMethod = playbackMethod; + } + + if (skip) { + params.skip = skip; + } +} + +/** + * Processes the bid responses + * @param bids {Array} + * @returns {Array} + */ +function parseBidResponses(bids) { + return bids.map(bid => { + const bidResponse = { + cpm: bid.cpm, + creativeId: bid.requestId, + currency: bid.currency || MAIN_CURRENCY, + height: bid.height, + mediaType: bid.mediaType, + meta: { + mediaType: bid.mediaType + }, + netRevenue: bid.netRevenue || true, + nurl: bid.nurl, + requestId: bid.requestId, + ttl: bid.ttl || TTL, + width: bid.width + }; + + if (bid.adomain && bid.adomain.length) { + bidResponse.meta.advertiserDomains = bid.adomain; + } + + if (bid.mediaType === VIDEO) { + bidResponse.vastXml = bid.vastXml; + } else if (bid.mediaType === BANNER) { + bidResponse.ad = bid.ad; + } + + return bidResponse; + }); +} diff --git a/modules/kueezBidAdapter.md b/modules/kueezBidAdapter.md new file mode 100644 index 00000000000..8b17e40f503 --- /dev/null +++ b/modules/kueezBidAdapter.md @@ -0,0 +1,73 @@ +#Overview + +Module Name: Kueez Bidder Adapter + +Module Type: Bidder Adapter + +Maintainer: prebid@kueez.com + +# Description + +The Kueez adapter requires setup and approval from the Kueez team. Please reach out to prebid@kueez.com for more information. + +The adapter supports Banner and Video(instream) media types. + +# Bid Parameters + +## Video + +| Name | Scope | Type | Description | Example +|---------------| ----- | ---- |-------------------------------------------------------------------| ------- +| `org` | required | String | the organization Id provided by your Kueez representative | "test-publisher-id" +| `floorPrice` | optional | Number | Minimum price in USD. Misuse of this parameter can impact revenue | 1.50 +| `placementId` | optional | String | A unique placement identifier | "12345678" +| `testMode` | optional | Boolean | This activates the test mode | false + +# Test Parameters + +```javascript +var adUnits = [{ + code: 'banner-div', + mediaTypes: { + banner: { + sizes: [ + [300, 250], + [728, 90] + ] + } + }, + bids: [{ + bidder: 'kueez', + params: { + org: 'test-org-id', // Required + floorPrice: 0.2, // Optional + placementId: '12345678', // Optional + testMode: true // Optional + } + }] +}, + { + code: 'dfp-video-div', + sizes: [ + [640, 480] + ], + mediaTypes: { + video: { + playerSize: [ + [640, 480] + ], + context: 'instream' + } + }, + bids: [{ + bidder: 'kueez', + params: { + org: 'test-org-id', // Required + floorPrice: 1.50, // Optional + placementId: '12345678', // Optional + testMode: true // Optional + } + }] + } +]; +``` diff --git a/modules/kummaBidAdapter.md b/modules/kummaBidAdapter.md deleted file mode 100644 index 639e0c97d08..00000000000 --- a/modules/kummaBidAdapter.md +++ /dev/null @@ -1,87 +0,0 @@ -# Overview - -**Module Name**: Kumma Bidder Adapter -**Module Type**: Bidder Adapter -**Maintainer**: yehonatan@kumma.com - -# Description - -Connects to Kumma demand source to fetch bids. -Banner, Native, Video formats are supported. -Please use ```kumma``` as the bidder code. - -# Test Parameters -``` - var adUnits = [{ - code: 'dfp-native-div', - mediaType: 'native', - mediaTypes: { - native: { - title: { - required: true, - len: 75 - }, - image: { - required: true - }, - body: { - len: 200 - }, - icon: { - required: false - } - } - }, - bids: [{ - bidder: 'kumma', - params: { - pubId: '29521', - siteId: '26047', - placementId: '123', - bidFloor: '0.001', // optional - ifa: 'XXX-XXX', // optional - latitude: '40.712775', // optional - longitude: '-74.005973', // optional - } - }] - }, - { - code: 'dfp-banner-div', - mediaTypes: { - banner: { - sizes: [ - [300, 250] - ], - } - }, - bids: [{ - bidder: 'kumma', - params: { - pubId: '29521', - siteId: '26049', - placementId: '123', - } - }] - }, - { - code: 'dfp-video-div', - sizes: [640, 480], - mediaTypes: { - video: { - context: "instream" - } - }, - bids: [{ - bidder: 'kumma', - params: { - pubId: '29521', - siteId: '26049', - placementId: '123', - video: { - skipppable: true, - } - } - }] - } - ]; -``` diff --git a/modules/lassoBidAdapter.js b/modules/lassoBidAdapter.js new file mode 100644 index 00000000000..da48bc460c7 --- /dev/null +++ b/modules/lassoBidAdapter.js @@ -0,0 +1,133 @@ +import { registerBidder } from '../src/adapters/bidderFactory.js'; +import { BANNER } from '../src/mediaTypes.js'; +import { getStorageManager } from '../src/storageManager.js'; +import { ajax } from '../src/ajax.js'; +import { config } from '../src/config.js'; + +const BIDDER_CODE = 'lasso'; +const ENDPOINT_URL = 'https://trc.lhmos.com/prebid'; +const GET_IUD_URL = 'https://secure.adnxs.com/getuid?'; +const COOKIE_NAME = 'aim-xr'; +const storage = getStorageManager({bidderCode: BIDDER_CODE}); + +export const spec = { + code: BIDDER_CODE, + isBidRequestValid: function(bid) { + return !!(bid.params && bid.params.adUnitId); + }, + + buildRequests: function(validBidRequests, bidderRequest) { + if (validBidRequests.length === 0) { + return []; + } + + let aimXR = ''; + if (storage.cookiesAreEnabled) { + aimXR = storage.getCookie(COOKIE_NAME, undefined); + } + + return validBidRequests.map(bidRequest => { + let sizes = [] + if (bidRequest.mediaTypes && bidRequest.mediaTypes[BANNER] && bidRequest.mediaTypes[BANNER].sizes) { + sizes = bidRequest.mediaTypes[BANNER].sizes; + } + + const payload = { + auctionStart: bidderRequest.auctionStart, + url: encodeURIComponent(window.location.href), + bidderRequestId: bidRequest.bidderRequestId, + adUnitCode: bidRequest.adUnitCode, + auctionId: bidRequest.auctionId, + bidId: bidRequest.bidId, + transactionId: bidRequest.transactionId, + device: JSON.stringify(getDeviceData()), + sizes, + aimXR, + uid: '$UID', + params: JSON.stringify(bidRequest.params), + crumbs: JSON.stringify(bidRequest.crumbs), + prebidVersion: '$prebid.version$', + version: 2, + coppa: config.getConfig('coppa') == true ? 1 : 0, + ccpa: bidderRequest.uspConsent || undefined + } + + return { + method: 'GET', + url: getBidRequestUrl(aimXR), + data: payload, + options: { + withCredentials: true + }, + }; + }); + }, + + interpretResponse: function(serverResponse) { + const response = serverResponse && serverResponse.body; + const bidResponses = []; + + if (!response || !response.bid.ad) { + return bidResponses; + } + + const bidResponse = { + requestId: response.bidid, + cpm: response.bid.price, + currency: response.cur, + width: response.bid.w, + height: response.bid.h, + creativeId: response.bid.crid, + netRevenue: response.netRevenue, + ttl: response.ttl, + ad: response.bid.ad, + mediaType: response.bid.mediaType, + meta: { + secondaryCatIds: response.bid.cat, + advertiserDomains: response.bid.advertiserDomains, + advertiserName: response.meta.advertiserName, + mediaType: response.bid.mediaType + } + }; + bidResponses.push(bidResponse); + return bidResponses; + }, + + onTimeout: function(timeoutData) { + if (timeoutData === null) { + return; + } + ajax(ENDPOINT_URL + '/timeout', null, JSON.stringify(timeoutData), { + method: 'POST', + withCredentials: false + }); + }, + + onBidWon: function(bid) { + ajax(ENDPOINT_URL + '/won', null, JSON.stringify(bid), { + method: 'POST', + withCredentials: false + }); + }, + + supportedMediaTypes: [BANNER] +} + +function getBidRequestUrl(aimXR) { + if (!aimXR) { + return GET_IUD_URL + ENDPOINT_URL + '/request'; + } + return ENDPOINT_URL + '/request' +} + +function getDeviceData() { + const win = window.top; + return { + ua: navigator.userAgent, + width: win.innerWidth || win.document.documentElement.clientWidth || win.document.body.clientWidth, + height: win.innerHeight || win.document.documentElement.clientHeight || win.document.body.clientHeight, + browserLanguage: navigator.language, + } +} + +registerBidder(spec); diff --git a/modules/lassoBidAdapter.md b/modules/lassoBidAdapter.md new file mode 100644 index 00000000000..43927fe890c --- /dev/null +++ b/modules/lassoBidAdapter.md @@ -0,0 +1,29 @@ +# Overview + +**Module Name**: Lasso Bidder Adapter +**Module Type**: Bidder Adapter +**Maintainer**: headerbidding@lassomarketing.io + +# Description + +Connects to Lasso demand source to fetch bids. +Only banner format supported. + +# Test Parameters + +``` +var adUnits = [{ + code: 'banner-ad-unit', + mediaTypes: { + banner: { + sizes: [[300, 250]], + } + }, + bids: [{ + bidder: 'lasso', + params: { + adUnitId: '0' + } + }] +}]; +``` diff --git a/modules/lemmaBidAdapter.md b/modules/lemmaBidAdapter.md deleted file mode 100644 index 29e72e028b9..00000000000 --- a/modules/lemmaBidAdapter.md +++ /dev/null @@ -1,66 +0,0 @@ -# Overview - -``` -Module Name: Lemma Bid Adapter -Module Type: Bidder Adapter -Maintainer: lemmadev@lemmatechnologies.com -``` - -# Description - -Connects to Lemma exchange for bids. -Lemma bid adapter supports Video, Banner formats. - -# Sample Banner Ad Unit: For Publishers -``` -var adUnits = [{ - code: 'div-lemma-ad-1', - mediaTypes: { - banner: { - sizes: [[300, 250], [300, 600]], // required - } - }, - // Replace this object to test a new Adapter! - bids: [{ - bidder: 'lemma', - params: { - pubId: 1, // required - adunitId: '3768', // required - latitude: 37.3230, - longitude: -122.0322, - device_type: 2, - banner: { - w: 300, - h: 250 - } - } - }] -}]; -``` - -# Sample Video Ad Unit: For Publishers -``` -var adUnits = [{ - mediaType: 'video', - mediaTypes: { - video: { - playerSize: [640, 480], // required - context: 'instream' - } - }, - // Replace this object to test a new Adapter! - bids: [{ - bidder: 'lemma', - params: { - pubId: 1, // required - adunitId: '3769', // required - latitude: 37.3230, - longitude: -122.0322, - device_type: 4, - video: { - mimes: ['video/mp4','video/x-flv'], // required - } - } - }] -}]; -``` diff --git a/modules/lifestreetBidAdapter.js b/modules/lifestreetBidAdapter.js new file mode 100644 index 00000000000..6a8b783ce21 --- /dev/null +++ b/modules/lifestreetBidAdapter.js @@ -0,0 +1,143 @@ +import { isInteger } from '../src/utils.js'; +import { registerBidder } from '../src/adapters/bidderFactory.js'; +import { BANNER, VIDEO } from '../src/mediaTypes.js'; + +const BIDDER_CODE = 'lifestreet'; +const ADAPTER_VERSION = '$prebid.version$'; + +const urlTemplate = template`https://ads.lfstmedia.com/gate/${'adapter'}/${'slot'}?adkey=${'adkey'}&ad_size=${'ad_size'}&__location=${'location'}&__referrer=${'referrer'}&__wn=${'wn'}&__sf=${'sf'}&__fif=${'fif'}&__if=${'if'}&__stamp=${'stamp'}&__pp=1&__hb=1&_prebid_json=1&__gz=1&deferred_format=vast_2_0,vast_3_0&__hbver=${'hbver'}`; + +/** + * A helper function for template to generate string from boolean + */ +function boolToString(value) { + return value ? '1' : '0'; +} + +/** + * A helper function to form URL from the template + */ +function template(strings, ...keys) { + return function(...values) { + let dict = values[values.length - 1] || {}; + let result = [strings[0]]; + keys.forEach(function(key, i) { + let value = isInteger(key) ? values[key] : dict[key]; + result.push(value, strings[i + 1]); + }); + return result.join(''); + }; +} + +/** + * Creates a bid requests for a given bid. + * + * @param {BidRequest} bid The bid params to use for formatting a request + */ +function formatBidRequest(bid, bidderRequest = {}) { + const {params} = bid; + const {referer} = (bidderRequest.refererInfo || {}); + let url = urlTemplate({ + adapter: 'prebid', + slot: params.slot, + adkey: params.adkey, + ad_size: params.ad_size, + location: referer, + referrer: referer, + wn: boolToString(/fb_http/i.test(window.name)), + sf: boolToString(window['sfAPI'] || window['$sf']), + fif: boolToString(window['inDapIF'] === true), + if: boolToString(window !== window.top), + stamp: new Date().getTime(), + hbver: ADAPTER_VERSION + }); + + if (bidderRequest.gdprConsent) { + if (bidderRequest.gdprConsent.gdprApplies !== undefined) { + const gdpr = '&__gdpr=' + (bidderRequest.gdprConsent.gdprApplies ? '1' : '0'); + url += gdpr; + } + if (bidderRequest.gdprConsent.consentString !== undefined) { + url += `&__consent=${bidderRequest.gdprConsent.consentString}`; + } + } + + // ccpa support + if (bidderRequest.uspConsent) { + url += `&__us_privacy=${bidderRequest.uspConsent}` + } + + return { + method: 'GET', + url: url, + bidId: bid.bidId + }; +} + +function isResponseValid(response) { + return !/^\s*\{\s*"advertisementAvailable"\s*:\s*false/i.test(response.content) && + response.content.indexOf('
-### Requirements: -To be able to get identification key (`pid`), please contact us at
-`https://www.nanointeractive.com/publishers`
-
- -#### Send All Bids Ad Server Keys: -(truncated to 20 chars due to [DFP limit](https://support.google.com/dfp_premium/answer/1628457?hl=en#Key-values)) - -`hb_adid_nanointeract` -`hb_bidder_nanointera` -`hb_pb_nanointeractiv` -`hb_format_nanointera` -`hb_size_nanointeract` -`hb_source_nanointera` - -#### Default Deal ID Keys: -`hb_deal_nanointeract` - -### bid params - -{: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | -| :------------- | :------- | :----------------------------------------------- | :--------------------------- | -| `pid` | required | Identification key, provided by Nano Interactive | `'5afaa0280ae8996eb578de53'` | -| `category` | optional | Contextual taxonomy | `'automotive'` | -| `categoryName` | optional | Contextual taxonomy (from URL query param) | `'cat_name'` | -| `nq` | optional | User search query | `'automobile search query'` | -| `name` | optional | User search query (from URL query param) | `'search_param'` | -| `subId` | optional | Channel - used to separate traffic sources | `'123'` | - -#### Configuration -The `category` and `categoryName` are mutually exclusive. If you pass both, `categoryName` takes precedence. -
-The `nq` and `name` are mutually exclusive. If you pass both, `name` takes precedence. - -#### Example with only required field `pid` - var adUnits = [{ - code: 'nano-div', - sizes: [[300, 250], [300,600]], - bids: [{ - bidder: 'nanointeractive', - params: { - pid: '5afaa0280ae8996eb578de53' - } - }] - }]; - -#### Example with `category` - var adUnits = [{ - code: 'nano-div', - sizes: [[300, 250], [300,600]], - bids: [{ - bidder: 'nanointeractive', - params: { - pid: '5afaa0280ae8996eb578de53', - category: 'automotive', - subId: '123' - } - }] - }]; - -#### Example with `categoryName` - var adUnits = [{ - code: 'nano-div', - sizes: [[300, 250], [300,600]], - bids: [{ - bidder: 'nanointeractive', - params: { - pid: '5afaa0280ae8996eb578de53', - // Category "automotive" is in the URL like: - // https://www....?cat_name=automotive&... - categoryName: 'cat_name', - subId: '123' - } - }] - }]; - -#### Example with `nq` - var adUnits = [{ - code: 'nano-div', - sizes: [[300, 250], [300,600]], - bids: [{ - bidder: 'nanointeractive', - params: { - pid: '5afaa0280ae8996eb578de53', - // User searched "automobile search query" (extracted from search text field) - nq: 'automobile search query', - subId: '123' - } - }] - }]; - -#### Example with `name` - var adUnits = [{ - code: 'nano-div', - sizes: [[300, 250], [300,600]], - bids: [{ - bidder: 'nanointeractive', - params: { - pid: '5afaa0280ae8996eb578de53', - // User searched "automobile search query" and it is in the URL like: - // https://www....?search_param=automobile%20search%20query&... - name: 'search_param', - subId: '123' - } - }] - }]; - -#### Example with `category` and `nq` - var adUnits = [{ - code: 'nano-div', - sizes: [[300, 250], [300,600]], - bids: [{ - bidder: 'nanointeractive', - params: { - pid: '5afaa0280ae8996eb578de53', - category: 'automotive', - nq: 'automobile search query', - subId: '123' - } - }] - }]; - -#### Example with `categoryName` and `name` - var adUnits = [{ - code: 'nano-div', - sizes: [[300, 250], [300,600]], - bids: [{ - bidder: 'nanointeractive', - params: { - pid: '5afaa0280ae8996eb578de53', - categoryName: 'cat_name', - name: 'search_param', - subId: '123' - } - }] - }]; \ No newline at end of file diff --git a/modules/nasmediaAdmixerBidAdapter.md b/modules/nasmediaAdmixerBidAdapter.md deleted file mode 100644 index 096acf27f61..00000000000 --- a/modules/nasmediaAdmixerBidAdapter.md +++ /dev/null @@ -1,36 +0,0 @@ -# Overview - -``` -Module Name: NasmediaAdmixer Bidder Adapter -Module Type: Bidder Adapter -Maintainer: prebid@nasmedia.co.kr -``` -`` -# Description - -Module that connects to NasmediaAdmixer demand sources. -Banner formats are supported. -The NasmediaAdmixer adapter doesn't support multiple sizes per ad-unit and will use the first one if multiple sizes are defined. - -# Test Parameters -``` - var adUnits = [ - { - code: 'banner-ad-div', - mediaTypes: { - banner: { // banner size - sizes: [[300, 250]] - } - }, - bids: [ - { - bidder: 'nasmediaAdmixer', - params: { - media_key: '19038695', //required - adunit_id: '24190632', //required - } - } - ] - } - ]; -``` diff --git a/modules/nativoBidAdapter.js b/modules/nativoBidAdapter.js index e07a124665f..54c99b17834 100644 --- a/modules/nativoBidAdapter.js +++ b/modules/nativoBidAdapter.js @@ -11,12 +11,14 @@ const GVLID = 263 const TIME_TO_LIVE = 360 const SUPPORTED_AD_TYPES = [BANNER] +const FLOOR_PRICE_CURRENCY = 'USD' +const PRICE_FLOOR_WILDCARD = '*' /** * Keep track of bid data by keys * @returns {Object} - Map of bid data that can be referenced by multiple keys */ -const BidDataMap = () => { +export const BidDataMap = () => { const referenceMap = {} const bids = [] @@ -25,7 +27,7 @@ const BidDataMap = () => { * @param {String} key - The key to store the index reference * @param {Integer} index - The index value of the bidData */ - function adKeyReference(key, index) { + function addKeyReference(key, index) { if (!referenceMap.hasOwnProperty(key)) { referenceMap[key] = index } @@ -42,12 +44,12 @@ const BidDataMap = () => { if (Array.isArray(keys)) { keys.forEach((key) => { - adKeyReference(String(key), index) + addKeyReference(String(key), index) }) return } - adKeyReference(String(keys), index) + addKeyReference(String(keys), index) } /** @@ -131,72 +133,106 @@ export const spec = { * @return ServerRequest Info describing the request to the server. */ buildRequests: function (validBidRequests, bidderRequest) { + // Parse values from bid requests const placementIds = new Set() - let placementId, pageUrl const bidDataMap = BidDataMap() - validBidRequests.forEach((request) => { + const placementSizes = { length: 0 } + const floorPriceData = {} + let placementId, pageUrl + validBidRequests.forEach((bidRequest) => { pageUrl = deepAccess( - request, + bidRequest, 'params.url', - bidderRequest.refererInfo.referer ) - placementId = deepAccess(request, 'params.placementId') + if (pageUrl == undefined || pageUrl === '') { + pageUrl = bidderRequest.refererInfo.page + } + + placementId = deepAccess(bidRequest, 'params.placementId') - if (placementId) { + const bidDataKeys = [bidRequest.adUnitCode] + + if (placementId && !placementIds.has(placementId)) { placementIds.add(placementId) + bidDataKeys.push(placementId) + + placementSizes[placementId] = bidRequest.sizes + placementSizes.length++ } const bidData = { - bidId: request.bidId, - size: getLargestSize(request.sizes), + bidId: bidRequest.bidId, + size: getLargestSize(bidRequest.sizes), + } + bidDataMap.addBidData(bidData, bidDataKeys) + + const bidRequestFloorPriceData = parseFloorPriceData(bidRequest) + if (bidRequestFloorPriceData) { + floorPriceData[bidRequest.adUnitCode] = bidRequestFloorPriceData } - bidDataMap.addBidData(bidData, [placementId, request.adUnitCode]) }) bidRequestMap[bidderRequest.bidderRequestId] = bidDataMap // Build adUnit data - const adUnitData = { - adUnits: validBidRequests.map((adUnit) => { - // Track if we've already requested for this ad unit code - adUnitsRequested[adUnit.adUnitCode] = - adUnitsRequested[adUnit.adUnitCode] !== undefined - ? adUnitsRequested[adUnit.adUnitCode] + 1 - : 0 - return { - adUnitCode: adUnit.adUnitCode, - mediaTypes: adUnit.mediaTypes, - } - }), - } + const adUnitData = buildAdUnitData(validBidRequests) - // Build QS Params + // Build basic required QS Params let params = [ + // Prebid request id { key: 'ntv_pb_rid', value: bidderRequest.bidderRequestId }, + // Ad unit data { key: 'ntv_ppc', value: btoa(JSON.stringify(adUnitData)), // Convert to Base 64 }, + // Number count of requests per ad unit { key: 'ntv_dbr', - value: btoa(JSON.stringify(adUnitsRequested)), + value: btoa(JSON.stringify(adUnitsRequested)), // Convert to Base 64 }, + // Page url { key: 'ntv_url', value: encodeURIComponent(pageUrl), }, ] + // Floor pricing + if (Object.keys(floorPriceData).length) { + params.unshift({ + key: 'ntv_ppf', + value: btoa(JSON.stringify(floorPriceData)), + }) + } + // Add filtering if (adsToFilter.size > 0) { - params.unshift({ key: 'ntv_atf', value: Array.from(adsToFilter).join(',') }) + params.unshift({ + key: 'ntv_atf', + value: Array.from(adsToFilter).join(','), + }) } if (advertisersToFilter.size > 0) { - params.unshift({ key: 'ntv_avtf', value: Array.from(advertisersToFilter).join(',') }) + params.unshift({ + key: 'ntv_avtf', + value: Array.from(advertisersToFilter).join(','), + }) } if (campaignsToFilter.size > 0) { - params.unshift({ key: 'ntv_ctf', value: Array.from(campaignsToFilter).join(',') }) + params.unshift({ + key: 'ntv_ctf', + value: Array.from(campaignsToFilter).join(','), + }) + } + + // Placement Sizes + if (placementSizes.length) { + params.unshift({ + key: 'ntv_pas', + value: btoa(JSON.stringify(placementSizes)), + }) } // Add placement IDs @@ -417,6 +453,126 @@ export const spec = { registerBidder(spec) // Utils +export function parseFloorPriceData(bidRequest) { + if (typeof bidRequest.getFloor !== 'function') return + + // Setup price floor data per bid request + let bidRequestFloorPriceData = {} + let bidMediaTypes = bidRequest.mediaTypes + let sizeOptions = new Set() + // Step through meach media type so we can get floor data for each media type per bid request + Object.keys(bidMediaTypes).forEach((mediaType) => { + // Setup price floor data per media type + let mediaTypeData = bidMediaTypes[mediaType] + let mediaTypeFloorPriceData = {} + // Step through each size of the media type so we can get floor data for each size per media type + mediaTypeData.sizes.forEach((size) => { + // Get floor price data per the getFloor method and respective media type / size combination + const priceFloorData = bidRequest.getFloor({ + currency: FLOOR_PRICE_CURRENCY, + mediaType, + size, + }) + // Save the data and track the sizes + mediaTypeFloorPriceData[sizeToString(size)] = priceFloorData.floor + sizeOptions.add(size) + }) + bidRequestFloorPriceData[mediaType] = mediaTypeFloorPriceData + + // Get floor price of current media type with a wildcard size + const sizeWildcardFloor = getSizeWildcardPrice(bidRequest, mediaType) + // Save the wildcard floor price if it was retrieved successfully + if (sizeWildcardFloor.floor > 0) { + mediaTypeFloorPriceData['*'] = sizeWildcardFloor.floor + } + }) + + // Get floor price for wildcard media type using all of the sizes present in the previous media types + const mediaWildCardPrices = getMediaWildcardPrices(bidRequest, [ + PRICE_FLOOR_WILDCARD, + ...Array.from(sizeOptions), + ]) + bidRequestFloorPriceData['*'] = mediaWildCardPrices + + return bidRequestFloorPriceData +} + +/** + * Get price floor data by always setting the size value to the wildcard for a specific size + * @param {Object} bidRequest - The bid request + * @param {String} mediaType - The media type + * @returns {Object} - Bid floor data + */ +export function getSizeWildcardPrice(bidRequest, mediaType) { + return bidRequest.getFloor({ + currency: FLOOR_PRICE_CURRENCY, + mediaType, + size: PRICE_FLOOR_WILDCARD, + }) +} + +/** + * Get price data for a range of sizes and always setting the media type to the wildcard value + * @param {*} bidRequest - The bid request + * @param {*} sizes - The sizes to get the floor price data for + * @returns {Object} - Bid floor data + */ +export function getMediaWildcardPrices( + bidRequest, + sizes = [PRICE_FLOOR_WILDCARD] +) { + const sizePrices = {} + sizes.forEach((size) => { + // MODIFY the bid request's mediaTypes property (so we can get the wildcard media type value) + const temp = bidRequest.mediaTypes + bidRequest.mediaTypes = { PRICE_FLOOR_WILDCARD: temp.sizes } + // Get price floor data + const priceFloorData = bidRequest.getFloor({ + currency: FLOOR_PRICE_CURRENCY, + mediaType: PRICE_FLOOR_WILDCARD, + size, + }) + // RESTORE initial property value + bidRequest.mediaTypes = temp + + // Only save valid floor price data + const key = + size !== PRICE_FLOOR_WILDCARD ? sizeToString(size) : PRICE_FLOOR_WILDCARD + sizePrices[key] = priceFloorData.floor + }) + return sizePrices +} + +/** + * Format size array to a string + * @param {Array} size - Size data [width, height] + * @returns {String} - Formated size string + */ +export function sizeToString(size) { + if (!Array.isArray(size) || size.length < 2) return '' + return `${size[0]}x${size[1]}` +} + +/** + * Build the ad unit data to send back to the request endpoint + * @param {Array