From 9247a89dd9cada5680361129f0a2328e9c8c89ae Mon Sep 17 00:00:00 2001 From: Viktor Dreiling <34981284+3link@users.noreply.github.com> Date: Fri, 27 Jun 2025 10:37:30 +0200 Subject: [PATCH 1/3] Add documentation --- modules/liveIntentAnalyticsAdapter.md | 53 ++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/modules/liveIntentAnalyticsAdapter.md b/modules/liveIntentAnalyticsAdapter.md index 15f51006134..04bace125bd 100644 --- a/modules/liveIntentAnalyticsAdapter.md +++ b/modules/liveIntentAnalyticsAdapter.md @@ -9,13 +9,64 @@ Maintainer: product@liveintent.com Analytics adapter for [LiveIntent](https://www.liveintent.com/). Contact product@liveintent.com for information. +# Configuration + +Customers using GAM and the LiveIntent HIRO snippet for HIRO reporting, and looking to test the Analytics Adapter set up, should add the lines below to their Prebid configuration to enable the analytics module: + +``` +pbjs.setConfig({ + analyticsLabels: { + "partnerId": "did-0000" // your distributor id or application id + } +}); + +pbjs.enableAnalytics({ + provider: 'liveintent', + options: { + sampling: 1 // all winning bid events will be sent to our backend + } +}); +``` + +New customers or customers that are removing the GAM integration for HIRO reporting and the LiveIntent HIRO snippet, the Prebid configuration should set `activatePartialTreatment` to `true`. By default, that will treat only 97% of all page visits and leave 3% untreated (not enriched with LiveIntent-provided IDs). If the desireable treatment rate is different, it can be adjusted by setting `window.liTreatmentRate` to the desired value (between 0.0 and 1.0). + +``` +pbjs.setConfig({ + userSync: { + userIds: [ + { + "name": "liveIntentId", + "params": { + "distributorId": "did-0000", // your distributor id; alternatively, liCollectConfig.appId if you have an application id + "activatePartialTreatment" : true, + "requestedAttributesOverrides": { + 'sovrn': true, + 'medianet': true, + 'bidswitch': true, + ... + } + } + } + ] + } +}); + +The lines below will enable the analytics module: + +pbjs.enableAnalytics({ + provider: 'liveintent', + options: { + sampling: 1 + } +}); +``` + # Test Parameters ``` { provider: 'liveintent', options: { - bidWonTimeout: 2000, sampling: 0.5 // the tracked event percentage, a number between 0 to 1 } } From 4b2ae92c3764a7aa6eb969e3e3b8b95796fb2fc5 Mon Sep 17 00:00:00 2001 From: Viktor Dreiling <34981284+3link@users.noreply.github.com> Date: Fri, 27 Jun 2025 10:37:37 +0200 Subject: [PATCH 2/3] Adjust test set up --- test/spec/modules/liveIntentAnalyticsAdapter_spec.js | 3 --- 1 file changed, 3 deletions(-) diff --git a/test/spec/modules/liveIntentAnalyticsAdapter_spec.js b/test/spec/modules/liveIntentAnalyticsAdapter_spec.js index 2a4e171f347..c30ff582a9e 100644 --- a/test/spec/modules/liveIntentAnalyticsAdapter_spec.js +++ b/test/spec/modules/liveIntentAnalyticsAdapter_spec.js @@ -30,7 +30,6 @@ const USERID_CONFIG = [ const configWithSamplingAll = { provider: 'liveintent', options: { - bidWonTimeout: 2000, sampling: 1, sendAuctionInitEvents: true } @@ -39,7 +38,6 @@ const configWithSamplingAll = { const configWithSamplingNone = { provider: 'liveintent', options: { - bidWonTimeout: 2000, sampling: 0, sendAuctionInitEvents: true } @@ -48,7 +46,6 @@ const configWithSamplingNone = { const configWithNoAuctionInit = { provider: 'liveintent', options: { - bidWonTimeout: 2000, sampling: 1, sendAuctionInitEvents: false } From 7834ef61328352147d02693aaf624e18045bfc34 Mon Sep 17 00:00:00 2001 From: Viktor Dreiling <34981284+3link@users.noreply.github.com> Date: Fri, 27 Jun 2025 10:39:49 +0200 Subject: [PATCH 3/3] Fix typo --- modules/liveIntentAnalyticsAdapter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/liveIntentAnalyticsAdapter.md b/modules/liveIntentAnalyticsAdapter.md index 04bace125bd..9d177951f5b 100644 --- a/modules/liveIntentAnalyticsAdapter.md +++ b/modules/liveIntentAnalyticsAdapter.md @@ -28,7 +28,7 @@ pbjs.enableAnalytics({ }); ``` -New customers or customers that are removing the GAM integration for HIRO reporting and the LiveIntent HIRO snippet, the Prebid configuration should set `activatePartialTreatment` to `true`. By default, that will treat only 97% of all page visits and leave 3% untreated (not enriched with LiveIntent-provided IDs). If the desireable treatment rate is different, it can be adjusted by setting `window.liTreatmentRate` to the desired value (between 0.0 and 1.0). +New customers or customers that are removing the GAM integration for HIRO reporting and the LiveIntent HIRO snippet, the Prebid configuration should set `activatePartialTreatment` to `true`. By default, that will treat only 97% of all page visits and leave 3% untreated (not enriched with LiveIntent-provided IDs). If the desirable treatment rate is different, it can be adjusted by setting `window.liTreatmentRate` to the desired value (between 0.0 and 1.0). ``` pbjs.setConfig({