prebid.js 10.2.0 → 10.4.0

package/modules/rumbleBidAdapter.js

@@ -0,0 +1,128 @@
+import { registerBidder } from "../src/adapters/bidderFactory.js";
+import { BANNER, VIDEO } from "../src/mediaTypes.js";
+import { config } from "../src/config.js";
+import { ortbConverter } from "../libraries/ortbConverter/converter.js";
+import {
+  deepSetValue,
+  deepAccess,
+  getBidIdParameter,
+  logError,
+  logWarn,
+  triggerPixel,
+  replaceAuctionPrice
+} from "../src/utils.js";
+
+const BIDDER_CODE = 'rumble';
+const ENDPOINT = 'https://a.ads.rmbl.ws/v1/sites/:id/ortb';
+const VERSION = '1.0.0';
+
+function fillParameters(bid) {
+  const global = config.getConfig('rumble') || {};
+
+  bid.params = bid.params || {};
+
+  [
+    'publisherId',
+    'siteId',
+    'test',
+  ].forEach(function(k) {
+    if (bid.params[k]) {
+      return;
+    }
+
+    if (global[k]) {
+      bid.params[k] = global[k];
+    }
+  })
+
+  return bid.params;
+}
+
+export const converter = ortbConverter({
+  context: {
+    netRevenue: true,
+    ttl: 60,
+    currency: "USD"
+  },
+  request(buildRequest, imps, bidderRequest, context) {
+    const request = buildRequest(imps, bidderRequest, context);
+    const params = fillParameters(bidderRequest?.bids[0])
+
+    if (params?.test) {
+      deepSetValue(request, 'test', 1)
+    }
+
+    deepSetValue(request, 'ext.adapter', {
+      version: VERSION,
+      name: 'prebidjs'
+    })
+
+    return request;
+  }
+})
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO],
+
+  isBidRequestValid: function (bid) {
+    fillParameters(bid)
+
+    if (bid && typeof bid.params !== 'object') {
+      logError(BIDDER_CODE + ': params is not defined or is incorrect in the bidder settings.');
+      return false;
+    }
+
+    const required = ['publisherId', 'siteId'];
+
+    for (let i = 0; i < required.length; i++) {
+      if (!getBidIdParameter(required[i], bid.params)) {
+        logError(BIDDER_CODE + `: ${required[i]} must be set as a bidder parameter`);
+        return false;
+      }
+    }
+
+    const banner = deepAccess(bid, `mediaTypes.banner`);
+    const video = deepAccess(bid, `mediaTypes.video`);
+
+    if (!banner && !video) {
+      logWarn(BIDDER_CODE + ': either banner or video mediaType must be provided')
+      return false;
+    }
+
+    return true;
+  },
+  buildRequests: function(bidRequests, bidderRequest) {
+    const publisherId = bidRequests[0].params.publisherId;
+    const siteId = bidRequests[0].params.siteId;
+    const zoneId = bidRequests[0].params.zoneId;
+    let endpoint = ENDPOINT.replace(':id', siteId) + "?pid=" + publisherId;
+
+    if (zoneId) {
+      endpoint += "&a=" + zoneId;
+    }
+
+    return bidRequests.map(bid => {
+      return {
+        url: endpoint,
+        method: 'POST',
+        data: converter.toORTB({bidRequests: [bid], bidderRequest}),
+        bidRequest: bid,
+      };
+    })
+  },
+  interpretResponse(response, request) {
+    return converter.fromORTB({response: response.body, request: request.data}).bids;
+  },
+  onBidWon: function(bid) {
+    if (bid.burl) {
+      triggerPixel(replaceAuctionPrice(bid.burl, bid.originalCpm || bid.cpm));
+    }
+
+    if (bid.nurl) {
+      triggerPixel(replaceAuctionPrice(bid.nurl, bid.originalCpm || bid.cpm));
+    }
+  },
+};
+
+registerBidder(spec);

package/modules/rumbleBidAdapter.md

