@highfivve/ad-tag 5.8.34 → 5.9.1

package/lib/ads/a9.js

@@ -126,7 +126,7 @@ export const a9ClearTargetingStep = () => mkPrepareRequestAdsStep('a9-clear-targ
             adSlot
                 .getTargetingKeys()
                 .filter(key => key === 'amznp' || key === 'amznsz' || key === 'amznbid')
-                .forEach(key => adSlot.clearTargeting(key));
+                .forEach(key => adSlot.setConfig({ targeting: { [key]: null } }));
         });
         resolve();
     });

package/lib/ads/adService.js

@@ -64,7 +64,7 @@ export class AdService {
             requestBids: [],
             requestAds: () => Promise.resolve()
         }, getDefaultLogger(), this.window, createGlobalAuctionContext(this.window, getDefaultLogger(), this.eventService));
-        this.initialize = (config, runtimeConfig) => {
+        this.initialize = (config, runtimeConfig, isLabelConditionMet = () => false) => {
             const env = AdService.getEnvironment(runtimeConfig);
             const adServer = config.adServer || 'gam';
             const isGam = adServer === 'gam';
@@ -100,7 +100,7 @@ export class AdService {
                 prepareRequestAds.push(a9ClearTargetingStep());
                 requestBids.push(a9RequestBids(config.a9));
             }
-            const globalAuctionContext = createGlobalAuctionContext(this.window, this.logger, this.eventService, config.globalAuctionContext);
+            const globalAuctionContext = createGlobalAuctionContext(this.window, this.logger, this.eventService, config.globalAuctionContext, isLabelConditionMet);
             configure.push(globalAuctionContext.configureStep());
             init.push(...runtimeConfig.adPipelineConfig.initSteps);
             configure.push(...runtimeConfig.adPipelineConfig.configureSteps);

package/lib/ads/configOverrides.js

@@ -0,0 +1,8 @@
+export const resolveOverridableConfig = (base, isLabelConditionMet) => {
+    const { overrides = [], ...defaultConfig } = base;
+    const matchedOverrideIndex = overrides.findIndex(isLabelConditionMet);
+    const match = overrides[matchedOverrideIndex];
+    return match
+        ? { config: match.config, matchedOverrideIndex, matchedCondition: match }
+        : { config: defaultConfig, matchedOverrideIndex: -1 };
+};

package/lib/ads/globalAuctionContext.js

@@ -5,42 +5,59 @@ 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
+import { resolveOverridableConfig } from 'ad-tag/ads/configOverrides';
+export const createGlobalAuctionContext = (window, logger, eventService, config = {}, isLabelConditionMet = () => false) => {
+    const resolveFeature = (base, feature) => {
+        if (!base) {
+            return undefined;
+        }
+        const { config: resolved, matchedOverrideIndex, matchedCondition } = resolveOverridableConfig(base, isLabelConditionMet);
+        if (matchedOverrideIndex >= 0) {
+            logger.debug('GlobalAuctionContext', `feature ${feature}: applying config override #${matchedOverrideIndex}`, matchedCondition);
+        }
+        return resolved;
+    };
+    const trackWinningBidderConfig = resolveFeature(config.trackWinningBidder, 'trackWinningBidder');
+    const biddersDisablingConfig = resolveFeature(config.biddersDisabling, 'biddersDisabling');
+    const adRequestThrottlingConfig = resolveFeature(config.adRequestThrottling, 'adRequestThrottling');
+    const frequencyCapConfig = resolveFeature(config.frequencyCap, 'frequencyCap');
+    const previousBidCpmsConfig = resolveFeature(config.previousBidCpms, 'previousBidCpms');
+    const interstitialConfig = resolveFeature(config.interstitial, 'interstitial');
+    const trackWinningBidder = trackWinningBidderConfig?.enabled
         ? createTrackWinningBidder()
         : undefined;
-    const biddersDisabling = config.biddersDisabling?.enabled
-        ? createBiddersDisabling(config.biddersDisabling, window)
+    const biddersDisabling = biddersDisablingConfig?.enabled
+        ? createBiddersDisabling(biddersDisablingConfig, window)
         : undefined;
-    const adRequestThrottling = config.adRequestThrottling?.enabled
-        ? createAdRequestThrottling(config.adRequestThrottling, window)
+    const adRequestThrottling = adRequestThrottlingConfig?.enabled
+        ? createAdRequestThrottling(adRequestThrottlingConfig, window)
         : undefined;
-    const frequencyCapping = config.frequencyCap?.enabled
-        ? createFrequencyCapping(config.frequencyCap, window, window.Date.now, logger)
+    const frequencyCapping = frequencyCapConfig?.enabled
+        ? createFrequencyCapping(frequencyCapConfig, window, window.Date.now, logger)
         : undefined;
-    const previousBidCpms = config.previousBidCpms?.enabled ? createPreviousBidCpms() : undefined;
-    const interstitial = config.interstitial?.enabled
-        ? createInterstitialContext(config.interstitial, window, window.Date.now, logger)
+    const previousBidCpms = previousBidCpmsConfig?.enabled ? createPreviousBidCpms() : undefined;
+    const interstitial = interstitialConfig?.enabled
+        ? createInterstitialContext(interstitialConfig, window, window.Date.now, logger)
         : undefined;
     window.pbjs = window.pbjs || { que: [] };
     window.googletag = window.googletag || {};
     window.googletag.cmd = window.googletag.cmd || [];
-    if (config.biddersDisabling?.enabled ||
-        config.previousBidCpms?.enabled ||
-        config.frequencyCap?.enabled ||
-        config.interstitial?.enabled) {
+    if (biddersDisablingConfig?.enabled ||
+        previousBidCpmsConfig?.enabled ||
+        frequencyCapConfig?.enabled ||
+        interstitialConfig?.enabled) {
         window.pbjs.que.push(() => {
             window.pbjs.onEvent('auctionEnd', auction => {
                 biddersDisabling?.onAuctionEnd(auction);
                 interstitial?.onAuctionEnd(auction);
-                if (config.previousBidCpms?.enabled && auction.bidsReceived) {
+                if (previousBidCpmsConfig?.enabled && auction.bidsReceived) {
                     previousBidCpms?.onAuctionEnd(auction.bidsReceived);
                 }
                 frequencyCapping?.onAuctionEnd(auction);
             });
         });
     }
-    if (config.adRequestThrottling?.enabled || config.frequencyCap?.enabled) {
+    if (adRequestThrottlingConfig?.enabled || frequencyCapConfig?.enabled) {
         window.googletag.cmd.push(() => {
             window.googletag.pubads().addEventListener('slotRequested', event => {
                 adRequestThrottling?.onSlotRequested(event);
@@ -48,19 +65,19 @@ export const createGlobalAuctionContext = (window, logger, eventService, config
             });
         });
     }
-    if (config.frequencyCap?.enabled || config.trackWinningBidder?.enabled) {
+    if (frequencyCapConfig?.enabled || trackWinningBidderConfig?.enabled) {
         window.pbjs.que.push(() => {
             window.pbjs.onEvent('bidWon', bid => {
-                if (config.frequencyCap) {
+                if (frequencyCapConfig) {
                     frequencyCapping?.onBidWon(bid);
                 }
-                if (config.trackWinningBidder) {
+                if (trackWinningBidderConfig) {
                     trackWinningBidder?.onBidWon(bid);
                 }
             });
         });
     }
-    if (config.frequencyCap?.enabled) {
+    if (frequencyCapConfig?.enabled) {
         eventService.addEventListener('beforeRequestAds', () => {
             frequencyCapping?.beforeRequestAds();
         });
@@ -68,7 +85,7 @@ export const createGlobalAuctionContext = (window, logger, eventService, config
             frequencyCapping?.afterRequestAds();
         });
     }
-    if (config.frequencyCap?.enabled || config.interstitial?.enabled) {
+    if (frequencyCapConfig?.enabled || interstitialConfig?.enabled) {
         window.googletag.cmd.push(() => {
             window.googletag.pubads().addEventListener('slotRenderEnded', event => {
                 frequencyCapping?.onSlotRenderEnded(event);

package/lib/ads/googleAdManager.js

@@ -28,9 +28,6 @@ const testAdSlot = (domId, adUnitPath) => ({
     getTargetingKeys() {
         return [];
     },
-    clearTargeting(_key) {
-        return;
-    },
     getResponseInformation() {
         return null;
     },
@@ -44,16 +41,17 @@ const testAdSlot = (domId, adUnitPath) => ({
 const configureTargeting = (window, runtimeKeyValues, serverSideTargeting) => {
     const staticKeyValues = serverSideTargeting ? serverSideTargeting.keyValues : {};
     const excludes = serverSideTargeting?.adManagerExcludes ?? [];
+    const targeting = {};
     [staticKeyValues, runtimeKeyValues].forEach(keyValues => {
-        Object.keys(keyValues)
-            .filter(key => !excludes.includes(key))
-            .forEach(key => {
-            const value = keyValues[key];
-            if (value) {
-                window.googletag.pubads().setTargeting(key, value);
+        Object.entries(keyValues).forEach(([key, value]) => {
+            if (!excludes.includes(key) && value) {
+                targeting[key] = value;
             }
         });
     });
+    if (Object.keys(targeting).length > 0) {
+        window.googletag.setConfig({ targeting });
+    }
 };
 const useStandardGpt = (tcData, consentConfig) => {
     if (consentConfig?.useLimitedAds === false) {
@@ -188,7 +186,7 @@ export const gptLDeviceLabelKeyValue = () => mkPrepareRequestAdsStep('gpt-device
     return new Promise(resolve => {
         const deviceLabel = ctx.labelConfigService__.getDeviceLabel();
         ctx.logger__.debug('GAM', 'adding "device_label" key-value with values', deviceLabel);
-        ctx.window__.googletag.pubads().setTargeting('device_label', deviceLabel);
+        ctx.window__.googletag.setConfig({ targeting: { device_label: deviceLabel } });
         resolve();
     });
 });
@@ -211,7 +209,7 @@ export const gptConsentKeyValue = () => mkPrepareRequestAdsStep('gpt-consent-key
                 tcfapi.responses.TCPurpose.APPLY_MARKET_RESEARCH,
                 tcfapi.responses.TCPurpose.DEVELOP_IMPROVE_PRODUCTS
             ].every(purpose => tcData.purpose.consents[purpose]);
-        ctx.window__.googletag.pubads().setTargeting('consent', fullConsent ? 'full' : 'none');
+        ctx.window__.googletag.setConfig({ targeting: { consent: fullConsent ? 'full' : 'none' } });
         resolve();
     });
 });
@@ -296,7 +294,7 @@ export const gptDefineSlots = () => (context, slots) => {
                     }
                 }
                 else {
-                    adSlot.clearTargeting(formatKey);
+                    adSlot.setConfig({ targeting: { [formatKey]: null } });
                 }
                 context.window__.googletag.display(adSlot);
             }

package/lib/ads/modules/blocklist-url/index.js

@@ -68,9 +68,9 @@ export const createBlocklistedUrls = () => {
                             const value = blocklistConfig.isBlocklistedValue || 'true';
                             return getBlocklist(blocklistConfig.blocklist, ctx.assetLoaderService__, ctx.logger__)().then(blocklist => {
                                 if (isBlocklisted(blocklist, ctx.window__.location.href, ctx.logger__)) {
-                                    ctx.window__.googletag
-                                        .pubads()
-                                        .setTargeting(key, value);
+                                    ctx.window__.googletag.setConfig({
+                                        targeting: { [key]: value }
+                                    });
                                 }
                             });
                         case 'block':

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

@@ -144,9 +144,9 @@ export const createSkin = () => {
                 }
                 if (skinConfig.targeting) {
                     try {
-                        ctx.window__.googletag
-                            .pubads()
-                            .setTargeting(skinConfig.targeting.key, skinConfig.targeting.value ?? '1');
+                        ctx.window__.googletag.setConfig({
+                            targeting: { [skinConfig.targeting.key]: skinConfig.targeting.value ?? '1' }
+                        });
                     }
                     catch (e) {
                         ctx.logger__.error('SkinModule', e);

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

@@ -40,7 +40,9 @@ export const createPubstack = () => {
                     }
                     const pubstackAbTestCohort = extractPubstackAbTestCohort(ctx);
                     if (pubstackAbTestCohort) {
-                        ctx.window__.googletag.pubads().setTargeting('pbstck_ab_test', pubstackAbTestCohort);
+                        ctx.window__.googletag.setConfig({
+                            targeting: { pbstck_ab_test: pubstackAbTestCohort }
+                        });
                     }
                     return Promise.resolve();
                 })

package/lib/ads/modules/yield-optimization/index.js

@@ -40,7 +40,7 @@ export const YieldOptimization = (testYieldOptimizationService) => {
             .then(() => yieldOptimizationService.getBrowser())
             .then(browser => {
             if (context.env__ === 'production' && adServer === 'gam') {
-                context.window__.googletag.pubads().setTargeting('upr_browser', browser);
+                context.window__.googletag.setConfig({ targeting: { upr_browser: browser } });
             }
         });
     });

package/lib/ads/moli.js

@@ -9,6 +9,7 @@ import * as adUnitPath from './adUnitPath';
 import { extractTopPrivateDomainFromHostname } from '../util/extractTopPrivateDomainFromHostname';
 import { detectGeoFromBrowser } from '../util/detectGeoFromTimezone';
 import { createLabelConfigService } from './labelConfigService';
+import { resolveOverridableConfig } from './configOverrides';
 import { allowRefreshAdSlot, allowRequestAds } from './spa';
 import { QueryParameters } from 'ad-tag/util/queryParameters';
 import { BrowserStorageKeys } from 'ad-tag/util/browserStorageKeys';
@@ -244,21 +245,31 @@ export const createMoliTag = (window) => {
                 getLogger(state.runtimeConfig, window).debug('MoliGlobal', 'configure modules', state.config.modules ?? {});
                 const labelService = createLabelConfigService(state.config?.labelSizeConfig || [], state.runtimeConfig.labels, window);
                 modules
-                    .filter(module => {
+                    .map(module => {
                     const moduleName = module.name;
-                    const moduleConfig = state.config?.modules?.[moduleName];
-                    if (moduleConfig?.labelCondition) {
-                        const areLabelConditionsMet = labelService.isLabelConditionMet(moduleConfig.labelCondition);
-                        if (!areLabelConditionsMet) {
-                            getLogger(state.runtimeConfig, window).debug('MoliGlobal', `skipping configuration of ${module.moduleType} module ${moduleName} due to label condition not met.`);
-                            return false;
-                        }
+                    const base = state.config?.modules?.[moduleName];
+                    if (!base) {
+                        return null;
+                    }
+                    const { config: effectiveConfig, matchedOverrideIndex, matchedCondition } = resolveOverridableConfig(base, labelService.isLabelConditionMet);
+                    if (matchedOverrideIndex >= 0) {
+                        getLogger(state.runtimeConfig, window).debug('MoliGlobal', `module ${moduleName}: applying config override #${matchedOverrideIndex}`, matchedCondition);
                     }
-                    return true;
+                    if (effectiveConfig.labelCondition &&
+                        !labelService.isLabelConditionMet(effectiveConfig.labelCondition)) {
+                        getLogger(state.runtimeConfig, window).debug('MoliGlobal', `skipping configuration of ${module.moduleType} module ${moduleName} due to label condition not met.`);
+                        return null;
+                    }
+                    const resolvedModulesConfig = {
+                        ...state.config?.modules,
+                        [moduleName]: effectiveConfig
+                    };
+                    return { module, resolvedModulesConfig };
                 })
-                    .forEach(module => {
+                    .filter((entry) => entry !== null)
+                    .forEach(({ module, resolvedModulesConfig }) => {
                     try {
-                        module.configure__(state.config?.modules ?? {});
+                        module.configure__(resolvedModulesConfig);
                         getLogger(state.runtimeConfig, window).debug('MoliGlobal', `configure ${module.moduleType} module ${module.name}`, module.config__());
                         state.runtimeConfig.adPipelineConfig.initSteps.push(...module.initSteps__());
                         state.runtimeConfig.adPipelineConfig.configureSteps.push(...module.configureSteps__());
@@ -296,7 +307,7 @@ export const createMoliTag = (window) => {
                 const isSinglePageApp = config.spa?.enabled === true;
                 if (isSinglePageApp) {
                     const requestAdsRuntimeConfig = state.runtimeConfig;
-                    const initialized = adService.initialize(config, requestAdsRuntimeConfig);
+                    const initialized = adService.initialize(config, requestAdsRuntimeConfig, labelService.isLabelConditionMet);
                     state = {
                         state: 'spa-requestAds',
                         config: config,
@@ -348,7 +359,7 @@ export const createMoliTag = (window) => {
                         runtimeConfig: Object.freeze(state.runtimeConfig)
                     };
                     return adService
-                        .initialize(config, state.runtimeConfig)
+                        .initialize(config, state.runtimeConfig, labelService.isLabelConditionMet)
                         .then(config => adService.requestAds(config, state.runtimeConfig))
                         .then(() => {
                         state = {

package/lib/gen/packageJson.js

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

package/package.json

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