prebid.js 5.16.0 → 5.20.0

package/modules/codefuelBidAdapter.md

@@ -0,0 +1,111 @@
+# Overview
+
+```
+Module Name: Codefuel Adapter
+Module Type: Bidder Adapter
+Maintainer: hayimm@codefuel.com
+```
+
+# Description
+
+Module that connects to Codefuel bidder to fetch bids.
+Display format is supported but not native format. Using OpenRTB standard.
+
+# Configuration
+
+## Bidder and usersync URLs
+
+The Codefuel adapter does not work without setting the correct bidder.
+You will receive the URLs when contacting us.
+
+```
+pbjs.setConfig({
+    codefuel: {
+      bidderUrl: 'https://ai-i-codefuel-ds-rtb-us-east-1-k8s-internal.seccint.com/prebid',
+      usersyncUrl: 'https://usersync-url.com'
+    }
+});
+```
+
+
+# Test Native Parameters
+```
+    var adUnits = [
+        code: '/19968336/prebid_native_example_1',
+        mediaTypes: {
+            native: {
+                image: {
+                    required: false,
+                    sizes: [100, 50]
+                },
+                title: {
+                    required: false,
+                    len: 140
+                },
+                sponsoredBy: {
+                    required: false
+                },
+                clickUrl: {
+                    required: false
+                },
+                body: {
+                    required: false
+                },
+                icon: {
+                    required: false,
+                    sizes: [50, 50]
+                }
+            }
+        },
+        bids: [{
+            bidder: 'codefuel',
+            params: {
+                publisher: {
+                  id: '2706', // required
+                  name: 'Publishers Name',
+                  domain: 'publisher.com'
+                },
+                tagid: 'tag-id',
+                bcat: ['IAB1-1'],
+                badv: ['example.com']
+            }
+        }]
+    ];
+
+    pbjs.setConfig({
+        codefuel: {
+          bidderUrl: 'https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/'
+        }
+    });
+```
+
+# Test Display Parameters
+```
+    var adUnits = [
+        code: '/19968336/prebid_display_example_1',
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250]]
+          }
+        },
+        bids: [{
+            bidder: 'codefuel',
+            params: {
+                publisher: {
+                  id: '2706', // required
+                  name: 'Publishers Name',
+                  domain: 'publisher.com'
+                },
+                tagid: 'tag-id',
+                bcat: ['IAB1-1'],
+                badv: ['example.com']
+            },
+        }]
+    ];
+
+    pbjs.setConfig({
+        codefuel: {
+          bidderUrl: 'https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/'
+        }
+    });
+```

package/modules/connectIdSystem.js