@@ -0,0 +1,114 @@
+# Overview
+
+    Module Name: Rumble Bidder Adapter
+    Module Type: Bidder Adapter
+    Maintainer: adtech@rumble.com
+
+## Description
+
+Connects to Rumble Advertising Center (`RAC` for short) for bids.
+
+## Configuration
+
+### Parameters
+Rumble requires multiple parameters. These parameters may be set globally or per each ad unit.
+
+| Parameter   | Global | AdUnit | Description                                        |
+|-------------|--------|--------|----------------------------------------------------|
+| publisherId | x      | x      | Your RAC account publisher ID                      |
+| siteId      | x      | x      | The site ID you want to send requests              |                      
+| zoneId      |        | x      | An optional zone ID that you want to send requests |
+| test        | x      | x      | An optional boolean flag for sending test requests |
+
+#### Global Configuration
+
+The global configuration is used to set parameters across all ad units instead of individually.
+
+```javascript
+pbjs.setConfig({
+    rumble: {
+        publisherId: 1,
+        siteId: 2,
+    }
+})
+```
+
+#### Ad-unit configuration
+
+All global configuration may be overridden by ad-unit configuration in addition to adding ad-unit only parameters.
+
+```javascript
+let adUnits = [
+    {
+        code: 'test-div',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]],
+            }
+        },
+        bids: [
+            {
+                bidder: "rumble",
+                params: {
+                    publisherId: 1,
+                    siteId: 1,
+                    zoneId: 1, // optional
+                }
+            }
+        ]
+    }
+];
+```
+
+## Test Parameters
+
+
+### Sample Display Ad Unit
+```javascript
+let adUnits = [
+    {
+        code: 'test-div',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]],
+            }
+        },
+        bids: [
+            {
+                bidder: "rumble",
+                params: {
+                    publisherId: 1,
+                    siteId: 1,
+                    zoneId: 1, // optional
+                    test: true // only while testing
+                }
+            }
+        ]
+    }
+]
+```
+
+### Sample Video Ad Unit
+```javascript
+let adUnits = [
+    {
+        code: 'test-div',
+        mediaTypes: {
+            video: {
+                mimes: ['video/mp4'],
+            }
+        },
+        bids: [
+            {
+                bidder: "rumble",
+                params: {
+                    publisherId: 1,
+                    siteId: 1,
+                    zoneId: 1, // optional
+                    test: true // only while testing
+                }
+            }
+        ]
+    }
+]
+```

package/modules/schain.ts

