template.tpl

___TERMS_OF_SERVICE___

By creating or modifying this file you agree to Google Tag Manager's Community
Template Gallery Developer Terms of Service available at
https://developers.google.com/tag-manager/gallery-tos (or such other URL as
Google may provide), as modified from time to time.


___INFO___

{
  "type": "TAG",
  "id": "cvt_temp_public_id",
  "version": 1,
  "securityGroups": [],
  "displayName": "CrossEngage Tracking SDK Config",
  "categories": ["ANALYTICS", "SALES", "CONVERSIONS"],
  "brand": {
    "id": "brand_dummy",
    "displayName": "",
    "thumbnail": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAAAXNSR0IArs4c6QAAEeBJREFUeAHtXQt0XUW5/mafc5qWp5BUvIIIUkRrqVweXmhpMeckKQWsgrQ+F9WC4lo5Jw2lPsuSoCAuoaRNUrH4QgWsVAVsaWnzKE2h0JZ7haugcKsIFy9XkzRWSps25+zxm7ya9Jx27z2zzyM5e9ZKzt6z5//nn2++PTN75t+zgSAECAQIBAgECAQIBAgECAQIBAgECAQIBAgECAQIFAsCYkwVtGrx0UjtPxcSUyDlFAj+SZwNMe5stNX/1XNZo/FWQJYB4nnKPg/Bv3B4GzYse92zrgIVCBeoXe7MqquzsKX7PMCuhC0rkeyZxoofNyQsh470DiRKKDiVJOAfg9J3oBeIVv8B0mqDsFsx4djH8ei3u/uuj8J/o48AUgrEamdAJOdjc8eVxPyEIdxNK3xIkcOBxHtJuveSENXYuyeJ8uoWiNADKD3xIayu2+MgXVCXR08XUHHDu2D3XkPQr+GteLonFMW4U7S6gPL4E8xruvu8xD52O2sQCt2D5gZ2H4UfCr8FKK85j03t15A6oO72AiesnECCzkMyNY+twrNsFe7CpPetwj3Xs98ozGAVplm0KrpwJqLxDUDqGfbrVzGmwCs/DclzIFM/xc7/fpljhlrMrTs4NklLmr+IwiNALDG5r0+Vyc2s+Kr8QeNTzhIns1WoR1fHH0jouT5p9U1N4XQBsxPHoQc3czRfw9IVjl1+QS3xLo4nHkR5/GlEQrXYuHybX6pN9BRGCxBLfAo99oscWS8iSGOv8kfUkLyQY4StbA3uwGfqxo+4lIeT/BKg4svH845YBdu+j2V/Wx7Kn58spbTYvS3Gqx3PoiJxYX6M6M81fwSojE+Hvec53vEfyycAec1b4ix2eU+yNagjIfIyyM0PAaKJm5CSHOThnXmtgELIvL81uBnRxBp8pPYtuTYptwSYnSgh2++HtL/Jyg/lurCFnZ+8HLt7d6CqZkou7cwdAWbdcCL2y2Y2dZ/MZQFHWV6T0Jt6iuOCilzZnZu7MJo4A3ZqEyv/3JwUTAib00YvwMJaSPE9jJdPYef2lOe8J/3Hq5x/ep3Tu2omj6uCfYtDntV4FFATRh/D6Rc8j5d3/NGjrOfk2R94qDn8VO9mDvZO8WydN4E3WOnrWeGP4PjwOjy87B/exB1S19WF8UTnxRy0XcGUV7ALO8tBwuyyQIrluRatK35ipujI0tklQMXCU2En27M42FPrf20IibtxQtkarsQdOHJxfbwaW3gBy3YthPgEW7bjfNQ8XJWEJT6H1qYfDo/08zh7BKiMv50cZuXLM/w0eEBXD4H/PpvmJt4hL2VBv3uVH6o7Cnu7ruNcxmIKvcO9oMuUqiWwQh9FS8MjLiU8JcsOAdTjzO7kU2z23+PJGufEvax43g2RW7WWd53166f4/MoIF37mc8xwK0l/kr6ijJI9sKwqtDZuyXjVINJ/Asx9MITO9kdZ+bMM7EoXFWI9rEgcLfV/Tr9YQDGXf+UEOoncwfIvoFU+4is4polcjE31yj3Nt+CjgQM2qTluNc3pVxDib2zqa9nUr/JLZU70VCYuQcpe6etgUYj/QYk4H+sb/+lXGfydB4jFP+1v5WMNIpHJo67yVe00N25GifV+DuK+yW7Ln8GplGeiR/7Ir8pXevxrAdQ6vm3/J3X6sMIlkjTta2hruJPg5crTz09cR+qKVV8EG79hpJpLMA8WbuRNcZe5Ir8IoJ6RN3eqQd/5xkYJ8U8+1s3pu4OMlRWQgsqaM9klcJ7Cj6ci3iBWaBpal+8wLaE/XcDmzq/6U/nYjXCoasxVvqql5gbVf1/Ee+5p00oj1mG6m/0Q6snDMJhPBZcn3k+D1Hq+oS6Ocq1wFVqWbzcsU+GK79y+FxdMfwD77Mk0kq7lRuEkdHccwMvb2020mLUA6sUMIX9MA8yYKMQu6on50aSZgJET2dX1+zCz7Grmdb95fvImVMWN5lrMCNDeOZ992r8bFUSILoTCMbSt+C8jPaNJuK7OxnhLTSNz3GQQpCxBUn7XQIPBU4CaAn2z4yU+555sYMAewOLkRiM9g4owVC1+K5L7thuvlVih2WhteEwHQf0W4M2uRYaVz/GQWFC0la9qa+Odf+c8wYd49IZO5Q3J2Knb2RJrPdLrEUAxV9pfGjJA50BgKdqaVuuIjimZlqbf0W/hk7wZbINynYNYzcd15PUIkOqJM7NjdTIckNmGmRO/YiA/tkRbV6zlk9S3zAolb4EalHsMngX6fNltfMFjPgeTq2lRy1pAYznbF4QhBE6deBtHZPoLXWqaeEvHZUP6XB54J8CrHZ8mWye61J+eTOJWLmu+kH6hyGPuraOPAxYaoSCFeqvKU/BOAKDWUw4jEos/4syzvz0iKjg5iIDqCoRQawZ6QXKTjIpaTxNM3ghQEf8gR/7v07NOSYklhfyqtH65fJQcF2YrwH0GdEMqqcZnroM3AqSk1khzwJptfOT7tWvLijXhY8v+wqLfrl18QY9itTjnMrgngPL0gbjKpd70ZOHQkvTIICYjAmVl9YzvznjNKVLKUrR3RZ2SDV53T4DuLeXagz8hfjdatkwZBCavv2qfISFWGtjgeh8C9wSw5Tx9g2SDvmyRSkbCDSSBpieRvNJtN+CeAMAcrapQK32l43xY+dLKffQK9e9FSOdajaC6gS1d9D1wDu4IEKt+N+ea9VydJX4JtQQaBA0E5M80hPpFpJzpRtYdAWyu2OkGS/5SV7To5UonqhZAbzAI+EgAYc/QqgzV/M+YuElLNhDCwKtu67SgkHKam3GAuxZAQrcFWEcjgjl/rRocELLQrCl+DJ7sPMdJ1pkA6k0XYJKToozXJbZkjA8i3SMQjmx0n/iQlEkx9ZCYtFNnAvTs06v8vqwiT6blGER4Q0A9Dag3grSCPMtJzJkA0tYlQDfa7gpW/ZxqwNV1+VtXydIS+UIAqUkA8RyZO/rf6kkDNQ8REs/q5SocW4Cwo2KL/b+es9KfHHUHCdwhEBJrYYvj3SUensruHX6W6diZALbuVm4yIEAmxHXilN8gkBUXOucxgMBxOjbT21XfvUkrw0BIBwFnAgDH6Cim31+nllwglFMEnAkgNQkg5Zs5LUmQmRYCzgSA1GwBBN/6CUKhI+BMAIGjtAphh/ZqyQVCOUXAmQDAfi2LrN6C/ESKVlnGsJAzAaTQ68t1xw5jGOxCLJozAQDNvlwcXYgFDmwaiYAzAYQmAVKa8wcj7QvOsoyAMwG0WwB5WpZtD9T7gIAbAryumc8ZmnKBWA4RcCaAxE5NewICaAKXSzHnxSAhdtIjWMcmTy8p6mRQNDKV8fO5Iuv9hhL4G1qaHj8STi4JcCQVh7mmNkRUO4mobVCCYIZASi7lS7muvHxHZqR2VsfjI+NGnjl3AaGwbhcAboA0fWR2wZlnBNQ3hyU+4FlOCQjh6EjiTIANS1+jpn9oGQAEBNAEbkhsV8d5PB4/dO7lQMBx9zVnAvS7dWk6d4rZXuwN0mZCQBtDiXF+EEDZJKSee7eUk013sswESVHF2bhSq7wCL7n5roBzC6ByD4kntIxQQklxtbZssQuqHcYhp+jBIJrdyLkjQFg8Q2U9bhSmpZFF/G3gNDA8Rtipz3mUGJZcuHqhxB0B1jfu54iyfZh2D4dkcHShxiOMhyzGYtK5dcdw9P95zaL1orTU1TuZ7gigrBB4UNMYiiUT+rJFKtnVcR0JoOEKrvASW/liqatVXPcECEceomZHP/OM1SXFR1C16B0ZrwWR6Qio/ZikwZ6BQvwiXWnmGPcE2FC/iypaM6txiuUXLnoP3OSUKrg+gEBXu9qM6zQtPNS2MpFwFgigrBHCoBvAAqidRoLgBoHFbhIdJs069N+sh7k8Mtp9C6DkSstWcyywe6QKt2fqOze4zW3qok0Xi1/LxTe9qd8+0ORPvWDnjQB9Awt+s1c3SFyNaDyqKz7m5WbV/htX/e7UL6d4DZOmrvUi740ASrMVamQrkPKSyYi0Ej/gKmHgLzgClIGT3mQTJ37ekumSqzhLLPO6Fa93ArQsf5WDgV+7MihjInk6kj1BV3AoNuWJq9j06+/Eqrrmoyfcc6hap3PvBFAaw6GlToodridQEZ/lkKZ4LquvrcNeYVZgcTd+8x3Pn57RI8DG5dv4RKDfCkhpsa97AJfWnmZW6DEgrTZ23t37c5bkbQaleQPh8fU68noEUDmFLPW+ut7EkJKX8kQcSP6q7wsk6rxYw5YOtSfwpYbFv13X80qfAOpTqEJ8z8hwKc/FK50PFy0JYtVfZ0u4wAhDgVfwzolad7/KV58ASvrokm/ozwsoBSrIWSTBGsy9YUL/eZH8jyY+w8q/xby01lehPjejGcwIsGZpJ4T1Zc28h4nJCnT1roX6GGUxhPKay9gF6s+nDGIkRBs/GLlq8FTn14wAKsfWxpXsClytPR/RQCmj2NO5bszPEcQS13PE/whbPmeP7CMCpj42WbKA2Gv57A+qNieA0lQi+B1c3SniQVPUr7wEvfseg1oLH2tBrfBFE/WwbY6bjCufUzHWjWhb+oopTMJUwZC86tOk/eOhc6MD8Xs+ZlyNTctfNFJTKMJzvnQs9ry5imshl/ljktiATU2mTw59pvjTAihVbY338v/96tA8KD+45DNcPfy4ua48a4gmzsAbe7f6V/n4X0TGX+NXqfxrAZRFaiTf2UsPYql82X0K4iew5I1oXdHlk8LcqFEvdHR1fpEVv4R4+PWE04OwmIHmJuWj6UvwlwDKpNmJU7BfPsNRrt4XRjIWS3TwgXURWpvuy3i50CJjNeWQqbtZ+Wf5apqwPjvQ0vqm1n8CKNMq49O5XthGEvi7T5BAO6zwErQs13dT9w26DIpiC0+CnVTrJJ/KcNUwyrqL31280VBJmnh2CKCyqYh/lCTgM6oPI950szcgEroZak2iEEIsMRm2rGZZVd/s/xOMwL1s/Ywf+TJBlT0CqNyiiU8QlPvYEvg32BxeCoEdfB66G6WRVTn/MJV6rOvc8mG+NVXN8kWHm+XrsVp0K505D6vn6ftgHMGg7BJAZRyrns8pT/V4mM28ujkh8jD73IdRFmnOKhkqa8+B3TuHZbqOZcq2p/NjKJv44YFvByk0fQ/ZrJSDxvb7ua1kBYUORmbpSIAbVHKKVMqtJMU2HHPUDp118j7r1F3e3T6Zdn+AFX4R7/ZLeXxyliw/RC1du8vKrslm5asMc0MAlZOa/0ZKuSv730cq/YcLQth0kz4F/R9iPFyqzPHlcb5dIz+Y+WIWY4VoxMyyWn5wy85iLn2qs9M3Z7J6U8M6hCMzSLm/ZrqctTg1/ugVuuWMZM2uzIold1lfgrammlxUvjJBF5jM5jvFNi97FiXWhUzmuHOFk6oxeL2btTGHi2vfymXZcksAVbL1ja/RgYH9KZu5IPQjIMRvERHncbbTk0u3H/DlngDKauXAoJq5kHUFhyEdfhRklOrgUq74Lk4tm4aNTS/nowz5IcBgSVsaH8WECVM5Llg3GFVEvzsRtsq5qldt4tFjild+CaCsX3fH/6NtxeUkgfKJ/4uKGtNBvVQjxJ0oGzcVzY2b813W/BNgEIG2FQ8RlMkE5xZGafu4DaoryF+BNXTkmMru74tZnazyUPjCIYAyenX9PoJTBzH+Pewb7yEZDngoSwEnFU/z8W4mWzo1yn+hkAwtLAIMIqNcnTY1Xc95w9NJgnr+6X20YlBfvn6Vr6QVms2yXMSK19tpLcu2mzomZte85qb/YwaLuJ5wG1uEL/B4Pqd4z8xupsbae9jMcwEsvAxt9c8ba8uygsImwGDh+72BSALuLxCtmUbfw/k8nsdpWv03aQd1+/IrklTTSs+ln2Oc9ZCb/fl8ydYHJaODAMML2tawladb+TbRQrzWFeM6fCXPK9kyTB6eLOvHQuxiHmoUv5Fe0b9ipY/K+YzRR4DBmu1/G+ZRnqo/5YX09j4yqFU7iClcuZvClTvNXbb6NA7713eH76TO3/Nx9Sk28ZtwcelzuZqvH2aI74e5Ww303XQXCpV/4gGS4agT27GmjsvEHkNl4hK2LLtwQtmL2V6W9WhZkDxAIEAgQCBAIEAgQCBAIEAgQCBAIEAgQCBAIEAgQMAzAv8ClnG6/hFbKWMAAAAASUVORK5CYII\u003d"
  },
  "description": "Loads the CrossEngage Tracking SDK and allows to configure its settings.",
  "containerContexts": [
    "WEB"
  ]
}