@@ -0,0 +1,104 @@
+/**
+ * This module adds support for Yahoo ConnectID to the user ID module system.
+ * The {@link module:modules/userId} module is required
+ * @module modules/connectIdSystem
+ * @requires module:modules/userId
+ */
+
+import {ajax} from '../src/ajax.js';
+import {submodule} from '../src/hook.js';
+import {logError, formatQS} from '../src/utils.js';
+import includes from 'core-js-pure/features/array/includes.js';
+
+const MODULE_NAME = 'connectId';
+const VENDOR_ID = 25;
+const PLACEHOLDER = '__PIXEL_ID__';
+const UPS_ENDPOINT = `https://ups.analytics.yahoo.com/ups/${PLACEHOLDER}/fed`;
+
+function isEUConsentRequired(consentData) {
+  return !!(consentData && consentData.gdpr && consentData.gdpr.gdprApplies);
+}
+
+/** @type {Submodule} */
+export const connectIdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+  /**
+   * @type {Number}
+   */
+  gvlid: VENDOR_ID,
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @returns {{connectId: string} | undefined}
+   */
+  decode(value) {
+    return (typeof value === 'object' && value.connectid)
+      ? {connectId: value.connectid} : undefined;
+  },
+  /**
+   * Gets the Yahoo ConnectID
+   * @function
+   * @param {SubmoduleConfig} [config]
+   * @param {ConsentData} [consentData]
+   * @returns {IdResponse|undefined}
+   */
+  getId(config, consentData) {
+    const params = config.params || {};
+    if (!params || typeof params.he !== 'string' ||
+      (typeof params.pixelId === 'undefined' && typeof params.endpoint === 'undefined')) {
+      logError('The connectId submodule requires the \'he\' and \'pixelId\' parameters to be defined.');
+      return;
+    }
+
+    const data = {
+      '1p': includes([1, '1', true], params['1p']) ? '1' : '0',
+      he: params.he,
+      gdpr: isEUConsentRequired(consentData) ? '1' : '0',
+      gdpr_consent: isEUConsentRequired(consentData) ? consentData.gdpr.consentString : '',
+      us_privacy: consentData && consentData.uspConsent ? consentData.uspConsent : ''
+    };
+
+    if (params.pixelId) {
+      data.pixelId = params.pixelId
+    }
+
+    const resp = function (callback) {
+      const callbacks = {
+        success: response => {
+          let responseObj;
+          if (response) {
+            try {
+              responseObj = JSON.parse(response);
+            } catch (error) {
+              logError(error);
+            }
+          }
+          callback(responseObj);
+        },
+        error: error => {
+          logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+          callback();
+        }
+      };
+      const endpoint = UPS_ENDPOINT.replace(PLACEHOLDER, params.pixelId);
+      let url = `${params.endpoint || endpoint}?${formatQS(data)}`;
+      connectIdSubmodule.getAjaxFn()(url, callbacks, null, {method: 'GET', withCredentials: true});
+    };
+    return {callback: resp};
+  },
+
+  /**
+   * Return the function used to perform XHR calls.
+   * Utilised for each of testing.
+   * @returns {Function}
+   */
+  getAjaxFn() {
+    return ajax;
+  }
+};
+
+submodule('userId', connectIdSubmodule);

package/modules/connectIdSystem.md

@@ -0,0 +1,33 @@
+## Yahoo ConnectID User ID Submodule
+
+Yahoo ConnectID user ID Module.
+
+### Prebid Params
+
+```
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: 'connectId',
+            storage: {
+                name: 'connectId',
+                type: 'html5',
+                expires: 15
+            },
+            params: {
+                pixelId: 58776,
+                he: '0bef996248d63cea1529cb86de31e9547a712d9f380146e98bbd39beec70355a'
+            }
+        }]
+    }
+});
+```
+## Parameter Descriptions for the `usersync` Configuration Section
+The below parameters apply only to the Yahoo ConnectID user ID Module.
+
+| Param under usersync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | ID value for the Yahoo ConnectID module - `"connectId"` | `"connectId"` |
+| params | Required | Object | Data for Yahoo ConnectID initialization. | |
+| params.pixelId | Required | Number | The Yahoo supplied publisher specific pixel Id  | `8976` |
+| params.he | Required | String | The SHA-256 hashed user email address | `"529cb86de31e9547a712d9f380146e98bbd39beec"` |

package/modules/cwireBidAdapter.js

