mk9-prebid/modules/userIdTargeting.js

Header Bidding Management Library

import {config} from '../src/config.js';
import {getGlobal} from '../src/prebidGlobal.js';
import CONSTANTS from '../src/constants.json';
import events from '../src/events.js';
import { isStr, isPlainObject, isBoolean, isFn, hasOwn, logInfo } from '../src/utils.js';

const MODULE_NAME = 'userIdTargeting';
const GAM = 'GAM';
const GAM_KEYS_CONFIG = 'GAM_KEYS';

export function userIdTargeting(userIds, config) {
  if (!isPlainObject(config)) {
    logInfo(MODULE_NAME + ': Invalid config found, not sharing userIds externally.');
    return;
  }

  const PUB_GAM_KEYS = isPlainObject(config[GAM_KEYS_CONFIG]) ? config[GAM_KEYS_CONFIG] : {};
  let SHARE_WITH_GAM = isBoolean(config[GAM]) ? config[GAM] : false;
  let GAM_API;

  if (!SHARE_WITH_GAM) {
    logInfo(MODULE_NAME + ': Not enabled for ' + GAM);
  } else if (window.googletag && isFn(window.googletag.pubads) && hasOwn(window.googletag.pubads(), 'setTargeting') && isFn(window.googletag.pubads().setTargeting)) {
    GAM_API = window.googletag.pubads().setTargeting;
  } else {
    window.googletag = window.googletag || {};
    window.googletag.cmd = window.googletag.cmd || [];
    GAM_API = function (key, value) {
      window.googletag.cmd.push(function () {
        window.googletag.pubads().setTargeting(key, value);
      });
    };
  }

  Object.keys(userIds).forEach(function(key) {
    if (userIds[key]) {
      // PUB_GAM_KEYS: { "tdid": '' } means the publisher does not want to send the tdid to GAM
      if (SHARE_WITH_GAM && PUB_GAM_KEYS[key] !== '') {
        let uidStr;
        if (isStr(userIds[key])) {
          uidStr = userIds[key];
        } else if (isPlainObject(userIds[key])) {
          uidStr = JSON.stringify(userIds[key])
        } else {
          logInfo(MODULE_NAME + ': ' + key + ' User ID is not an object or a string.');
          return;
        }
        GAM_API(
          (hasOwn(PUB_GAM_KEYS, key) ? PUB_GAM_KEYS[key] : key),
          [ uidStr ]
        );
      }
    }
  });
}

export function init(config) {
  events.on(CONSTANTS.EVENTS.AUCTION_END, function() {
    userIdTargeting((getGlobal()).getUserIds(), config.getConfig(MODULE_NAME));
  })
}

init(config)