prebid.js 9.2.0 → 9.4.0

package/modules/intentIqIdSystem.js

@@ -10,6 +10,9 @@ import { ajax } from '../src/ajax.js';
 import { submodule } from '../src/hook.js'
 import { getStorageManager } from '../src/storageManager.js';
 import { MODULE_TYPE_UID } from '../src/activities/modules.js';
+import { gppDataHandler, uspDataHandler } from '../src/consentHandler.js';
+import AES from 'crypto-js/aes.js';
+import Utf8 from 'crypto-js/enc-utf8.js';
 
 /**
  * @typedef {import('../modules/userId/index.js').Submodule} Submodule
@@ -21,11 +24,31 @@ const PCID_EXPIRY = 365;
 
 const MODULE_NAME = 'intentIqId';
 export const FIRST_PARTY_KEY = '_iiq_fdata';
-export var FIRST_PARTY_DATA_KEY = '_iiq_fdata';
-
-export const storage = getStorageManager({ moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME });
+export let FIRST_PARTY_DATA_KEY = '_iiq_fdata';
+export const WITH_IIQ = 'A';
+export const WITHOUT_IIQ = 'B';
+export const NOT_YET_DEFINED = 'U';
+export const OPT_OUT = 'O';
+export const BLACK_LIST = 'L';
+export const CLIENT_HINTS_KEY = '_iiq_ch';
+export const EMPTY = 'EMPTY'
+export const VERSION = 0.1
 
+const encoderCH = {
+  brands: 0,
+  mobile: 1,
+  platform: 2,
+  architecture: 3,
+  bitness: 4,
+  model: 5,
+  platformVersion: 6,
+  wow64: 7,
+  fullVersionList: 8
+};
 const INVALID_ID = 'INVALID_ID';
+const SUPPORTED_TYPES = ['html5', 'cookie']
+
+export const storage = getStorageManager({ moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME });
 
 /**
  * Generate standard UUID string
@@ -42,16 +65,35 @@ function generateGUID() {
 }
 
 /**
- * Read Intent IQ data from cookie or local storage
+ * Encrypts plaintext.
+ * @param {string} plainText The plaintext to encrypt.
+ * @returns {string} The encrypted text as a base64 string.
+ */
+export function encryptData(plainText) {
+  return AES.encrypt(plainText, MODULE_NAME).toString();
+}
+
+/**
+ * Decrypts ciphertext.
+ * @param {string} encryptedText The encrypted text as a base64 string.
+ * @returns {string} The decrypted plaintext.
+ */
+export function decryptData(encryptedText) {
+  const bytes = AES.decrypt(encryptedText, MODULE_NAME);
+  return bytes.toString(Utf8);
+}
+
+/**
+ * Read Intent IQ data from local storage or cookie
  * @param key
  * @return {string}
  */