@@ -0,0 +1,272 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import { getRefererInfo } from '../src/refererDetection.js';
+import { getStorageManager } from '../src/storageManager.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import { OUTSTREAM } from '../src/video.js';
+import {
+  isArray,
+  isNumber,
+  generateUUID,
+  parseSizesInput,
+  deepAccess,
+  getParameterByName,
+  getValue,
+  getBidIdParameter,
+  logError,
+  logWarn,
+} from '../src/utils.js';
+import { Renderer } from '../src/Renderer.js';
+import find from 'core-js-pure/features/array/find.js';
+
+// ------------------------------------
+const BIDDER_CODE = 'cwire';
+export const ENDPOINT_URL = 'https://embed.cwi.re/delivery/prebid';
+export const RENDERER_URL = 'https://cdn.cwi.re/prebid/renderer/LATEST/renderer.min.js';
+// ------------------------------------
+export const CW_PAGE_VIEW_ID = generateUUID();
+const LS_CWID_KEY = 'cw_cwid';
+const CW_GROUPS_QUERY = 'cwgroups';
+
+const storage = getStorageManager();
+
+/**
+ * ------------------------------------
+ * ------------------------------------
+ * @param bid
+ * @returns {Array<string>}
+ */
+export function getSlotSizes(bid) {
+  return parseSizesInput(getAllMediaSizes(bid));
+}
+
+/**
+ * ------------------------------------
+ * ------------------------------------
+ * @param bid
+ * @returns {*[]}
+ */
+export function getAllMediaSizes(bid) {
+  let playerSizes = deepAccess(bid, 'mediaTypes.video.playerSize');
+  let videoSizes = deepAccess(bid, 'mediaTypes.video.sizes');
+  let bannerSizes = deepAccess(bid, 'mediaTypes.banner.sizes');
+
+  const sizes = [];
+
+  if (isArray(playerSizes)) {
+    playerSizes.forEach((s) => {
+      sizes.push(s);
+    })
+  }
+
+  if (isArray(videoSizes)) {
+    videoSizes.forEach((s) => {
+      sizes.push(s);
+    })
+  }
+
+  if (isArray(bannerSizes)) {
+    bannerSizes.forEach((s) => {
+      sizes.push(s);
+    })
+  }
+  return sizes;
+}
+
+const getQueryVariable = (variable) => {
+  let value = getParameterByName(variable);
+  if (value === '') {
+    value = null;
+  }
+  return value;
+};
+
+/**
+ * ------------------------------------
+ * ------------------------------------
+ * @param validBidRequests
+ * @returns {*[]}
+ */
+export const mapSlotsData = function(validBidRequests) {
+  const slots = [];
+  validBidRequests.forEach(bid => {
+    const bidObj = {};
+    // get the pacement and page ids
+    let placementId = getValue(bid.params, 'placementId');
+    let pageId = getValue(bid.params, 'pageId');
+    let adUnitElementId = getValue(bid.params, 'adUnitElementId');
+    // get the rest of the auction/bid/transaction info
+    bidObj.auctionId = getBidIdParameter('auctionId', bid);
+    bidObj.adUnitCode = getBidIdParameter('adUnitCode', bid);
+    bidObj.adUnitElementId = adUnitElementId;
+    bidObj.bidId = getBidIdParameter('bidId', bid);
+    bidObj.bidderRequestId = getBidIdParameter('bidderRequestId', bid);
+    bidObj.placementId = placementId;
+    bidObj.pageId = pageId;
+    bidObj.mediaTypes = getBidIdParameter('mediaTypes', bid);
+    bidObj.transactionId = getBidIdParameter('transactionId', bid);
+    bidObj.sizes = getSlotSizes(bid);
+    slots.push(bidObj);
+  });
+
+  return slots;
+};
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO],
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {BidRequest} bid The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: function(bid) {
+    bid.params = bid.params || {};
+
+    // if ad unit elemt id not provided - use adUnitCode by default
+    if (!bid.params.adUnitElementId) {
+      bid.params.adUnitElementId = bid.code;
+    }
+
+    if (!bid.params.placementId || !isNumber(bid.params.placementId)) {
+      logError('placementId not provided or invalid');
+      return false;
+    }
+
+    if (!bid.params.pageId || !isNumber(bid.params.pageId)) {
+      logError('pageId not provided');
+      return false;
+    }
+
+    return true;
+  },
+
+  /**
+   * ------------------------------------
+   * Make a server request from the
+   * list of BidRequests.
+   * ------------------------------------
+   * @param {validBidRequests[]} - an array of bids
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function(validBidRequests, bidderRequest) {
+    let slots = [];
+    let referer;
+    try {
+      referer = getRefererInfo().referer;
+      slots = mapSlotsData(validBidRequests);
+    } catch (e) {
+      logWarn(e);
+    }
+
+    let refgroups = [];
+
+    const rgQuery = getQueryVariable(CW_GROUPS_QUERY);
+    if (rgQuery !== null) {
+      refgroups = rgQuery.split(',');
+    }
+
+    const localStorageCWID = storage.localStorageIsEnabled() ? storage.getDataFromLocalStorage(LS_CWID_KEY) : null;
+
+    const payload = {
+      cwid: localStorageCWID,
+      refgroups,
+      slots: slots,
+      httpRef: referer || '',
+      pageViewId: CW_PAGE_VIEW_ID,
+    };
+
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: payload
+    };
+  },
+
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {ServerResponse} serverResponse A successful response from the server.
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function(serverResponse, bidRequest) {
+    const bidResponses = [];
+
+    try {
+      if (typeof bidRequest.data === 'string') {
+        bidRequest.data = JSON.parse(bidRequest.data);
+      }
+      const serverBody = serverResponse.body;
+      serverBody.bids.forEach((br) => {
+        const bidReq = find(bidRequest.data.slots, bid => bid.bidId === br.requestId);
+
+        let mediaType = BANNER;
+
+        const bidResponse = {
+          requestId: br.requestId,
+          cpm: br.cpm,
+          bidderCode: BIDDER_CODE,
+          width: br.dimensions[0],
+          height: br.dimensions[1],
+          creativeId: br.creativeId,
+          currency: br.currency,
+          netRevenue: br.netRevenue,
+          ttl: br.ttl,
+          meta: {
+            advertiserDomains: br.adomains ? br.advertiserDomains : [],
+          },
+
+        };
+
+        // ------------------------------------
+        // IF BANNER
+        // ------------------------------------
+
+        if (deepAccess(bidReq, 'mediaTypes.banner')) {
+          bidResponse.ad = br.html;
+        }
+        // ------------------------------------
+        // IF VIDEO
+        // ------------------------------------
+        if (deepAccess(bidReq, 'mediaTypes.video')) {
+          mediaType = VIDEO;
+          bidResponse.vastXml = br.vastXml;
+          bidResponse.videoScript = br.html;
+          const mediaTypeContext = deepAccess(bidReq, 'mediaTypes.video.context');
+          if (mediaTypeContext === OUTSTREAM) {
+            const r = Renderer.install({
+              id: bidResponse.requestId,
+              adUnitCode: bidReq.adUnitCode,
+              url: RENDERER_URL,
+              loaded: false,
+              config: {
+                ...deepAccess(bidReq, 'mediaTypes.video'),
+                ...deepAccess(br, 'outstream', {})
+              }
+            });
+
+            // set renderer
+            try {
+              bidResponse.renderer = r;
+              bidResponse.renderer.setRender(function(bid) {
+                if (window.CWIRE && window.CWIRE.outstream) {
+                  window.CWIRE.outstream.renderAd(bid);
+                }
+              });
+            } catch (err) {
+              logWarn('Prebid Error calling setRender on newRenderer', err);
+            }
+          }
+        }
+
+        bidResponse.mediaType = mediaType;
+        bidResponses.push(bidResponse);
+      });
+    } catch (e) {
+      logWarn(e);
+    }
+
+    return bidResponses;
+  },
+}
+registerBidder(spec);

package/modules/cwireBidAdapter.md

@@ -0,0 +1,43 @@
+# Overview
+
+Module Name: C-WIRE Bid Adapter
+Module Type: Adagio Adapter
+Maintainer: dragan@cwire.ch
+
+## Description
+
+Connects to C-WIRE demand source to fetch bids.
+
+## Configuration
+
+
+Below, the list of C-WIRE params and where they can be set.
+
+| Param name | Global config | AdUnit config | Type | Required |
+| ---------- | ------------- | ------------- | ---- | ---------|
+| pageId |  | x | number | YES |
+| placementId |  | x | number | YES |
+| adUnitElementId |  | x | string | NO |
+
+### adUnit configuration
+
+```javascript
+var adUnits = [
+  {
+    code: 'target_div_id', // REQUIRED 
+    bids: [{
+      bidder: 'cwire',
+      mediaTypes: {
+        banner: {
+          sizes: [[1, 1]],
+        }
+      },
+      params: {
+        pageId: 1422,                 // required - number
+        placementId: 2211521,         // required - number
+        adUnitElementId: 'other_div', // optional, div id to write to, if not set it will default to ad unit code  
+      }
+    }]
+  }
+];
+```