google-publisher-tag-pro/src/adsLoader.js

Lib made to help developers to manage ads in web sites.

import { CLIENT_DEFAULT_ID, REFRESH_KEY, REFRESH_VALUE } from "./adsSettings";
import { googletag, blocks } from "./adsGlobals";
import adsSizes from "./adsSizes";
import defineLazyLoad from "./adsLazyload";
import defineRefresh from "./adsRefresh";

/**
 * Define a slot based on the sent params
 *
 * @param {string}  id       Block div id.
 * @param {string}  sizes    Slot enabled sizes.
 * @param {Array}  customSizes   Object with custom sizes.
 * @param {string}  clientIdSuffix   Ad manager client id suffix. Default is ''.
 * @param {boolean} refresh  Refresh ads or not. Default is false.
 * @param {string}  clientIdPrefix A custom clientIdPrefix. Default is null.
 * @param {Array} targets object with all targeting items.
 *
 * @throws {Error} If the slot is not found or it is badly defined.
 */
const defineAdSlot = (
  id,
  sizes,
  customSizes,
  clientIdSuffix = "",
  refresh = false,
  clientIdPrefix = null,
  targets = []
) => {
  if (!id || !clientIdSuffix) {
    throw new Error(`Invalid ad block ${id} - ${clientIdSuffix} - ${sizes}`);
  }

  let selectedSizes = adsSizes[sizes]?.sizes ?? [];
  if (customSizes) {
    selectedSizes = [...selectedSizes, ...customSizes];
  }

  if (selectedSizes.length === 0) {
    throw new Error(
      `Invalid ad block size ${id} - ${clientIdSuffix} - ${sizes} - Custom Sizes: ${
        customSizes ? JSON.stringify(customSizes) : "null"
      }`
    );
  }

  let clientId = CLIENT_DEFAULT_ID + clientIdSuffix;

  if (clientIdPrefix) {
    clientId = clientIdPrefix + clientIdSuffix;
  }

  const currentSlot = googletag.defineSlot(clientId, selectedSizes, id);

  if (currentSlot) {
    if (refresh) {
      currentSlot.setTargeting(REFRESH_KEY, REFRESH_VALUE);
    }
    for (const key in targets) {
      if (targets?.[key]) {
        let parsedTarget = targets[key];
        try {
          parsedTarget = JSON.parse(parsedTarget);
        } catch (e) {
          // pass
        }
        console.log("debug:maybeStringfy", parsedTarget, typeof parsedTarget);
        currentSlot.setTargeting(key, parsedTarget);
      }
    }
    currentSlot.addService(googletag.pubads());
  } else {
    throw new Error(`Ad ${id} not found`);
  }
};

/**
 * Iterate through the blocks and define them.
 */
const defineAdsBlocks = () => {
  for (const index in blocks) {
    if (blocks[index] && !blocks[index].loaded && !blocks[index].error) {
      try {
        defineAdSlot(
          blocks[index].id,
          blocks[index].sizes,
          blocks[index].customSizes,
          blocks[index].clientIdSuffix,
          blocks[index].refresh,
          blocks[index].clientIdPrefix,
          blocks[index].targets
        );
        blocks[index].loaded = true;
      } catch (error) {
        blocks[index].error = error;
        console.warn(error.message);
      }
    }
  }
};

/**
 * Load the ads and define its structure.
 */
export const loadAdsBlocks = () => {
  googletag.cmd.push(() => {
    defineAdsBlocks();
    defineLazyLoad();
    defineRefresh();
    googletag.enableServices();
  });
};

export default loadAdsBlocks;