___TEMPLATE_PARAMETERS___

[
  {
    "type": "CHECKBOX",
    "name": "setupNewTracking",
    "checkboxText": "Initialize new tracking SDK Snippet",
    "simpleValueType": true,
    "subParams": [
      {
        "type": "GROUP",
        "name": "setup",
        "displayName": "",
        "groupStyle": "NO_ZIPPY",
        "subParams": [
          {
            "type": "TEXT",
            "name": "apiKey",
            "displayName": "CrossEngage Tracking API Key",
            "simpleValueType": true,
            "valueValidators": [
              {
                "type": "NON_EMPTY"
              }
            ]
          }
        ],
        "enablingConditions": [
          {
            "paramName": "setupNewTracking",
            "paramValue": true,
            "type": "EQUALS"
          }
        ]
      },
      {
        "type": "GROUP",
        "name": "advancedConfig",
        "displayName": "Advanced Tracking Configuration",
        "groupStyle": "ZIPPY_CLOSED",
        "subParams": [
          {
            "type": "CHECKBOX",
            "name": "autoPageView",
            "checkboxText": "Enable page view on load",
            "simpleValueType": true,
            "help": "Will always trigger a page view event when the snippet gets loaded via this tag."
          },
          {
            "type": "CHECKBOX",
            "name": "silentLogs",
            "checkboxText": "Disable errors and warnings",
            "simpleValueType": true,
            "help": "Will disable all custom logs from the SDK in the browsers developer console including errors and warnings.\nJavascript runtime errors will not be blocked."
          },
          {
            "type": "CHECKBOX",
            "name": "useRootDomain",
            "checkboxText": "Set custom root domain",
            "simpleValueType": true,
            "defaultValue": false,
            "help": "Choose to use a custom root domain for tracking cookies. If set to true but no domain value is given, the root domain will be detected automatically."
          },
          {
            "type": "TEXT",
            "name": "rootDomain",
            "displayName": "Root Domain",
            "simpleValueType": true,
            "enablingConditions": [
              {
                "paramName": "useRootDomain",
                "paramValue": true,
                "type": "EQUALS"
              }
            ],
            "valueHint": "e.g. example.com",
            "help": "The domain which should be set as domain for the tracking cookies."
          },
          {
            "type": "TEXT",
            "name": "customApiUrl",
            "displayName": "Custom CrossEngage Tracking API URL",
            "simpleValueType": true
          },
          {
            "type": "TEXT",
            "name": "customSdkUrl",
            "displayName": "Custom CrossEngage Tracking SDK URL",
            "simpleValueType": true
          }
        ],
        "enablingConditions": [
          {
            "paramName": "setupNewTracking",
            "paramValue": true,
            "type": "EQUALS"
          }
        ]
      }
    ]
  },
  {
    "type": "SIMPLE_TABLE",
    "name": "configurations",
    "displayName": "SDK Configurations",
    "simpleTableColumns": [
      {
        "defaultValue": "",
        "displayName": "",
        "name": "configId",
        "type": "SELECT",
        "selectItems": [
          {
            "value": "trackingOptIn",
            "displayValue": "User Tracking Opt In"
          },
          {
            "value": "globalEventProperties",
            "displayValue": "Global Event Properties"
          },
          {
            "value": "forceEnablePolling",
            "displayValue": "Force Notification Polling"
          },
          {
            "value": "globalUserId",
            "displayValue": "Override Global User ID"
          },
          {
            "value": "sessionId",
            "displayValue": "Override Session ID"
          }
        ],
        "isUnique": true
      },
      {
        "defaultValue": "",
        "displayName": "",
        "name": "value",
        "type": "TEXT"
      }
    ],
    "help": "Set one multiple configuration options for the CrossEngage Tracking SDK.",
    "newRowButtonText": "Add Configuration"
  }
]


