@highfivve/ad-tag 5.8.17 → 5.8.21

package/lib/ads/modules/generic-skin/index.js

@@ -11,140 +11,141 @@ export const filterHighestNonSkinBid = (bidResponses, blockedAdSlotDomIds) => {
         .sort((bid1, bid2) => bid2.cpm - bid1.cpm)
         .slice(0, 1)));
 };
-export class Skin {
-    constructor() {
-        this.name = 'skin';
-        this.description = 'Block other ad slots if a wallpaper has won the auction';
-        this.moduleType = 'prebid';
-        this.skinModuleConfig = null;
-        this.bidsBackHandler = [];
-        this.getConfigEffect = (config, bidResponses, log) => {
-            const skinBidResponse = bidResponses[config.skinAdSlotDomId];
-            const isSkinBid = (bid) => {
-                const oneFilterApplied = config.formatFilter.some(filter => {
-                    switch (filter.bidder) {
-                        case '*':
-                            return true;
-                        case 'gumgum':
-                            return (bid.bidder === prebidjs.GumGum &&
-                                (filter.auid === undefined ||
-                                    (typeof bid.ad !== 'string' && bid.ad.auid === filter.auid)));
-                        default:
-                            return bid.bidder === filter.bidder;
-                    }
-                });
-                return bid.cpm > 0 && oneFilterApplied;
-            };
-            const nonSkinBids = filterHighestNonSkinBid(bidResponses, config.blockedAdSlotDomIds);
-            const combinedNonSkinCpm = nonSkinBids.reduce((prev, current) => prev + current.cpm, 0);
-            const skinBids = skinBidResponse
+export const createSkin = () => {
+    const name = 'skin';
+    let skinModuleConfig = null;
+    let bidsBackHandler = [];
+    const config__ = () => skinModuleConfig;
+    const getConfigEffect = (config, bidResponses, log) => {
+        const skinBidResponse = bidResponses[config.skinAdSlotDomId];
+        const isSkinBid = (bid) => {
+            const oneFilterApplied = config.formatFilter.some(filter => {
+                switch (filter.bidder) {
+                    case '*':
+                        return true;
+                    case 'gumgum':
+                        return (bid.bidder === prebidjs.GumGum &&
+                            (filter.auid === undefined ||
+                                (typeof bid.ad !== 'string' && bid.ad.auid === filter.auid)));
+                    default:
+                        return bid.bidder === filter.bidder;
+                }
+            });
+            return bid.cpm > 0 && oneFilterApplied;
+        };
+        const nonSkinBids = filterHighestNonSkinBid(bidResponses, config.blockedAdSlotDomIds);
+        const combinedNonSkinCpm = nonSkinBids.reduce((prev, current) => prev + current.cpm, 0);
+        const skinBids = skinBidResponse
+            ?
+                skinBidResponse.bids.filter(isSkinBid).sort((bid1, bid2) => bid2.cpm - bid1.cpm)
+            : [];
+        const skinConfigEffect = skinBids.length > 0
+            ? skinBids[0].cpm > combinedNonSkinCpm
                 ?
-                    skinBidResponse.bids.filter(isSkinBid).sort((bid1, bid2) => bid2.cpm - bid1.cpm)
-                : [];
-            const skinConfigEffect = skinBids.length > 0
-                ? skinBids[0].cpm > combinedNonSkinCpm
-                    ?
-                        "BlockOtherSlots"
-                    :
-                        "BlockSkinSlot"
+                    "BlockOtherSlots"
                 :
-                    "NoBlocking";
-            log.debug(this.name, 'nonSkinBids', nonSkinBids);
-            log.debug(this.name, 'skinBids', skinBids);
-            if (config.enableCpmComparison) {
-                return skinConfigEffect;
+                    "BlockSkinSlot"
+            :
+                "NoBlocking";
+        log.debug(name, 'nonSkinBids', nonSkinBids);
+        log.debug(name, 'skinBids', skinBids);
+        if (config.enableCpmComparison) {
+            return skinConfigEffect;
+        }
+        return skinBids.length > 0 ? "BlockOtherSlots" : "NoBlocking";
+    };
+    const selectConfig = (skinModuleConfig, bidResponses, log) => skinModuleConfig.configs
+        .map(config => ({
+        skinConfig: config,
+        configEffect: getConfigEffect(config, bidResponses, log)
+    }))
+        .find(({ configEffect }) => configEffect !== "NoBlocking");
+    const destroyAdSlot = (slotDefinitions, gWindow) => (adSlotDomId) => {
+        const adSlots = slotDefinitions
+            .map(slot => slot.adSlot)
+            .filter((slot) => slot.getSlotElementId() === adSlotDomId);
+        gWindow.googletag.destroySlots(adSlots);
+    };
+    const hideAdSlot = (_window, log) => (domId) => {
+        const element = _window.document.getElementById(domId);
+        try {
+            if (element) {
+                log.debug('SkinModule', `Set display:none for ${domId}`);
+                element.style.setProperty('display', 'none');
             }
-            return skinBids.length > 0 ? "BlockOtherSlots" : "NoBlocking";
-        };
-        this.selectConfig = (skinModuleConfig, bidResponses, log) => skinModuleConfig.configs
-            .map(config => ({
-            skinConfig: config,
-            configEffect: this.getConfigEffect(config, bidResponses, log)
-        }))
-            .find(({ configEffect }) => configEffect !== "NoBlocking");
-        this.destroyAdSlot = (slotDefinitions, gWindow) => (adSlotDomId) => {
-            const adSlots = slotDefinitions
-                .map(slot => slot.adSlot)
-                .filter((slot) => slot.getSlotElementId() === adSlotDomId);
-            gWindow.googletag.destroySlots(adSlots);
-        };
-        this.runSkinConfigs = (skinModuleConfig) => (ctx, bidResponses, slotDefinitions) => {
-            const skinConfigWithEffect = this.selectConfig(skinModuleConfig, bidResponses, ctx.logger__);
-            if (skinConfigWithEffect) {
-                const { skinConfig, configEffect } = skinConfigWithEffect;
-                if (configEffect === "BlockOtherSlots") {
-                    ctx.logger__.debug('SkinModule', 'Skin configuration applied', skinConfig);
-                    skinConfig.blockedAdSlotDomIds.forEach(this.destroyAdSlot(slotDefinitions, ctx.window__));
-                    if (skinConfig.hideBlockedSlots) {
-                        skinConfig.blockedAdSlotDomIds.forEach(this.hideAdSlot(ctx.window__, ctx.logger__));
-                    }
-                    if (skinConfig.hideSkinAdSlot) {
-                        this.hideAdSlot(ctx.window__, ctx.logger__)(skinConfig.skinAdSlotDomId);
-                    }
-                    if (skinConfig.hideBlockedSlotsSelector) {
-                        ctx.window__.document
-                            .querySelectorAll(skinConfig.hideBlockedSlotsSelector)
-                            .forEach(node => {
-                            ctx.logger__.debug('SkinModule', `Set display:none for container with selector ${skinConfig.hideBlockedSlotsSelector}`);
-                            node.style.setProperty('display', 'none');
-                        });
-                    }
-                    if (skinConfig.targeting) {
-                        try {
-                            ctx.window__.googletag
-                                .pubads()
-                                .setTargeting(skinConfig.targeting.key, skinConfig.targeting.value ?? '1');
-                        }
-                        catch (e) {
-                            ctx.logger__.error('SkinModule', e);
-                        }
-                    }
+        }
+        catch (e) {
+            log.error('SkinModule', `Couldn't set the the wallpaper div ${domId} to display:none;`, e);
+        }
+    };
+    const runSkinConfigs = (skinModuleConfig) => (ctx, bidResponses, slotDefinitions) => {
+        const skinConfigWithEffect = selectConfig(skinModuleConfig, bidResponses, ctx.logger__);
+        if (skinConfigWithEffect) {
+            const { skinConfig, configEffect } = skinConfigWithEffect;
+            if (configEffect === "BlockOtherSlots") {
+                ctx.logger__.debug('SkinModule', 'Skin configuration applied', skinConfig);
+                skinConfig.blockedAdSlotDomIds.forEach(destroyAdSlot(slotDefinitions, ctx.window__));
+                if (skinConfig.hideBlockedSlots) {
+                    skinConfig.blockedAdSlotDomIds.forEach(hideAdSlot(ctx.window__, ctx.logger__));
                 }
-                else if (skinConfig.enableCpmComparison) {
-                    ctx.logger__.debug('SkinModule', 'Skin configuration ignored because cpm was low', skinConfig);
-                    this.destroyAdSlot(slotDefinitions, ctx.window__)(skinConfig.skinAdSlotDomId);
+                if (skinConfig.hideSkinAdSlot) {
+                    hideAdSlot(ctx.window__, ctx.logger__)(skinConfig.skinAdSlotDomId);
                 }
-            }
-            else {
-                skinModuleConfig.configs
-                    .filter(skinConfig => skinConfig.destroySkinSlot)
-                    .map(skinConfig => skinConfig.skinAdSlotDomId)
-                    .filter(uniquePrimitiveFilter)
-                    .forEach(this.destroyAdSlot(slotDefinitions, ctx.window__));
-            }
-        };
-        this.hideAdSlot = (_window, log) => (domId) => {
-            const element = _window.document.getElementById(domId);
-            try {
-                if (element) {
-                    log.debug('SkinModule', `Set display:none for ${domId}`);
-                    element.style.setProperty('display', 'none');
+                if (skinConfig.hideBlockedSlotsSelector) {
+                    ctx.window__.document
+                        .querySelectorAll(skinConfig.hideBlockedSlotsSelector)
+                        .forEach(node => {
+                        ctx.logger__.debug('SkinModule', `Set display:none for container with selector ${skinConfig.hideBlockedSlotsSelector}`);
+                        node.style.setProperty('display', 'none');
+                    });
+                }
+                if (skinConfig.targeting) {
+                    try {
+                        ctx.window__.googletag
+                            .pubads()
+                            .setTargeting(skinConfig.targeting.key, skinConfig.targeting.value ?? '1');
+                    }
+                    catch (e) {
+                        ctx.logger__.error('SkinModule', e);
+                    }
                 }
             }
-            catch (e) {
-                log.error('SkinModule', `Couldn't set the the wallpaper div ${domId} to display:none;`, e);
+            else if (skinConfig.enableCpmComparison) {
+                ctx.logger__.debug('SkinModule', 'Skin configuration ignored because cpm was low', skinConfig);
+                destroyAdSlot(slotDefinitions, ctx.window__)(skinConfig.skinAdSlotDomId);
             }
-        };
-    }
-    config__() {
-        return this.skinModuleConfig;
-    }
-    configure__(moduleConfig) {
+        }
+        else {
+            skinModuleConfig.configs
+                .filter(skinConfig => skinConfig.destroySkinSlot)
+                .map(skinConfig => skinConfig.skinAdSlotDomId)
+                .filter(uniquePrimitiveFilter)
+                .forEach(destroyAdSlot(slotDefinitions, ctx.window__));
+        }
+    };
+    const configure__ = (moduleConfig) => {
         if (moduleConfig?.skin && moduleConfig.skin.enabled) {
-            this.skinModuleConfig = moduleConfig.skin;
-            this.bidsBackHandler.push(this.runSkinConfigs(moduleConfig.skin));
+            skinModuleConfig = moduleConfig.skin;
+            bidsBackHandler.push(runSkinConfigs(moduleConfig.skin));
         }
-    }
-    initSteps__() {
-        return [];
-    }
-    configureSteps__() {
-        return [];
-    }
-    prepareRequestAdsSteps__() {
-        return [];
-    }
-    prebidBidsBackHandler__() {
-        return this.bidsBackHandler;
-    }
-}
+    };
+    const initSteps__ = () => [];
+    const configureSteps__ = () => [];
+    const prepareRequestAdsSteps__ = () => [];
+    const prebidBidsBackHandler__ = () => bidsBackHandler;
+    return {
+        name,
+        description: 'Block other ad slots if a wallpaper has won the auction',
+        moduleType: 'prebid',
+        config__,
+        configure__,
+        initSteps__,
+        configureSteps__,
+        prepareRequestAdsSteps__,
+        prebidBidsBackHandler__,
+        getConfigEffect,
+        selectConfig,
+        destroyAdSlot,
+        runSkinConfigs
+    };
+};

package/lib/ads/modules/identitylink/index.js

@@ -1,43 +1,20 @@
 import { mkInitStep } from 'ad-tag/ads/adPipeline';
 import { AssetLoadMethod } from 'ad-tag/util/assetLoaderService';
-export class IdentityLink {
-    constructor() {
-        this.name = 'identitylink';
-        this.description = "Provides LiveRamp's ATS (authenticated traffic solution) functionality to Moli.";
-        this.moduleType = 'identity';
-        this.gvlid = '97';
-        this.identityLinkConfig = null;
-    }
-    config__() {
-        return this.identityLinkConfig;
-    }
-    configure__(moduleConfig) {
+export const createIdentityLink = () => {
+    const name = 'identitylink';
+    const gvlid = '97';
+    let identityLinkConfig = null;
+    const config__ = () => identityLinkConfig;
+    const configure__ = (moduleConfig) => {
         if (moduleConfig?.identitylink && moduleConfig.identitylink.enabled) {
-            this.identityLinkConfig = moduleConfig.identitylink;
+            identityLinkConfig = moduleConfig.identitylink;
         }
-    }
-    initSteps__() {
-        const config = this.identityLinkConfig;
-        return config
-            ? [
-                mkInitStep(this.name, ctx => {
-                    this.loadAts(ctx, config);
-                    return Promise.resolve();
-                })
-            ]
-            : [];
-    }
-    configureSteps__() {
-        return [];
-    }
-    prepareRequestAdsSteps__() {
-        return [];
-    }
-    loadAts(context, moduleConfig) {
+    };
+    const loadAts = (context, moduleConfig) => {
         if (context.env__ === 'test') {
             return Promise.resolve();
         }
-        if (context.tcData__.gdprApplies && !context.tcData__.vendor.consents[this.gvlid]) {
+        if (context.tcData__.gdprApplies && !context.tcData__.vendor.consents[gvlid]) {
             return Promise.resolve();
         }
         const window = context.window__;
@@ -62,10 +39,34 @@ export class IdentityLink {
         });
         return context.assetLoaderService__
             .loadScript({
-            name: this.name,
+            name,
             loadMethod: AssetLoadMethod.TAG,
             assetUrl: `https://launchpad-wrapper.privacymanager.io/${moduleConfig.launchPadId}/launchpad-liveramp.js`
         })
             .catch(error => context.logger__.error('failed to load emetriq', error));
-    }
-}
+    };
+    const initSteps__ = () => {
+        const config = identityLinkConfig;
+        return config
+            ? [
+                mkInitStep(name, ctx => {
+                    loadAts(ctx, config);
+                    return Promise.resolve();
+                })
+            ]
+            : [];
+    };
+    const configureSteps__ = () => [];
+    const prepareRequestAdsSteps__ = () => [];
+    return {
+        name,
+        description: "Provides LiveRamp's ATS (authenticated traffic solution) functionality to Moli.",
+        moduleType: 'identity',
+        config__,
+        configure__,
+        initSteps__,
+        configureSteps__,
+        prepareRequestAdsSteps__,
+        loadAts
+    };
+};

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

@@ -0,0 +1,43 @@
+export const createEventTracker = (url, batchSize, batchDelay, logger) => {
+    let batch = [];
+    let timer = null;
+    const processBatch = () => {
+        const currentBatch = batch;
+        batch = [];
+        fetch(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({ events: currentBatch })
+        })
+            .then(response => {
+            if (response.ok) {
+                logger?.debug(`moli-analytics: Successfully sent analytics batch of ${currentBatch.length} events`);
+            }
+            else {
+                logger?.error(`moli-analytics: Failed to send analytics batch: ${response.statusText}`);
+            }
+        })
+            .catch(error => {
+            logger?.error(`moli-analytics: Failed to send analytics batch: ${error}`);
+        });
+    };
+    const track = (event) => {
+        logger?.debug('moli-analytics: event', event);
+        batch.push(event);
+        if (timer != null) {
+            clearTimeout(timer);
+            timer = null;
+        }
+        if (batch.length >= batchSize) {
+            processBatch();
+        }
+        else {
+            timer = setTimeout(processBatch, batchDelay);
+        }
+    };
+    return {
+        track
+    };
+};

package/lib/ads/modules/moli-analytics/events/gptSlotRenderEnded.js

@@ -0,0 +1,21 @@
+export const mapGPTSlotRenderEnded = (event, context, adContext) => {
+    const timestamp = Date.now();
+    return {
+        v: 1,
+        type: 'gpt.slotRenderEnded',
+        publisher: context.publisher,
+        pageViewId: context.pageViewId,
+        userId: adContext.window__.pbjs.getUserIds().pubcid,
+        timestamp,
+        analyticsLabels: context.analyticsLabels,
+        data: {
+            auctionId: context.auctionId,
+            gpid: context.gpid,
+            adUnitPath: event.slot.getAdUnitPath(),
+            adUnitName: context.adUnitName,
+            adUnitCode: event.slot.getSlotElementId(),
+            size: Array.isArray(event.size) ? event.size.join('x') : event.size,
+            isEmpty: event.isEmpty
+        }
+    };
+};

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

@@ -0,0 +1,16 @@
+import { mapPrebidAuctionEnd } from 'ad-tag/ads/modules/moli-analytics/events/prebidAuctionEnd';
+import { mapPrebidBidWon } from 'ad-tag/ads/modules/moli-analytics/events/prebidBidWon';
+import { mapGPTSlotRenderEnded } from 'ad-tag/ads/modules/moli-analytics/events/gptSlotRenderEnded';
+import { mapPageView } from 'ad-tag/ads/modules/moli-analytics/events/pageView';
+export const eventMapper = {
+    prebid: {
+        auctionEnd: mapPrebidAuctionEnd,
+        bidWon: mapPrebidBidWon
+    },
+    gpt: {
+        slotRenderEnded: mapGPTSlotRenderEnded
+    },
+    page: {
+        view: mapPageView
+    }
+};

package/lib/ads/modules/moli-analytics/events/pageView.js

@@ -0,0 +1,31 @@
+const parseUTM = (search) => {
+    const params = new URLSearchParams(search);
+    const v = (k) => params.get(k) || null;
+    return {
+        source: v('utm_source'),
+        medium: v('utm_medium'),
+        campaign: v('utm_campaign'),
+        content: v('utm_content'),
+        term: v('utm_term')
+    };
+};
+export const mapPageView = (context, adContext) => {
+    const timestamp = Date.now();
+    const userIds = adContext.window__.pbjs.getUserIds ? adContext.window__.pbjs.getUserIds() : {};
+    return {
+        v: 1,
+        type: 'page.view',
+        publisher: context.publisher,
+        pageViewId: context.pageViewId,
+        userId: userIds?.pubcid,
+        timestamp,
+        analyticsLabels: context.analyticsLabels,
+        data: {
+            sessionId: context.session.getId(),
+            device: adContext.labelConfigService__.getDeviceLabel(),
+            domain: adContext.window__.moli.resolveAdUnitPath('{domain}'),
+            ua: adContext.window__.navigator.userAgent,
+            utm: parseUTM(adContext.window__.location.search)
+        }
+    };
+};

package/lib/ads/modules/moli-analytics/events/prebidAuctionEnd.js

@@ -0,0 +1,39 @@
+export const mapPrebidAuctionEnd = (event, context, adContext) => {
+    const timestamp = Date.now();
+    return {
+        v: 1,
+        type: 'prebid.auctionEnd',
+        publisher: context.publisher,
+        pageViewId: context.pageViewId,
+        userId: adContext.window__.pbjs.getUserIds().pubcid,
+        timestamp,
+        analyticsLabels: context.analyticsLabels,
+        data: {
+            auctionId: event.auctionId,
+            adUnits: Array.from(new Map((event.adUnits || []).map(adUnit => [
+                adUnit.code,
+                {
+                    code: adUnit.code,
+                    adUnitName: adUnit.pubstack?.adUnitName || adUnit.code,
+                    gpid: adUnit.ortb2Imp?.ext?.gpid
+                }
+            ])).values()),
+            bidderRequests: (event.bidderRequests || []).map(request => {
+                return {
+                    bidderCode: request.bidderCode,
+                    bids: (request.bids || []).map(bid => ({
+                        adUnitCode: bid.adUnitCode
+                    }))
+                };
+            }),
+            bidsReceived: (event.bidsReceived || []).map(bid => ({
+                bidder: bid.bidder,
+                adUnitCode: bid.adUnitCode,
+                size: bid.size,
+                currency: bid.currency,
+                cpm: bid.cpm,
+                timeToRespond: bid.timeToRespond
+            }))
+        }
+    };
+};

package/lib/ads/modules/moli-analytics/events/prebidBidWon.js

@@ -0,0 +1,23 @@
+export const mapPrebidBidWon = (event, context, adContext) => {
+    const timestamp = Date.now();
+    return {
+        v: 1,
+        type: 'prebid.bidWon',
+        publisher: context.publisher,
+        pageViewId: context.pageViewId,
+        userId: adContext.window__.pbjs.getUserIds().pubcid,
+        timestamp,
+        analyticsLabels: context.analyticsLabels,
+        data: {
+            auctionId: event.auctionId,
+            gpid: context.gpid,
+            bidderCode: event.bidderCode,
+            adUnitCode: event.adUnitCode,
+            size: event.size,
+            currency: event.currency,
+            cpm: event.cpm,
+            status: event.status,
+            timeToRespond: event.timeToRespond
+        }
+    };
+};