-export function readData(key) {
+export function readData(key, allowedStorage) {
   try {
-    if (storage.hasLocalStorage()) {
+    if (storage.hasLocalStorage() && allowedStorage.includes('html5')) {
       return storage.getDataFromLocalStorage(key);
     }
-    if (storage.cookiesAreEnabled()) {
+    if (storage.cookiesAreEnabled() && allowedStorage.includes('cookie')) {
       return storage.getCookie(key);
     }
   } catch (error) {
@@ -60,21 +102,20 @@ export function readData(key) {
 }
 
 /**
- * Store Intent IQ data in either cookie or local storage
+ * Store Intent IQ data in cookie, local storage or both of them
  * expiration date: 365 days
  * @param key
  * @param {string} value IntentIQ ID value to sintentIqIdSystem_spec.jstore
  */
-function storeData(key, value, cookieStorageEnabled = false) {
+export function storeData(key, value, allowedStorage) {
   try {
     logInfo(MODULE_NAME + ': storing data: key=' + key + ' value=' + value);
-
     if (value) {
-      if (storage.hasLocalStorage()) {
+      if (storage.hasLocalStorage() && allowedStorage.includes('html5')) {
         storage.setDataInLocalStorage(key, value);
       }
-      const expiresStr = (new Date(Date.now() + (PCID_EXPIRY * (60 * 60 * 24 * 1000)))).toUTCString();
-      if (storage.cookiesAreEnabled() && cookieStorageEnabled) {
+      if (storage.cookiesAreEnabled() && allowedStorage.includes('cookie')) {
+        const expiresStr = (new Date(Date.now() + (PCID_EXPIRY * (60 * 60 * 24 * 1000)))).toUTCString();
         storage.setCookie(key, value, expiresStr, 'LAX');
       }
     }
@@ -83,10 +124,28 @@ function storeData(key, value, cookieStorageEnabled = false) {
   }
 }
 
+/**
+ * Remove Intent IQ data from cookie or local storage
+ * @param key
+ */
+
+export function removeDataByKey(key, allowedStorage) {
+  try {
+    if (storage.hasLocalStorage() && allowedStorage.includes('html5')) {
+      storage.removeDataFromLocalStorage(key);
+    }
+    if (storage.cookiesAreEnabled() && allowedStorage.includes('cookie')) {
+      const expiredDate = new Date(0).toUTCString();
+      storage.setCookie(key, '', expiredDate, 'LAX');
+    }
+  } catch (error) {
+    logError(error);
+  }
+}
+
 /**
  * Parse json if possible, else return null
  * @param data
- * @param {object|null}
  */
 function tryParse(data) {
   try {
@@ -97,6 +156,125 @@ function tryParse(data) {
   }
 }
 
+/**
+ * Convert GPP data to an object
+ * @param {Object} data
+ * @return {string} The JSON string representation of the input data.
+ */
+export function handleGPPData(data = {}) {
+  if (Array.isArray(data)) {
+    let obj = {};
+    for (const element of data) {
+      obj = Object.assign(obj, element);
+    }
+    return JSON.stringify(obj);
+  }
+  return JSON.stringify(data);
+}
+
+/**
+ * Detects the browser using either userAgent or userAgentData
+ * @return {string} The name of the detected browser or 'unknown' if unable to detect
+ */
+function detectBrowser() {
+  try {
+    if (navigator.userAgent) {
+      return detectBrowserFromUserAgent(navigator.userAgent);
+    } else if (navigator.userAgentData) {
+      return detectBrowserFromUserAgentData(navigator.userAgentData);
+    }
+  } catch (error) {
+    logError('Error detecting browser:', error);
+  }
+  return 'unknown';
+}
+
+/**
+ * Detects the browser from the user agent string
+ * @param {string} userAgent - The user agent string from the browser
+ * @return {string} The name of the detected browser or 'unknown' if unable to detect
+ */
+export function detectBrowserFromUserAgent(userAgent) {
+  const browserRegexPatterns = {
+    opera: /Opera|OPR/,
+    edge: /Edg/,
+    chrome: /Chrome|CriOS/,
+    safari: /Safari/,
+    firefox: /Firefox/,
+    ie: /MSIE|Trident/,
+  };
+
+  // Check for Chrome first to avoid confusion with Safari
+  if (browserRegexPatterns.chrome.test(userAgent)) {
+    return 'chrome';
+  }
+
+  // Now we can safely check for Safari
+  if (browserRegexPatterns.safari.test(userAgent) && !browserRegexPatterns.chrome.test(userAgent)) {
+    return 'safari';
+  }
+
+  // Check other browsers
+  for (const browser in browserRegexPatterns) {
+    if (browserRegexPatterns[browser].test(userAgent)) {
+      return browser;
+    }
+  }
+
+  return 'unknown';
+}
+
+/**
+ * Detects the browser from the NavigatorUAData object
+ * @param {NavigatorUAData} userAgentData - The user agent data object from the browser
+ * @return {string} The name of the detected browser or 'unknown' if unable to detect
+ */
+export function detectBrowserFromUserAgentData(userAgentData) {
+  const brandNames = userAgentData.brands.map(brand => brand.brand);
+
+  if (brandNames.includes('Microsoft Edge')) {
+    return 'edge';
+  } else if (brandNames.includes('Opera')) {
+    return 'opera';
+  } else if (brandNames.some(brand => brand === 'Chromium' || brand === 'Google Chrome')) {
+    return 'chrome';
+  }
+
+  return 'unknown';
+}
+
+/**
+ * Processes raw client hints data into a structured format.
+ * @param {object} clientHints - Raw client hints data
+ * @return {string} A JSON string of processed client hints or an empty string if no hints
+ */
+export function handleClientHints(clientHints) {
+  const chParams = {};
+  for (const key in clientHints) {
+    if (clientHints.hasOwnProperty(key) && clientHints[key] !== '') {
+      if (['brands', 'fullVersionList'].includes(key)) {
+        let handledParam = '';
+        clientHints[key].forEach((element, index) => {
+          const isNotLast = index < clientHints[key].length - 1;
+          handledParam += `"${element.brand}";v="${element.version}"${isNotLast ? ', ' : ''}`;
+        });
+        chParams[encoderCH[key]] = handledParam;
+      } else if (typeof clientHints[key] === 'boolean') {
+        chParams[encoderCH[key]] = `?${clientHints[key] ? 1 : 0}`;
+      } else {
+        chParams[encoderCH[key]] = `"${clientHints[key]}"`;
+      }
+    }
+  }
+  return Object.keys(chParams).length ? JSON.stringify(chParams) : '';
+}
+
+function defineStorageType(params) {
+  if (!params || !Array.isArray(params)) return ['html5']; // use locale storage be default
+  const filteredArr = params.filter(item => SUPPORTED_TYPES.includes(item));
+  return filteredArr.length ? filteredArr : ['html5'];
+}
+
 /** @type {Submodule} */
 export const intentIqIdSubmodule = {
   /**
@@ -120,25 +298,136 @@ export const intentIqIdSubmodule = {
    * @returns {IdResponse|undefined}
    */
   getId(config) {
-    const configParams = (config && config.params) || {};
-    if (!configParams || typeof configParams.partner !== 'number') {
+    const configParams = (config?.params) || {};
+    let decryptedData, callbackTimeoutID;
+    let callbackFired = false
+    let runtimeEids = {}
+
+    const firePartnerCallback = () => {
+      if (configParams.callback && !callbackFired) {
+        callbackFired = true;
+        if (callbackTimeoutID) clearTimeout(callbackTimeoutID);
+        configParams.callback(runtimeEids, firstPartyData?.group || NOT_YET_DEFINED);
+      }
+    }
+
+    callbackTimeoutID = setTimeout(() => {
+      firePartnerCallback();
+    }, configParams.timeoutInMillis || 500
+    );
+
+    if (typeof configParams.partner !== 'number') {
       logError('User ID - intentIqId submodule requires a valid partner to be defined');
+      firePartnerCallback()
       return;
     }
-    const cookieStorageEnabled = typeof configParams.enableCookieStorage === 'boolean' ? configParams.enableCookieStorage : false
-    if (!FIRST_PARTY_DATA_KEY.includes(configParams.partner)) { FIRST_PARTY_DATA_KEY += '_' + configParams.partner; }
     let rrttStrtTime = 0;
+    let partnerData = {};
+    let shouldCallServer = false
+
+    const currentBrowserLowerCase = detectBrowser();
+    const browserBlackList = typeof configParams.browserBlackList === 'string' ? configParams.browserBlackList.toLowerCase() : '';
+    const allowedStorage = defineStorageType(config.enabledStorageTypes);
+
+    // Check if current browser is in blacklist
+    if (browserBlackList?.includes(currentBrowserLowerCase)) {
+      logError('User ID - intentIqId submodule: browser is in blacklist!');
+      if (configParams.callback) configParams.callback('', BLACK_LIST);
+      return;
+    }
+
+    // Get consent information
+    const cmpData = {};
+    const uspData = uspDataHandler.getConsentData();
+    const gppData = gppDataHandler.getConsentData();
+
+    if (uspData) {
+      cmpData.us_privacy = uspData;
+    }
+
+    if (gppData) {
+      cmpData.gpp = '';
+      cmpData.gpi = 1;
+
+      if (gppData.parsedSections && 'usnat' in gppData.parsedSections) {
+        cmpData.gpp = handleGPPData(gppData.parsedSections['usnat']);
+        cmpData.gpi = 0
+      }
+      cmpData.gpp_sid = gppData.applicableSections;
+    }
+
+    // Read client hints from storage
+    let clientHints = readData(CLIENT_HINTS_KEY, allowedStorage);
+
+    // Get client hints and save to storage
+    if (navigator.userAgentData) {
+      navigator.userAgentData
+        .getHighEntropyValues([
+          'brands',
+          'mobile',
+          'bitness',
+          'wow64',
+          'architecture',
+          'model',
+          'platform',
+          'platformVersion',
+          'fullVersionList'
+        ])
+        .then(ch => {
+          clientHints = handleClientHints(ch);
+          storeData(CLIENT_HINTS_KEY, clientHints, allowedStorage)
+        });
+    }
+
+    if (!FIRST_PARTY_DATA_KEY.includes(configParams.partner)) {
+      FIRST_PARTY_DATA_KEY += '_' + configParams.partner;
+    }
 
     // Read Intent IQ 1st party id or generate it if none exists
-    let firstPartyData = tryParse(readData(FIRST_PARTY_KEY));
-    if (!firstPartyData || !firstPartyData.pcid || firstPartyData.pcidDate) {
+    let firstPartyData = tryParse(readData(FIRST_PARTY_KEY, allowedStorage));
+
+    if (!firstPartyData?.pcid) {
       const firstPartyId = generateGUID();
-      firstPartyData = { 'pcid': firstPartyId, 'pcidDate': Date.now() };
-      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), cookieStorageEnabled);
+      firstPartyData = { pcid: firstPartyId, pcidDate: Date.now(), group: NOT_YET_DEFINED, cttl: 0, uspapi_value: EMPTY, gpp_value: EMPTY, date: Date.now() };
+      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), allowedStorage);
+    } else if (!firstPartyData.pcidDate) {
+      firstPartyData.pcidDate = Date.now();
+      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), allowedStorage);
+    }
+
+    const savedData = tryParse(readData(FIRST_PARTY_DATA_KEY, allowedStorage))
+    if (savedData) {
+      partnerData = savedData;
+    }
+
+    if (partnerData.data) {
+      if (partnerData.data.length) { // encrypted data
+        decryptedData = tryParse(decryptData(partnerData.data));
+        runtimeEids = decryptedData;
+      }
     }
 
-    let partnerData = tryParse(readData(FIRST_PARTY_DATA_KEY));
-    if (!partnerData) partnerData = {};
+    if (!firstPartyData.cttl || Date.now() - firstPartyData.date > firstPartyData.cttl || firstPartyData.uspapi_value !== cmpData.us_privacy || firstPartyData.gpp_value !== cmpData.gpp) {
+      firstPartyData.uspapi_value = cmpData.us_privacy;
+      firstPartyData.gpp_value = cmpData.gpp;
+      firstPartyData.isOptedOut = false
+      firstPartyData.cttl = 0
+      shouldCallServer = true;
+      partnerData.data = {}
+      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), allowedStorage);
+      storeData(FIRST_PARTY_DATA_KEY, JSON.stringify(partnerData), allowedStorage);
+    } else if (firstPartyData.isOptedOut) {
+      firePartnerCallback()
+    }
+
+    if (firstPartyData.group === WITHOUT_IIQ || (firstPartyData.group !== WITHOUT_IIQ && runtimeEids && Object.keys(runtimeEids).length)) {
+      firePartnerCallback()
+    }
+
+    if (!shouldCallServer) {
+      firePartnerCallback();
+      return { id: runtimeEids };
+    }
 
     // use protocol relative urls for http or https
     let url = `https://api.intentiq.com/profiles_engine/ProfilesEngineServlet?at=39&mi=10&dpi=${configParams.partner}&pt=17&dpn=1`;
@@ -149,42 +438,97 @@ export const intentIqIdSubmodule = {
     url += (partnerData.cttl) ? '&cttl=' + encodeURIComponent(partnerData.cttl) : '';
     url += (partnerData.rrtt) ? '&rrtt=' + encodeURIComponent(partnerData.rrtt) : '';
     url += firstPartyData.pcidDate ? '&iiqpciddate=' + encodeURIComponent(firstPartyData.pcidDate) : '';
+    url += cmpData.us_privacy ? '&pa=' + encodeURIComponent(cmpData.us_privacy) : '';
+    url += cmpData.gpp ? '&gpv=' + encodeURIComponent(cmpData.gpp) : '';
+    url += cmpData.gpi ? '&gpi=' + cmpData.gpi : '';
+    url += clientHints ? '&uh=' + encodeURIComponent(clientHints) : '';
+    url += VERSION ? '&jsver=' + VERSION : '';
+    url += firstPartyData?.group ? '&testGroup=' + encodeURIComponent(firstPartyData.group) : '';
+
+    const storeFirstPartyData = () => {
+      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), allowedStorage);
+      storeData(FIRST_PARTY_DATA_KEY, JSON.stringify(partnerData), allowedStorage);
+    }
 
     const resp = function (callback) {
       const callbacks = {
         success: response => {
           let respJson = tryParse(response);
           // If response is a valid json and should save is true
-          if (respJson && respJson.ls) {
-            // Store pid field if found in response json
-            let shouldUpdateLs = false;
-            if ('pid' in respJson) {
-              firstPartyData.pid = respJson.pid;
-              shouldUpdateLs = true;
+          if (respJson) {
+            partnerData.date = Date.now();
+            firstPartyData.date = Date.now();
+            const defineEmptyDataAndFireCallback = () => {
+              respJson.data = partnerData.data = runtimeEids = {};
+              removeDataByKey(FIRST_PARTY_DATA_KEY, allowedStorage)
+              firePartnerCallback()
+              callback()
             }
+            if (callbackTimeoutID) clearTimeout(callbackTimeoutID)
             if ('cttl' in respJson) {
-              partnerData.cttl = respJson.cttl;
-              shouldUpdateLs = true;
+              firstPartyData.cttl = respJson.cttl;
+            } else firstPartyData.cttl = 86400000;
+
+            if ('tc' in respJson) {
+              partnerData.terminationCause = respJson.tc;
+              if (respJson.tc == 41) {
+                firstPartyData.group = WITHOUT_IIQ;
+                storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), allowedStorage);
+                defineEmptyDataAndFireCallback();
+                return;
+              } else {
+                firstPartyData.group = WITH_IIQ;
+              }
             }
-            // If should save and data is empty, means we should save as INVALID_ID
-            if (respJson.data == '') {
-              respJson.data = INVALID_ID;
-            } else {
+            if ('isOptedOut' in respJson) {
+              if (respJson.isOptedOut !== firstPartyData.isOptedOut) {
+                firstPartyData.isOptedOut = respJson.isOptedOut;
+              }
+              if (respJson.isOptedOut === true) {
+                firstPartyData.group = OPT_OUT;
+                storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), allowedStorage);
+                defineEmptyDataAndFireCallback()
+                return;
+              }
+            }
+            if ('pid' in respJson) {
+              firstPartyData.pid = respJson.pid;
+            }
+            if ('ls' in respJson) {
+              if (respJson.ls === false) {
+                defineEmptyDataAndFireCallback();
+                return
+              }
+              // If data is empty, means we should save as INVALID_ID
+              if (respJson.data == '') {
+                respJson.data = INVALID_ID;
+              } else {
+                // If data is a single string, assume it is an id with source intentiq.com
+                if (respJson.data && typeof respJson.data === 'string') {
+                  respJson.data = { eids: [respJson.data] }
+                }
+              }
               partnerData.data = respJson.data;
-              shouldUpdateLs = true;
             }
+
             if (rrttStrtTime && rrttStrtTime > 0) {
               partnerData.rrtt = Date.now() - rrttStrtTime;
-              shouldUpdateLs = true;
             }
-            if (shouldUpdateLs === true) {
-              partnerData.date = Date.now();
-              storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), cookieStorageEnabled);
-              storeData(FIRST_PARTY_DATA_KEY, JSON.stringify(partnerData), cookieStorageEnabled);
+
+            if (respJson.data?.eids) {
+              runtimeEids = respJson.data.eids
+              callback(respJson.data.eids);
+              firePartnerCallback()
+              const encryptedData = encryptData(JSON.stringify(respJson.data.eids))
+              partnerData.data = encryptedData;
+            } else {
+              callback();
+              firePartnerCallback()
             }
-            callback(respJson.data);
+            storeFirstPartyData();
           } else {
             callback();
+            firePartnerCallback()
           }
         },
         error: error => {
@@ -192,18 +536,32 @@ export const intentIqIdSubmodule = {
           callback();
         }
       };
-      if (partnerData.date && partnerData.cttl && partnerData.data &&
-        Date.now() - partnerData.date < partnerData.cttl) { callback(partnerData.data); } else {
-        rrttStrtTime = Date.now();
-        ajax(url, callbacks, undefined, { method: 'GET', withCredentials: true });
-      }
+
+      ajax(url, callbacks, undefined, { method: 'GET', withCredentials: true });
     };
-    return { callback: resp };
+    const respObj = { callback: resp };
+    if (runtimeEids?.length) respObj.id = runtimeEids;
+    return respObj
   },
   eids: {
     'intentIqId': {
       source: 'intentiq.com',
-      atype: 1
+      atype: 1,
+      getSource: function (data) {
+        return data.source;
+      },
+      getValue: function (data) {
+        if (data?.uids?.length) {
+          return data.uids[0].id
+        }
+        return null
+      },
+      getUidExt: function (data) {
+        if (data?.uids?.length) {
+          return data.uids[0].ext;
+        }
+        return null
+      }
     },
   }
 };

package/modules/intentIqIdSystem.md

@@ -0,0 +1,92 @@
+```
+Module Name: IntentIQ Id System
+Module Type: Id System
+Maintainer: julian@intentiq.com, dmytro.piskun@intentiq.com
+usp_supported: true
+gpp_sids: usnat
+```
+
+# Intent IQ Universal ID module
+
+By leveraging the Intent IQ identity graph, our module helps publishers, SSPs, and DSPs overcome the challenges of monetizing cookie-less inventory and preparing for a future without 3rd-party cookies. Our solution implements 1st-party data clustering and provides Intent IQ person IDs with over 90% coverage and unmatched accuracy in supported countries while remaining privacy-friendly and CCPA compliant. This results in increased CPMs, higher fill rates, and, ultimately, lifting overall revenue
+
+# All you need is a few basic steps to start using our solution.
+
+## Registration
+
+Navigate to [our portal ](https://www.intentiq.com/) and contact our team for partner ID.
+check our [documentation](https://pbmodule.documents.intentiq.com/) to get more information about our solution and how utilze it's full potential
+
+## Integration
+
+```
+gulp build –modules=intentIqIdSystem
+```
+
+We recommend including the Intent IQ Analytics adapter module for improved visibility
+
+## Configuration
+
+### Parameters
+
+Please find below list of paramters that could be used in configuring Intent IQ Universal ID module
+
+| Param under userSync.userIds[] | Scope    | Type     | Description                                                                                                                         | Example                                         |
+| ------------------------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
+| name                           | Required | String   | The name of this module: "intentIqId"                                                                                               | `"intentIqId"`                                  |
+| params                         | Required | Object   | Details for IntentIqId initialization.                                                                                              |                                                 |
+| params.partner                 | Required | Number   | This is the partner ID value obtained from registering with IntentIQ.                                                               | `1177538`                                       |
+| params.pcid                    | Optional | String   | This is the partner cookie ID, it is a dynamic value attached to the request.                                                       | `"g3hC52b"`                                     |
+| params.pai                     | Optional | String   | This is the partner customer ID / advertiser ID, it is a dynamic value attached to the request.                                     | `"advertiser1"`                                 |
+| params.callback                | Required | Function | This is a callback which is trigered with data and AB group                                                                         | `(data, group) => console.log({ data, group })` |
+| params.timeoutInMillis         | Optional | Number   | This is the timeout in milliseconds, which defines the maximum duration before the callback is triggered. The default value is 500. | `450`                                           |
+| params.browserBlackList        | Optional |  String  | This is the name of a browser that can be added to a blacklist.                                                                     | `"chrome"`                                      |
+
+### Configuration example
+
+```javascript
+pbjs.setConfig({
+  userSync: {
+    userIds: [
+      {
+        name: "intentIqId",
+        params: {
+          partner: 123456, // valid partner id
+          callback: (data, group) => window.pbjs.requestBids(),
+        },
+        storage: {
+          type: "html5",
+          name: "intentIqId", // set localstorage with this name
+          expires: 60,
+          refreshInSeconds: 4 * 3600, // refresh ID every 4 hours to ensure it's fresh
+        },
+      },
+    ],
+    syncDelay: 3000,
+  },
+});
+```
+
+```javascript
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: "intentIqId",
+            params: {
+                partner: 123456     // valid partner id
+                pcid: PCID_VARIABLE,   // string value, dynamically loaded into a variable before setting the configuration
+                pai: PAI_VARIABLE ,  // string value, dynamically loaded into a variable before setting the configuration
+                timeoutInMillis: 500,
+                browserBlackList: "chrome",
+                callback: (data, group) => window.pbjs.requestBids()
+            },
+            storage: {
+                type: "html5",
+                name: "intentIqId",    // set localstorage with this name
+                expires: 60
+            }
+        }],
+        syncDelay: 3000
+    }
+});
+```