___SANDBOXED_JS_FOR_WEB_TEMPLATE___

const copyFromWindow = require('copyFromWindow');
const setInWindow = require('setInWindow');
const injectScript = require('injectScript');
const log = require('logToConsole');

// Dictionary to transform strings into desired data format
const transformDict = {
  'forceEnablePolling': value => parseBool(value),
  'trackingOptIn': value => parseBool(value),
  'globalEventProperties': value => value,
  'globalUserId': value => value,
  'sessionId': value => value,
};

function parseBool(value) {
 return typeof value == 'boolean' ? value : value.toLowerCase() === 'true';
}

// functions

function runSetup(config) {
  // create pre load queue
  const objectName = 'ce';
  setInWindow('CrossEngageObject', objectName, true);
  const ceObject = copyFromWindow(objectName) || function() {
    const currObj = copyFromWindow(objectName);
    (currObj.q = currObj.q || []).push(arguments);
    setInWindow(objectName, currObj, true);
  };
  setInWindow(objectName, ceObject, true);
  
  // SDK source script injection
  let sdkUrl = 'https://app.crossengage.io/xng/ce.js';
  if(data.customSdkUrl) {
    sdkUrl = data.customSdkUrl;
  }
  injectScript(sdkUrl, data.gtmOnSuccess, data.gtmOnFailure, 'ceSDK');
  
  config.apiKey = data.apiKey;
  config.silentLogs = data.silentLogs;
  
  // Advanced Options
  if (data.useRootDomain) {
    config.rootDomain = (data.rootDomain || true);
  }
  if (data.customApiUrl) {
    config.apiUrl = data.customApiUrl;
  }
}