@@ -4,13 +4,13 @@ import {normalizeFPD} from '../src/fpd/normalize.js';
 import type {ORTBRequest} from "../src/types/ortb/request";
 
 export type SchainConfig = {
-    config: ORTBRequest['source']['schain'];
+  config: ORTBRequest['source']['schain'];
 }
 
 declare module '../src/config' {
-    interface Config {
-        schain?: SchainConfig;
-    }
+  interface Config {
+    schain?: SchainConfig;
+  }
 }
 
 export function applySchainConfig(ortb2Fragments) {

package/modules/sevioBidAdapter.js

@@ -0,0 +1,262 @@
+import * as utils from "../src/utils.js";
+import { detectWalletsPresence} from "../libraries/cryptoUtils/wallets.js";
+import { registerBidder } from "../src/adapters/bidderFactory.js";
+import { BANNER, NATIVE } from "../src/mediaTypes.js";
+import { config } from "../src/config.js";
+
+const BIDDER_CODE = "sevio";
+const GVLID = `1393`;
+const ENDPOINT_URL = "https://req.adx.ws/prebid";
+const ACTION_METHOD = "POST";
+
+const detectAdType = (bid) =>
+  (
+    ["native", "banner"].find((t) => bid.mediaTypes?.[t]) || "unknown"
+  ).toUpperCase();
+
+const parseNativeAd = function (bid) {
+  try {
+    const nativeAd = JSON.parse(bid.ad);
+    const native = {};
+
+    nativeAd.assets?.forEach(asset => {
+      if (asset.title?.text) {
+        native.title = asset.title.text;
+      }
+      if (asset.data) {
+        const value = asset.data.value;
+        switch (asset.data.type) {
+          case 1: if (value) native.sponsoredBy = value; break;
+          case 2: if (value) native.body = value; break;
+          case 3: if (value) native.rating = value; break;
+          case 4: if (value) native.likes = value; break;
+          case 5: if (value) native.downloads = value; break;
+          case 6: if (value) native.price = value; break;
+          case 7: if (value) native.salePrice = value; break;
+          case 8: if (value) native.phone = value; break;
+          case 9: if (value) native.address = value; break;
+          case 10: if (value) native.body2 = value; break;
+          case 11: if (value) native.displayUrl = value; break;
+          case 12: if (value) native.cta = value; break;
+          default: break;
+        }
+      }
+      if (asset.img) {
+        const { url, w = 0, h = 0, type } = asset.img;
+
+        if (type === 1 && url) {
+          native.icon = url;
+          native.icon_width = w;
+          native.icon_height = h;
+        } else if (type === 3 && url) {
+          native.image = url;
+          native.image_width = w;
+          native.image_height = h;
+        }
+      }
+    });
+
+    if (nativeAd.link?.url) {
+      native.clickUrl = nativeAd.link.url;
+    }
+
+    const eventTrackers = nativeAd.eventtrackers || [];
+
+    const impressionTrackers = eventTrackers
+      .filter(tracker => tracker.event === 1)
+      .map(tracker => tracker.url)
+      .filter(Boolean);
+
+    const viewableTrackers = eventTrackers
+      .filter(tracker => tracker.event === 2)
+      .map(tracker => tracker.url)
+      .filter(Boolean);
+
+    if (impressionTrackers.length) {
+      native.impressionTrackers = impressionTrackers;
+    }
+
+    if (viewableTrackers.length) {
+      native.viewableTrackers = viewableTrackers; // custom field
+    }
+
+    if (Array.isArray(nativeAd.link?.clicktrackers) && nativeAd.link.clicktrackers.length > 0) {
+      native.clickTrackers = nativeAd.link.clicktrackers;
+    }
+
+    if (nativeAd.privacy?.url) native.privacyLink = nativeAd.privacy.url;
+    if (nativeAd.privacy?.icon) native.privacyIcon = nativeAd.privacy.icon;
+
+    return native;
+  } catch (e) {
+    utils.logWarn('Invalid native JSON', e);
+    return null;
+  }
+}
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  isBidRequestValid: function (bid) {
+    if (!bid) {
+      utils.logWarn(BIDDER_CODE, "Invalid bid", bid);
+
+      return false;
+    }
+
+    if (!bid.params) {
+      utils.logWarn(BIDDER_CODE, "bid.params is required");
+
+      return false;
+    }
+
+    if (!bid.params.zone) {
+      utils.logWarn(BIDDER_CODE, "bid.params.zone is required");
+
+      return false;
+    }
+
+    return true;
+  },
+
+  buildRequests: function (bidRequests, bidderRequest) {
+    const userSyncEnabled = config.getConfig("userSync.syncEnabled");
+
+    if (bidRequests.length === 0) {
+      return [];
+    }
+    const gdpr = bidderRequest.gdprConsent;
+    const usp = bidderRequest.uspConsent;
+    const gpp = bidderRequest.gppConsent;
+    const hasWallet = detectWalletsPresence();
+
+    return bidRequests.map((bidRequest) => {
+      const isNative = detectAdType(bidRequest)?.toLowerCase() === 'native';
+      const size = bidRequest.mediaTypes?.banner?.sizes[0] || bidRequest.mediaTypes?.native?.sizes[0] || [];
+      const width = size[0];
+      const height = size[1];
+      const originalAssets = bidRequest.mediaTypes?.native?.ortb?.assets || [];
+      // convert icon to img type 1
+      const processedAssets = originalAssets.map(asset => {
+        if (asset.icon) {
+          return {
+            id: asset.id,
+            required: asset.required || 0,
+            img: {
+              type: 1,
+              w: asset.icon.w,
+              h: asset.icon.h,
+            }
+          };
+        }
+        return asset;
+      });
+      const payload = {
+        bidId: bidRequest.bidId,
+        referrer: window.document.referrer,
+        gdpr: gdpr?.gdprApplies === true ? 1 : 0,
+        userAgent: navigator.userAgent,
+        language: navigator.language,
+        pageUrl: bidRequest?.refererInfo?.page,
+        pageDomain: bidRequest?.refererInfo?.referer,
+        topframe: bidderRequest?.refererInfo?.reachedTop,
+        timestamp: Date.now(),
+        sizes: bidRequest.sizes,
+        mediaTypes: bidRequest.mediaTypes,
+        userId: bidRequest.userId,
+        eids: (bidRequest.userIdAsEids || []).map(eid => ({
+          source: eid.source,
+          id: eid.uids?.[0]?.id
+        })).filter(eid => eid.source && eid.id),
+        fpd: bidRequest.ortb2 || {},
+        ads: [
+          {
+            maxSize: {
+              width: width,
+              height: height,
+            },
+            referenceId: bidRequest.params.referenceId,
+            tagId: bidRequest.params.zone,
+            type: detectAdType(bidRequest),
+            ...(isNative && { nativeRequest: { ver: "1.2", assets: processedAssets || {}} })
+          },
+        ],
+        keywords: { tokens: bidRequest.params?.keywords || [] },
+        privacy: {
+          gpp: gpp?.consentString || "",
+          tcfeu: gdpr?.consentString || "",
+          usp: usp?.uspString || "",
+        },
+        xPageUrl: window.location.href,
+        wdb: hasWallet,
+        externalRef: bidRequest.bidId,
+        userSyncOption: userSyncEnabled === false ? "OFF" : "BIDDERS",
+      };
+
+      return {
+        method: ACTION_METHOD,
+        url: ENDPOINT_URL,
+        data: payload,
+        bidRequest: bidRequests[0],
+      };
+    });
+  },
+
+  interpretResponse(serverResponse) {
+    if (
+      !serverResponse ||
+      typeof serverResponse !== "object" ||
+      !serverResponse.body ||
+      typeof serverResponse.body !== "object" ||
+      !Array.isArray(serverResponse.body.bids)
+    ) {
+      return [];
+    }
+
+    const bids = serverResponse.body.bids;
+
+    bids.forEach((bid) => {
+      if (bid && typeof bid === "object") {
+        bid.bidder = BIDDER_CODE;
+        if ((bid.mediaType || '').toLowerCase() === 'native') {
+          const native = parseNativeAd(bid);
+          if (native) {
+            bid.native = native;
+          }
+        }
+      }
+    });
+
+    return bids;
+  },
+  onBidWon: function (bid) {},
+  onBidderError: function (bidderError) {},
+  getUserSyncs: function (syncOptions, serverResponses) {
+    const syncs = [];
+
+    if (syncOptions.pixelEnabled && serverResponses.length > 0) {
+      serverResponses.forEach((response) => {
+        if (response.body && response.body.userSyncs) {
+          response.body.userSyncs.forEach((sync) => {
+            if (sync.type === "image" && sync.url) {
+              syncs.push({
+                type: "image",
+                url: sync.url,
+              });
+            } else if (sync.type === "iframe" && syncOptions.iframeEnabled) {
+              syncs.push({
+                type: "iframe",
+                url: sync.url,
+              });
+            }
+          });
+        }
+      });
+    }
+
+    return syncs;
+  },
+  onTimeout: function (timeoutData) {},
+  supportedMediaTypes: [BANNER, NATIVE],
+};
+
+registerBidder(spec);

