dataLayer
This module exposes Drupal content, entity, and user data to the front-end. It outputs meta-data about pages, which can be used for various client-side features and is often integrated with tools like Google Tag Manager. The data is made available in a format that JavaScript can easily access and utilize.
Get content/entity/user data from inside Drupal to the client-side/front-end.
Outputs various CMS page meta data (like content type, author uid, taxonomy terms), which can be used for all kinds of front-end features. This works for all entity types and is easy to extend with hooks.
Documentation in the README
Often used for Google Tag Manager.
The "dataLayer" is just a front-end standard for passing info around, for example allowing your server-side to inform javascript behaviors. It enables plenty of 3rd party services (like Google Tag Manager) to access web application data. Regardless, you should use this juicy data to implement super-awesome-great client-side features, like... anonymous user tracking, etc.
NOTE: The dataLayer object is used as a warehouse for Google Analytics and GTM, and is therefor an array of objects. To safely access properties you should use the data-layer-helper library, a dependency of this module.
Some of what's exposed by default...
{
"drupalLanguage": "en",
"userUid": "555",
"entityId" : "123",
"entityLabel" : "My Cool Page",
"entityType" : "node",
"entityBundle" : "article",
"entityUid" : "555",
"entityTaxonomy" : {
"my_vocab" : {
"25" : "Term Name",
"26" : "Another Term"
}
}
}
Access:
var myHelper = new DataLayerHelper(dataLayer);
myHelper.get('userUid');
myHelper.get('entityTaxonomy.my_vocab');
Add properties:
Example:
datalayer_add(array(
'myProperty' => $value
));
See datalayer.api.php for more examples and options.
Bonus:
Provides front-end access to full-detail i18n language configurations, and a simple prefix list...
Drupal.settings.dataLayer.languages;
Drupal.behaviors.dataLayer.langPrefixes();
You'll need the Data Layer Helper library to manually access content client-side. Place that within your Libraries.
Need to create a custom dimension in GA GTM from taxonomy terms? Output is an object so you'll need this little code snippet.
Compatibility with Google Tag module
Due to a bug fix implemented in #3345817: Pages are uncacheable because of the cache context user version 2.0.1 of the dataLayer module is not compatible with Google Tag 8.x-1.6 or earlier. Use Google Tag version 2.0.2 or later. More information.