function setConfig(config) {
  return data.configurations.reduce((acc, curr) => {
    acc[curr.configId] = transformDict[curr.configId](curr.value);
    return acc;
  }, config);
}

// run

let configuration = {};

if (data.setupNewTracking) {
  runSetup(configuration);
}
if (data.configurations) {
  configuration = setConfig(configuration);
}

const ce = copyFromWindow('ce');


if (ce) {
  ce(configuration);

  if (data.autoPageView) {
    ce('track', 'Viewed Page');
  }
} else {
 log('Can not configure SDK: Global function object missing. Please set up the CrossEngage Tracking SDK Snippet first.');
}


___WEB_PERMISSIONS___

[
  {
    "instance": {
      "key": {
        "publicId": "access_globals",
        "versionId": "1"
      },
      "param": [
        {
          "key": "keys",
          "value": {
            "type": 2,
            "listItem": [
              {
                "type": 3,
                "mapKey": [
                  {
                    "type": 1,
                    "string": "key"
                  },
                  {
                    "type": 1,
                    "string": "read"
                  },
                  {
                    "type": 1,
                    "string": "write"
                  },
                  {
                    "type": 1,
                    "string": "execute"
                  }
                ],
                "mapValue": [
                  {
                    "type": 1,
                    "string": "CrossEngageObject"
                  },
                  {
                    "type": 8,
                    "boolean": true
                  },
                  {
                    "type": 8,
                    "boolean": true
                  },
                  {
                    "type": 8,
                    "boolean": false
                  }
                ]
              },
              {
                "type": 3,
                "mapKey": [
                  {
                    "type": 1,
                    "string": "key"
                  },
                  {
                    "type": 1,
                    "string": "read"
                  },
                  {
                    "type": 1,
                    "string": "write"
                  },
                  {
                    "type": 1,
                    "string": "execute"
                  }
                ],
                "mapValue": [
                  {
                    "type": 1,
                    "string": "ce"
                  },
                  {
                    "type": 8,
                    "boolean": true
                  },
                  {
                    "type": 8,
                    "boolean": true
                  },
                  {
                    "type": 8,
                    "boolean": true
                  }
                ]
              }
            ]
          }
        }
      ]
    },
    "clientAnnotations": {
      "isEditedByUser": true
    },
    "isRequired": true
  },
  {
    "instance": {
      "key": {
        "publicId": "inject_script",
        "versionId": "1"
      },
      "param": [
        {
          "key": "urls",
          "value": {
            "type": 2,
            "listItem": [
              {
                "type": 1,
                "string": "https://app.crossengage.io/"
              },
              {
                "type": 1,
                "string": "https://*.xng.rocks/"
              }
            ]
          }
        }
      ]
    },
    "clientAnnotations": {
      "isEditedByUser": true
    },
    "isRequired": true
  },
  {
    "instance": {
      "key": {
        "publicId": "logging",
        "versionId": "1"
      },
      "param": [
        {
          "key": "environments",
          "value": {
            "type": 1,
            "string": "debug"
          }
        }
      ]
    },
    "isRequired": true
  }
]


___TESTS___

scenarios: []


___NOTES___

Created on 16.6.2021, 13:18:53