@highfivve/ad-tag 5.6.3 → 5.7.1

package/lib/ads/a9.js

@@ -3,7 +3,6 @@ import { AssetLoadMethod } from '../util/assetLoaderService';
 import { isSizeEqual } from '../util/sizes';
 import { SizeConfigService } from './sizeConfigService';
 import { tcfapi } from '../types/tcfapi';
-var TCPurpose = tcfapi.responses.TCPurpose;
 import * as adUnitPath from './adUnitPath';
 const isA9SlotDefinition = (slotDefinition) => {
     return !!slotDefinition.moliSlot.a9;
@@ -11,13 +10,13 @@ const isA9SlotDefinition = (slotDefinition) => {
 const hasRequiredConsent = (tcData) => !tcData.gdprApplies ||
     (tcData.vendor.consents['793'] &&
         [
-            TCPurpose.STORE_INFORMATION_ON_DEVICE,
-            TCPurpose.SELECT_BASIC_ADS,
-            TCPurpose.CREATE_PERSONALISED_ADS_PROFILE,
-            TCPurpose.SELECT_PERSONALISED_ADS,
-            TCPurpose.MEASURE_AD_PERFORMANCE,
-            TCPurpose.APPLY_MARKET_RESEARCH,
-            TCPurpose.DEVELOP_IMPROVE_PRODUCTS
+            tcfapi.responses.TCPurpose.STORE_INFORMATION_ON_DEVICE,
+            tcfapi.responses.TCPurpose.SELECT_BASIC_ADS,
+            tcfapi.responses.TCPurpose.CREATE_PERSONALISED_ADS_PROFILE,
+            tcfapi.responses.TCPurpose.SELECT_PERSONALISED_ADS,
+            tcfapi.responses.TCPurpose.MEASURE_AD_PERFORMANCE,
+            tcfapi.responses.TCPurpose.APPLY_MARKET_RESEARCH,
+            tcfapi.responses.TCPurpose.DEVELOP_IMPROVE_PRODUCTS
         ].every(purpose => tcData.purpose.consents[purpose]));
 export const a9Init = (config, assetService) => mkInitStep('a9-init', (context) => new Promise(resolve => {
     context.window__.apstag = context.window__.apstag || {
@@ -84,9 +83,12 @@ export const a9Configure = (config, schainConfig) => mkConfigureStep('a9-configu
         resolve();
     });
 });
-export const a9PublisherAudiences = (config) => mkConfigureStepOnce('a9-publisher-audiences', (context, _slots) => new Promise(resolve => {
-    const publisherAudience = config.publisherAudience;
-    if (publisherAudience && publisherAudience.enabled) {
+export const a9PublisherAudiences = (config, audienceTargeting) => mkConfigureStepOnce('a9-publisher-audiences', (context, _slots) => new Promise(resolve => {
+    const runtimeHem = audienceTargeting?.hem?.sha256;
+    const publisherAudience = runtimeHem !== undefined
+        ? { enabled: !!config.publisherAudience?.enabled, sha256Email: runtimeHem }
+        : config.publisherAudience;
+    if (publisherAudience !== undefined && publisherAudience.enabled) {
         const tokenConfig = {
             hashedRecords: [
                 {

package/lib/ads/adService.js

@@ -96,7 +96,7 @@ export class AdService {
             if (config.a9 && config.a9.enabled !== false && env === 'production' && isGam) {
                 init.push(a9Init(config.a9, this.assetService));
                 configure.push(a9Configure(config.a9, config.schain));
-                configure.push(a9PublisherAudiences(config.a9));
+                configure.push(a9PublisherAudiences(config.a9, runtimeConfig.audience));
                 prepareRequestAds.push(a9ClearTargetingStep());
                 requestBids.push(a9RequestBids(config.a9));
             }

package/lib/ads/criteo.js

@@ -0,0 +1,49 @@
+export const criteoEnrichWithFpd = (runtimeConfig, userSyncConfig, source) => (bidderConfigs) => {
+    const criteoEnabled = userSyncConfig?.userIds?.find(uid => uid.name === 'criteo') !== undefined;
+    if (!criteoEnabled) {
+        return bidderConfigs;
+    }
+    const uids = [];
+    if (runtimeConfig.audience?.hem?.sha256 !== undefined) {
+        uids.push({
+            id: runtimeConfig.audience.hem.sha256,
+            atype: 3,
+            ext: { stype: 'hemsha256' }
+        });
+    }
+    if (runtimeConfig.audience?.hem?.sha256ofMD5 !== undefined) {
+        uids.push({
+            id: runtimeConfig.audience.hem.sha256ofMD5,
+            atype: 3,
+            ext: { stype: 'hemsha256md5' }
+        });
+    }
+    if (uids.length === 0) {
+        return bidderConfigs;
+    }
+    return [
+        ...bidderConfigs.filter(config => !config.options.bidders.every(b => b === 'criteo')),
+        {
+            options: {
+                bidders: ['criteo'],
+                config: {
+                    ortb2: {
+                        user: {
+                            ext: {
+                                data: {
+                                    eids: [
+                                        {
+                                            source: source,
+                                            uids: uids
+                                        }
+                                    ]
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+            merge: true
+        }
+    ];
+};

package/lib/ads/id5.js

@@ -0,0 +1,30 @@
+const createPd = (runtimeConfig) => {
+    const sha256Email = runtimeConfig.audience?.hem?.sha256;
+    if (!sha256Email) {
+        return null;
+    }
+    const pdKeys = {
+        1: sha256Email
+    };
+    const pdRaw = Object.entries(pdKeys)
+        .map(([key, value]) => {
+        return `${key}=${encodeURIComponent(value)}`;
+    })
+        .join('&');
+    return btoa(pdRaw);
+};
+export const enrichId5WithFpd = (runtimeConfig, userIds) => {
+    return userIds?.map(idProvider => {
+        if (idProvider.name === 'id5Id') {
+            const pd = createPd(runtimeConfig);
+            return {
+                ...idProvider,
+                params: {
+                    ...idProvider.params,
+                    ...(pd && { pd })
+                }
+            };
+        }
+        return idProvider;
+    });
+};

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

@@ -60,7 +60,7 @@ export class AdVisibilityService {
         this.setUpdateTimer(true);
         this.logger?.debug('AdVisibilityService', 'initialized');
     }
-    trackSlot(slot, refreshCallback, advertiserId) {
+    trackSlot(slot, refreshCallback, advertiserId, companyIds) {
         const slotDomId = slot.getSlotElementId();
         const domElement = this.observedDomElementForSlot(slot);
         if (domElement) {
@@ -75,9 +75,11 @@ export class AdVisibilityService {
                     (override?.variant === 'disabled' &&
                         (override.disableAllAdVisibilityChecks ||
                             !(override.disabledAdVisibilityCheckAdvertiserIds &&
-                                override.disabledAdVisibilityCheckAdvertiserIds.length > 0 &&
-                                advertiserId) ||
-                            override.disabledAdVisibilityCheckAdvertiserIds.includes(advertiserId)))
+                                override.disabledAdVisibilityCheckAdvertiserIds.length > 0) ||
+                            (advertiserId &&
+                                override.disabledAdVisibilityCheckAdvertiserIds.includes(advertiserId)) ||
+                            (companyIds &&
+                                override.disabledAdVisibilityCheckAdvertiserIds.some(id => companyIds.includes(id)))))
                     ? this.window.performance.now()
                     : undefined,
                 durationVisibleSum: 0,

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

@@ -28,12 +28,13 @@ export class AdReload {
             this.adVisibilityService = new AdVisibilityService(new UserActivityService(window, config.userActivityLevelControl, logger), this.refreshIntervalMs, config.refreshIntervalMsOverrides ?? {}, false, !!config.disableAdVisibilityChecks, config.viewabilityOverrides ?? {}, window, logger);
         };
         this.setupSlotRenderListener = (config, slotsToMonitor, reloadAdSlotCallback, window, logger) => window.googletag.pubads().addEventListener('slotRenderEnded', renderEndedEvent => {
-            const { slot: googleTagSlot, campaignId, advertiserId, yieldGroupIds, isEmpty: slotIsEmpty } = renderEndedEvent;
+            const { slot: googleTagSlot, campaignId, advertiserId, companyIds, yieldGroupIds, isEmpty: slotIsEmpty } = renderEndedEvent;
             const slotDomId = googleTagSlot.getSlotElementId();
             const slotIsMonitored = slotsToMonitor.indexOf(slotDomId) > -1;
             const orderIdNotExcluded = !campaignId || config.excludeOrderIds.indexOf(campaignId) === -1;
             const orderIdIncluded = !!campaignId && config.includeOrderIds.indexOf(campaignId) > -1;
-            const advertiserIdIncluded = !!advertiserId && config.includeAdvertiserIds.indexOf(advertiserId) > -1;
+            const advertiserIdIncluded = (!!advertiserId && config.includeAdvertiserIds.indexOf(advertiserId) > -1) ||
+                (!!companyIds && config.includeAdvertiserIds.some(id => companyIds.includes(id)));
             const yieldGroupIdIncluded = !!yieldGroupIds && config.includeYieldGroupIds.some(id => yieldGroupIds.indexOf(id) > -1);
             const trackingSlotAllowed = !slotIsEmpty &&
                 slotIsMonitored &&
@@ -51,7 +52,7 @@ export class AdReload {
             }
             const slotAlreadyTracked = !!this.adVisibilityService?.isSlotTracked(slotDomId);
             if (trackingSlotAllowed) {
-                this.adVisibilityService.trackSlot(googleTagSlot, reloadAdSlotCallback, advertiserId);
+                this.adVisibilityService.trackSlot(googleTagSlot, reloadAdSlotCallback, advertiserId, companyIds);
             }
             else if (slotAlreadyTracked) {
                 this.adVisibilityService.removeSlotTracking(googleTagSlot);

package/lib/ads/modules/emetriq/trackLoginEvent.js

@@ -32,7 +32,13 @@ export const trackLoginEvent = (context, moduleConfig, document, logger) => {
         return;
     }
     const url = new URL(`https://xdn-ttp.de/lns/import-event-${moduleConfig.login.partner}`);
-    url.searchParams.append('guid', moduleConfig.login.guid);
+    const hemSha256 = context.runtimeConfig__.audience?.hem?.sha256;
+    const resolvedGuid = hemSha256 !== undefined ? context.window__.btoa(hemSha256) : moduleConfig.login.guid;
+    if (resolvedGuid === undefined) {
+        logger.warn('emetriq', 'no guid provided for login event tracking');
+        return;
+    }
+    url.searchParams.append('guid', resolvedGuid);
     if (context.tcData__.gdprApplies) {
         url.searchParams.append('gdpr', '1');
         url.searchParams.append('gdpr_consent', context.tcData__.tcString);

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

@@ -42,9 +42,22 @@ export class IdentityLink {
         }
         const window = context.window__;
         window.addEventListener('envelopeModuleReady', () => {
+            const hashedEmailAddresses = [...moduleConfig.hashedEmailAddresses];
+            const sha1 = context.runtimeConfig__.audience?.hem?.sha1;
+            const sha256 = context.runtimeConfig__.audience?.hem?.sha256;
+            const md5 = context.runtimeConfig__.audience?.hem?.md5;
+            if (sha1 !== undefined) {
+                hashedEmailAddresses[0] = sha1;
+            }
+            if (sha256 !== undefined) {
+                hashedEmailAddresses[1] = sha256;
+            }
+            if (md5 !== undefined) {
+                hashedEmailAddresses[2] = md5;
+            }
             window.atsenvelopemodule.setAdditionalData({
                 type: 'emailHashes',
-                id: moduleConfig.hashedEmailAddresses
+                id: hashedEmailAddresses
             });
         });
         return context.assetLoaderService__

package/lib/ads/modules/interstitial/interstitialAd.js

@@ -14,6 +14,10 @@ const interstitialRenderedEvent = (interstitialDomId, disallowedAdvertiserIds, w
         else if (event.advertiserId && disallowedAdvertiserIds.includes(event.advertiserId)) {
             resolve({ result: 'disallowed', slot: event.slot });
         }
+        else if (event.companyIds &&
+            disallowedAdvertiserIds.some(id => event.companyIds?.includes(id))) {
+            resolve({ result: 'disallowed', slot: event.slot });
+        }
         else {
             event.slot.setConfig({ safeFrame: { forceSafeFrame: true } });
             resolve({ result: 'standard', slot: event.slot });

package/lib/ads/modules/sticky-footer-ad/desktopFloorAd.js

@@ -22,6 +22,7 @@ const renderFooterAd = (window, floorAdDomId, disallowedAdvertiserIds, log) => (
         slot.getSlotElementId() !== floorAdDomId ||
         event.isEmpty ||
         (!!event.advertiserId && disallowedAdvertiserIds.includes(event.advertiserId)) ||
+        (!!event.companyIds && disallowedAdvertiserIds.some(id => event.companyIds?.includes(id))) ||
         window.matchMedia('(max-width: 767px)').matches) {
         log.debug('[footer-ad]', 'remove footer ad container');
         return;

package/lib/ads/modules/sticky-footer-ad/mobileSticky.js

@@ -23,6 +23,10 @@ const stickyRenderedEvent = (adSticky, mobileStickyDomId, disallowedAdvertiserId
         else if (!!event.advertiserId && disallowedAdvertiserIds.includes(event.advertiserId)) {
             resolve('disallowed');
         }
+        else if (!!event.companyIds &&
+            disallowedAdvertiserIds.some(id => event.companyIds?.includes(id))) {
+            resolve('disallowed');
+        }
         else {
             resolve('standard');
         }

package/lib/ads/modules/sticky-footer-ad-v2/footerStickyAd.js

@@ -15,6 +15,10 @@ const stickyRenderedEvent = (mobileStickyDomId, disallowedAdvertiserIds, window)
         else if (event.advertiserId && disallowedAdvertiserIds.includes(event.advertiserId)) {
             resolve('disallowed');
         }
+        else if (!!event.companyIds &&
+            disallowedAdvertiserIds.some(id => event.companyIds?.includes(id))) {
+            resolve('disallowed');
+        }
         else {
             resolve('standard');
         }

package/lib/ads/modules/sticky-header-ad/renderResult.js

@@ -10,6 +10,10 @@ export const adRenderResult = (ctx, headerSlot, disallowedAdvertiserIds, minVisi
         if (event.advertiserId && disallowedAdvertiserIds.includes(event.advertiserId)) {
             resolve('disallowed');
         }
+        else if (event.companyIds &&
+            disallowedAdvertiserIds.some(id => event.companyIds?.includes(id))) {
+            resolve('disallowed');
+        }
         else if (event.isEmpty) {
             resolve('empty');
         }

package/lib/ads/moli.js

@@ -589,6 +589,24 @@ export const createMoliTag = (window) => {
             addLabel(domain);
         }
     }
+    function setAudience(audience) {
+        switch (state.state) {
+            case 'configurable':
+            case 'configured': {
+                state.runtimeConfig.audience = audience;
+                break;
+            }
+            case 'spa-finished':
+            case 'spa-requestAds': {
+                state.nextRuntimeConfig.audience = audience;
+                break;
+            }
+            default: {
+                getLogger(state.runtimeConfig, window).error('MoliGlobal', `Setting audience targeting after configuration: ${JSON.stringify(audience)}`);
+                break;
+            }
+        }
+    }
     function newEmptyRuntimeConfig(previous, options) {
         return {
             environment: previous?.environment ?? 'production',
@@ -639,6 +657,7 @@ export const createMoliTag = (window) => {
         triggerDelay: triggerDelay,
         getState: getState,
         openConsole: openConsole,
+        setAudience: setAudience,
         addEventListener: eventService.addEventListener,
         removeEventListener: eventService.removeEventListener
     };

package/lib/ads/prebid.js

@@ -8,6 +8,8 @@ import { AssetLoadMethod } from '../util/assetLoaderService';
 import { packageJson } from 'ad-tag/gen/packageJson';
 import { prebidOutstreamRenderer } from 'ad-tag/ads/prebid-outstream';
 import { isGamInterstitial } from 'ad-tag/ads/auctions/interstitialContext';
+import { criteoEnrichWithFpd } from 'ad-tag/ads/criteo';
+import { enrichId5WithFpd } from 'ad-tag/ads/id5';
 const prebidTimeout = (context) => {
     return new Promise((_, reject) => {
         context.window__.setTimeout(() => reject('Prebid did not resolve in time. Maybe you forgot to import the prebid distribution in the ad tag'), 5000);
@@ -152,7 +154,8 @@ export const prebidInit = (assetService) => mkInitStep('prebid-init', context =>
 });
 export const prebidRemoveAdUnits = (prebidConfig) => mkConfigureStep('prebid-remove-adunits', (context) => new Promise(resolve => {
     if (prebidConfig.ephemeralAdUnits !== true) {
-        context.window__.pbjs = context.window__.pbjs || { que: [] };
+        context.window__.pbjs =
+            context.window__.pbjs || { que: [] };
         const adUnits = context.window__.pbjs.adUnits;
         if (adUnits) {
             context.window__.pbjs.que.push(() => {
@@ -165,7 +168,8 @@ export const prebidRemoveAdUnits = (prebidConfig) => mkConfigureStep('prebid-rem
 }));
 export const prebidClearAuction = () => {
     return mkConfigureStepOncePerRequestAdsCycle('prebid-clear-auction', (context) => new Promise(resolve => {
-        context.window__.pbjs = context.window__.pbjs || { que: [] };
+        context.window__.pbjs =
+            context.window__.pbjs || { que: [] };
         context.window__.pbjs.que.push(() => {
             context.logger__.debug('Prebid', 'Clearing prebid auctions');
             context.window__.pbjs.clearAllAuctions();
@@ -203,12 +207,19 @@ export const prebidConfigure = (prebidConfig, schainConfig) => {
                             }
                         });
                     }
+                    const enrichedUserIds = enrichId5WithFpd(context.runtimeConfig__, prebidConfig.config.userSync?.userIds);
                     context.window__.pbjs.setConfig({
                         ...prebidConfig.config,
                         ...{ schain: mkSupplyChainConfig([schainConfig.supplyChainStartNode]) },
-                        ...{ floors: prebidConfig.config.floors || {} }
+                        ...{ floors: prebidConfig.config.floors || {} },
+                        ...{
+                            userSync: prebidConfig.config.userSync
+                                ? { ...prebidConfig.config.userSync, userIds: enrichedUserIds }
+                                : prebidConfig.config.userSync
+                        }
                     });
-                    prebidConfig.bidderConfigs?.forEach(({ options, merge }) => {
+                    const bidderConfigs = criteoEnrichWithFpd(context.runtimeConfig__, prebidConfig.config.userSync, context.window__.location.host)(prebidConfig.bidderConfigs || []);
+                    bidderConfigs.forEach(({ options, merge }) => {
                         context.window__.pbjs.setBidderConfig(options, merge);
                     });
                     prebidConfig.schain.nodes.forEach(({ bidder, node, appendNode }) => {

package/lib/gen/packageJson.js

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

package/package.json

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