package/modules/sevioBidAdapter.md

@@ -0,0 +1,29 @@
+# Overview
+
+```
+Module Name: Sevio Bidder Adapter
+Module Type: Sevio Adapter
+Maintainer: technical@sevio.com
+```
+
+# Description
+Module that connects to Sevio bidder for bids. The Sevio Prebid adapter seamlessly integrates with Prebid.js
+to bring high-performance, real-time bidding capabilities to publishers
+
+# Test Parameters
+```
+ var adUnits = [{
+            code: 'sevio-ad-b7a0913d-6064-4d72-8d80-ded800a75983',
+            mediaTypes: {
+                banner: {
+                    sizes: [[728, 90]]
+                }
+            },
+            bids: [{
+                bidder: 'sevio',
+                params: {
+                    zone: 'b7a0913d-6064-4d72-8d80-ded800a75983'
+                }
+            }]
+        }];
+```

package/modules/sharedIdSystem.ts

@@ -21,39 +21,39 @@ const OPTOUT_NAME = '_pubcid_optout';
 const PUB_COMMON_ID = 'PublisherCommonId';
 
 type SharedIdParams = {
-    /**
-     * If true, then an id is created automatically if it’s missing.
-     * Default is true. If your server has a component that generates the id instead, then this should be set to false
-     */
-    create?: boolean;
-    /**
-     * If true, the the expiration time is automatically extended whenever the script is executed even if the id exists already.
-     * Default is true. If false, then the id expires from the time it was initially created.
-     */
-    extend?: boolean;
-    /**
-     * For publisher server support only. Where to call out to for a server cookie.
-     */
-    pixelUrl?: string;
-    /**
-     * The value to use for `inserter` in EIDs.
-     */
-    inserter?: string;
+  /**
+   * If true, then an id is created automatically if it’s missing.
+   * Default is true. If your server has a component that generates the id instead, then this should be set to false
+   */
+  create?: boolean;
+  /**
+   * If true, the the expiration time is automatically extended whenever the script is executed even if the id exists already.
+   * Default is true. If false, then the id expires from the time it was initially created.
+   */
+  extend?: boolean;
+  /**
+   * For publisher server support only. Where to call out to for a server cookie.
+   */
+  pixelUrl?: string;
+  /**
+   * The value to use for `inserter` in EIDs.
+   */
+  inserter?: string;
 }
 
 declare module './userId/spec' {
-    interface UserId {
-        pubcid: string;
-    }
-    interface ProvidersToId {
-        sharedId: 'pubcid';
-        pubCommonId: 'pubcid';
-    }
+  interface UserId {
+    pubcid: string;
+  }
+  interface ProvidersToId {
+    sharedId: 'pubcid';
+    pubCommonId: 'pubcid';
+  }
 
-    interface ProviderParams {
-        sharedId: SharedIdParams;
-        pubCommonId: SharedIdParams;
-    }
+  interface ProviderParams {
+    sharedId: SharedIdParams;
+    pubCommonId: SharedIdParams;
+  }
 
 }