Skip to content

Digital Data Manager is an open source library which provides the hassle-free way to integrate Digital Data Layer on your website, collect customer data with one API and send it to hundreds of tools for analytics, marketing, and data warehousing.

License

Notifications You must be signed in to change notification settings

appwilio/digital-data-manager

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Digital Data Manager

Build Status

Digital Data Manager is an open source library which provides the hassle-free way to integrate Digital Data Layer on your website, collect customer data with one API and send it to hundreds of tools for analytics, marketing, and data warehousing. More info at http://ddmanager.readme.io.

##Defining Digital Data Layer

<script type="text/javascript">
window.digitalData = {
  page: {
    type: "home"
  },
  user: {
    userId: "1232321",
    name: "John Dow"
  },
  events: []
}
</script>

##Sync Installation

<script type="text/javascript" src="dd-manager.js"></script>
<script type="text/javascript">
  ddManager.initialize();
</script>

##Async Installation

<script type="text/javascript">
(function() {
  var a = window.ddManager = window.ddManager || [];
  window.ddListener = window.ddListener || [];
  var b = window.digitalData = window.digitalData || {};
  b.events = b.events || [];
  if (!a.initialize) {
    if (a.invoked) {
      window.console && console.error && console.error("Digital Data Manager snippet included twice.");
    } else {
      a.invoked = !0;
      a.methods = ["initialize", "addIntegration", "on", "once", "off"];
      a.factory = function(b) {
        return function() {
          var c = Array.prototype.slice.call(arguments);
          c.unshift(b);
          a.push(c);
          return a;
        };
      };
      for (b = 0;b < a.methods.length;b++) {
        var d = a.methods[b];
        a[d] = a.factory(d);
      }
      a.load = function(a) {
        var b = document.createElement("script");
        b.type = "text/javascript";
        b.async = !0;
        b.src = a;
        a = document.getElementsByTagName("script")[0];
        a.parentNode.insertBefore(b, a);
      };
      a.SNIPPET_VERSION = "1.0.1";
      a.load("dd-manager.min.js");
      a.initialize();
    }
  }
})();
</script>

##Async Installation (not minified)

<script type="text/javascript">
(function () {
  // Create a queue, but don't obliterate an existing one!
  var ddManager = window.ddManager = window.ddManager || [];
  var ddListener = window.ddListener = window.ddListener || [];
  var digitalData = window.digitalData =  window.digitalData || {};
  digitalData.events = digitalData.events || [];

  // If the real ddManager is already on the page return.
  if (ddManager.initialize) return;

  // If the snippet was invoked already show an error.
  if (ddManager.invoked) {
    if (window.console && console.error) {
      console.error('Digital Data Manager snippet included twice.');
    }
    return;
  }
  // Invoked flag, to make sure the snippet
  // is never invoked twice.
  ddManager.invoked = true;

  // A list of the methods in ddManager to stub.
  ddManager.methods = [
    'initialize',
    'addIntegration',
    'on',
    'once',
    'off'
  ];

  // Define a factory to create stubs. These are placeholders
  // for methods in Digital Data Manager so that you never have to wait
  // for it to load to actually record data. The `method` is
  // stored as the first argument, so we can replay the data.
  ddManager.factory = function(method){
    return function(){
      var args = Array.prototype.slice.call(arguments);
      args.unshift(method);
      ddManager.push(args);
      return ddManager;
    };
  };

  // For each of our methods, generate a queueing stub.
  for (var i = 0; i < ddManager.methods.length; i++) {
    var key = ddManager.methods[i];
    ddManager[key] = ddManager.factory(key);
  }

  // Define a method to load ddManager from our CDN,
  // and that will be sure to only ever load it once.
  ddManager.load = function(path){
    // Create an async script element.
    var script = document.createElement('script');
    script.type = 'text/javascript';
    script.async = true;
    script.src = path;

    // Insert our script next to the first script element.
    var first = document.getElementsByTagName('script')[0];
    first.parentNode.insertBefore(script, first);
  };

  // Add a version to keep track of what's in the wild.
  ddManager.SNIPPET_VERSION = '1.0.1';

  // Load ddManager
  ddManager.load('dd-manager.min.js');

  // Initialize ddManager
  ddManager.initialize();
}());
</script>

##Initialization With Integrations

ddManager.initialize({
  'integrations': {
    'Google Tag Manager': {
      'containerId': 'XXX'
    },
    'Google Analytics': {
      'trackingId': 'XXX'
    }
  }
});

**Note.**You can even remove you GTM or Google Analytics tags from the code. Digital Data Manager will load them automatically.

##Event tracking

###Listening and reacting to events

window.ddListener.push(['on', 'event', function(event) {
  if (event.name === 'Subscribed') {
     console.log('event fired!');
  }
}]);

###Firing events

window.digitalData.events.push({
   'category': 'Email',
   'name': 'Subscribed'
});

##Changes tracking

###Listening and reacting to changes inside DDL

window.ddListener.push(['on', 'change', function(newValue, previousValue) {
  console.log(newValue);
  console.log(previousValue);
}]);

###Listening and reacting to changes of specific key inside DDL

window.ddListener.push(['on', 'change:user.returning', function(newValue, previousValue) {
  console.log(newValue);
  console.log(previousValue);
}]);

###Listening and reacting to changes of key property inside DDL

window.ddListener.push(['on', 'change:cart.items.length', function(newValue, previousValue) {
  console.log(newValue);
  console.log(previousValue);
}]);

###Firing changes to DDL

// user status changed to "returning"
ddManager.once('ready', function() {
  digitalData.user.returning = true;
});
// new product was added to cart
ddManager.once('ready', function() {
  digitalData.cart.items.push({
    "id": 123,
    "name": "Product 1"
  });
});

Learn more at these links

License

The Digital Data Manager is licensed under the MIT license. See License File for more information.

About

Digital Data Manager is an open source library which provides the hassle-free way to integrate Digital Data Layer on your website, collect customer data with one API and send it to hundreds of tools for analytics, marketing, and data warehousing.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%