@highfivve/ad-tag 5.8.21 → 5.8.23

package/lib/ads/auctions/trackWinningBidder.js

@@ -0,0 +1,13 @@
+export const createTrackWinningBidder = () => {
+    const lastWinningBidderByAdUnit = new Map();
+    const onBidWon = (winningBid) => {
+        lastWinningBidderByAdUnit.set(winningBid.adUnitCode, winningBid.bidderCode);
+    };
+    const getLastWinningBidderOnAdUnit = (slotId) => {
+        return lastWinningBidderByAdUnit.get(slotId);
+    };
+    return {
+        onBidWon,
+        getLastWinningBidderOnAdUnit
+    };
+};

package/lib/ads/globalAuctionContext.js

@@ -4,7 +4,11 @@ import { createFrequencyCapping } from './auctions/frequencyCapping';
 import { createPreviousBidCpms } from './auctions/previousBidCpms';
 import { mkConfigureStep } from './adPipeline';
 import { createInterstitialContext } from 'ad-tag/ads/auctions/interstitialContext';
+import { createTrackWinningBidder } from 'ad-tag/ads/auctions/trackWinningBidder';
 export const createGlobalAuctionContext = (window, logger, eventService, config = {}) => {
+    const trackWinningBidder = config.trackWinningBidder?.enabled
+        ? createTrackWinningBidder()
+        : undefined;
     const biddersDisabling = config.biddersDisabling?.enabled
         ? createBiddersDisabling(config.biddersDisabling, window)
         : undefined;
@@ -44,14 +48,19 @@ export const createGlobalAuctionContext = (window, logger, eventService, config
             });
         });
     }
-    if (config.frequencyCap?.enabled) {
+    if (config.frequencyCap?.enabled || config.trackWinningBidder?.enabled) {
         window.pbjs.que.push(() => {
             window.pbjs.onEvent('bidWon', bid => {
                 if (config.frequencyCap) {
                     frequencyCapping?.onBidWon(bid);
                 }
+                if (config.trackWinningBidder) {
+                    trackWinningBidder?.onBidWon(bid);
+                }
             });
         });
+    }
+    if (config.frequencyCap?.enabled) {
         eventService.addEventListener('beforeRequestAds', () => {
             frequencyCapping?.beforeRequestAds();
         });
@@ -86,6 +95,9 @@ export const createGlobalAuctionContext = (window, logger, eventService, config
         getLastBidCpmsOfAdUnit(slotId) {
             return previousBidCpms?.getLastBidCpms(slotId) ?? [];
         },
+        getLastWinningBidderOfAdUnit(slotId) {
+            return trackWinningBidder?.getLastWinningBidderOnAdUnit(slotId);
+        },
         isBidderDisabled(domId, bidder) {
             return biddersDisabling?.isBidderDisabled(domId, bidder) ?? false;
         },

package/lib/ads/modules/ad-reload/adVisibilityService.js

@@ -61,7 +61,7 @@ export class AdVisibilityService {
         this.setUpdateTimer(true);
         this.logger?.debug('AdVisibilityService', 'initialized');
     }
-    trackSlot(slot, refreshCallback, advertiserId, companyIds) {
+    trackSlot(slot, refreshCallback, advertiserId, companyIds, lastWinningBidderCode) {
         const slotDomId = slot.getSlotElementId();
         const domElement = this.observedDomElementForSlot(slot);
         if (domElement) {
@@ -81,7 +81,8 @@ export class AdVisibilityService {
                     ? this.window.performance.now()
                     : undefined,
                 durationVisibleSum: 0,
-                refreshCallback: refreshCallback
+                refreshCallback: refreshCallback,
+                lastWinningBidderCode
             });
             if (this.intersectionObserver &&
                 (domElement.targetOverride || this.useIntersectionObserver)) {
@@ -110,7 +111,7 @@ export class AdVisibilityService {
         });
         Array.from(this.visibilityRecords.values())
             .filter(record => {
-            const interval = this.refreshIntervalOverrides[record.slot.getSlotElementId()] || this.refreshInterval;
+            const interval = this.resolveRefreshInterval(record);
             return record.durationVisibleSum > interval;
         })
             .forEach(record => {
@@ -120,6 +121,16 @@ export class AdVisibilityService {
             record.refreshCallback(record.slot);
         });
     }
+    resolveRefreshInterval(record) {
+        const override = this.refreshIntervalOverrides[record.slot.getSlotElementId()];
+        if (typeof override === 'number') {
+            return override;
+        }
+        const bidderOverride = record.lastWinningBidderCode && override?.bidders
+            ? override.bidders[record.lastWinningBidderCode]
+            : undefined;
+        return bidderOverride ?? override?.default ?? this.refreshInterval;
+    }
     handleObservedAdVisibilityChanged(entries) {
         entries.forEach(entry => {
             const visibilityRecord = this.visibilityRecordForEntry(entry);

package/lib/ads/modules/ad-reload/index.js

@@ -10,6 +10,7 @@ export const createAdReload = () => {
     let initialized = false;
     let moduleConfig = null;
     let adVisibilityService;
+    let globalAuctionContext;
     const config__ = () => moduleConfig;
     const isInitialized = () => initialized;
     const configure__ = (mConfig) => {
@@ -113,7 +114,8 @@ export const createAdReload = () => {
         }
         const slotAlreadyTracked = !!adVisibilityService?.isSlotTracked(slotDomId);
         if (trackingSlotAllowed) {
-            adVisibilityService.trackSlot(googleTagSlot, reloadAdSlotCallback, advertiserId, companyIds);
+            const bidderCode = globalAuctionContext?.getLastWinningBidderOfAdUnit(slotDomId);
+            adVisibilityService.trackSlot(googleTagSlot, reloadAdSlotCallback, advertiserId, companyIds, bidderCode);
         }
         else if (slotAlreadyTracked) {
             adVisibilityService.removeSlotTracking(googleTagSlot);
@@ -128,6 +130,7 @@ export const createAdReload = () => {
             return;
         }
         context.logger__.debug('AdReload', 'initialize moli ad reload module');
+        globalAuctionContext = context.auction__;
         setupAdVisibilityService(config, context.window__, context.logger__);
         setupSlotRenderListener(config, slotsToMonitor, reloadAdSlotCallback, context.window__, context.logger__);
         initialized = true;

package/lib/ads/modules/moli-analytics/index.js

@@ -49,7 +49,7 @@ export const MoliAnalytics = () => {
     };
     const configValid = (config, logger) => {
         if (!config) {
-            logger.error('moli-analytics: not configured');
+            logger.debug('moli-analytics: not configured');
             return false;
         }
         if (!config.publisher) {
@@ -72,7 +72,8 @@ export const MoliAnalytics = () => {
     };
     const initMoliAnalytics = async (adPipelineContext) => {
         if (!configValid(config, adPipelineContext.logger__)) {
-            return Promise.reject('failed to initialize moli analytics: invalid configuration');
+            adPipelineContext.logger__.error('failed to initialize moli analytics: invalid or no configuration');
+            return Promise.resolve();
         }
         eventContext = {
             publisher: config.publisher,

package/lib/gen/packageJson.js

@@ -1,3 +1,3 @@
 export const packageJson = {
-    version: '5.8.21'
+    version: '5.8.23'
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@highfivve/ad-tag",
-  "version": "5.8.21",
+  "version": "5.8.23",
   "license": "Apache-2.0",
   "description": "An ad tag implementation called moli",
   "main": "./lib/index.js",