org.broadleafcommerce.core.web.processor

Class GoogleUniversalAnalyticsProcessor

java.lang.Object

org.thymeleaf.processor.AbstractProcessor

org.thymeleaf.processor.element.AbstractElementProcessor

org.broadleafcommerce.core.web.processor.GoogleUniversalAnalyticsProcessor

All Implemented Interfaces:

Comparable<org.thymeleaf.processor.IProcessor>, org.thymeleaf.processor.IProcessor

public class GoogleUniversalAnalyticsProcessor
extends org.thymeleaf.processor.element.AbstractElementProcessor

Takes advantage of the new-stype analytics.js from Google Analytics rather than the deprected ga.js. This also supports a pre-processed orderNumber attribute that can be null, suitable for things like the order confirmation page to send e-commerce transactions. Example usage:

 <google_universal_analytics ordernumber="${order?.orderNumber" />
 

This processor also supports:

• Multiple trackers (extensible via getTrackers() or by setting the googleAnalytics.masterWebPropertyId and googleAnalytics.webPropertyId)
• Affiliates for e-commerce ()
• Link attribution (googleAnalytics.enableLinkAttribution system property, default true)
• Display Advertising (googleAnalytics.enableDisplayAdvertising system property, default false)

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	affiliation
protected boolean	includeDisplayAdvertising
protected boolean	includeLinkAttribution
protected String	masterWebPropertyId Global value
protected OrderService	orderService
protected boolean	testLocal This will force the domain to 127.0.0.1 which is useful to determine if the Google Analytics tag is sending a request to Google
protected String	webPropertyId Site-specific value

Constructor Summary

Constructors

Constructor and Description
GoogleUniversalAnalyticsProcessor()
GoogleUniversalAnalyticsProcessor(String elementName)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAffiliation()
protected String	getDisplayAdvertisingJs(String trackerPrefix) Builds the display advertising Javascript for the given tracker
protected String	getItemJs(Order order, String trackerPrefix)
protected String	getLinkAttributionJs(String trackerPrefix) Builds the linke attribution Javascript
String	getMasterWebPropertyId()
OrderService	getOrderService()
int	getPrecedence()
protected Map<String,String>	getTrackers() Grabs a map of trackers keyed by the tracker name with the analytics ID as the value
protected String	getTransactionJs(Order order, String trackerPrefix) Builds the transaction analytics for the given tracker name.
protected String	getVariation(OrderItem item) Returns the product option values separated by a space if they are relevant for the item, or the product category if no options are available
String	getWebPropertyId()
boolean	isIncludeDisplayAdvertising()
boolean	isIncludeLinkAttribution()
protected org.thymeleaf.processor.ProcessorResult	processElement(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element)
void	setAffiliation(String affiliation)
void	setIncludeDisplayAdvertising(boolean includeDisplayAdvertising)
void	setIncludeLinkAttribution(boolean includeLinkAttribution)
void	setMasterWebPropertyId(String masterWebPropertyId)
void	setOrderService(OrderService orderService)
void	setWebPropertyId(String webPropertyId)
protected boolean	shouldShowMasterTracker()

Methods inherited from class org.thymeleaf.processor.element.AbstractElementProcessor

doProcess, getMatcher

Methods inherited from class org.thymeleaf.processor.AbstractProcessor

compareTo, getMessage, getMessageForProcessor, getMessageForTemplate, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

masterWebPropertyId

@Value(value="${googleAnalytics.masterWebPropertyId}")
protected String masterWebPropertyId

Global value

webPropertyId

@Value(value="${googleAnalytics.webPropertyId:}")
protected String webPropertyId

Site-specific value

affiliation

@Value(value="${googleAnalytics.affiliation:}")
protected String affiliation

includeLinkAttribution

@Value(value="${googleAnalytics.enableLinkAttribution:true}")
protected boolean includeLinkAttribution

includeDisplayAdvertising

@Value(value="${googleAnalytics.enableDisplayAdvertising:false}")
protected boolean includeDisplayAdvertising

orderService

protected OrderService orderService

testLocal

protected boolean testLocal

This will force the domain to 127.0.0.1 which is useful to determine if the Google Analytics tag is sending a request to Google

Constructor Detail

GoogleUniversalAnalyticsProcessor

public GoogleUniversalAnalyticsProcessor()

GoogleUniversalAnalyticsProcessor

public GoogleUniversalAnalyticsProcessor(String elementName)

Method Detail

getPrecedence

public int getPrecedence()

Specified by:

getPrecedence in class org.thymeleaf.processor.AbstractProcessor

processElement

protected org.thymeleaf.processor.ProcessorResult processElement(org.thymeleaf.Arguments arguments,
                                                     org.thymeleaf.dom.Element element)

Specified by:

processElement in class org.thymeleaf.processor.element.AbstractElementProcessor

getTrackers

protected Map<String,String> getTrackers()

Grabs a map of trackers keyed by the tracker name with the analytics ID as the value

shouldShowMasterTracker

protected boolean shouldShowMasterTracker()

getLinkAttributionJs

protected String getLinkAttributionJs(String trackerPrefix)

Builds the linke attribution Javascript

Parameters:

tracker - the name of the tracker that is using the link attribution

Returns:

getDisplayAdvertisingJs

protected String getDisplayAdvertisingJs(String trackerPrefix)

Builds the display advertising Javascript for the given tracker

Parameters:

tracker -

Returns:

getTransactionJs

protected String getTransactionJs(Order order,
                      String trackerPrefix)

Builds the transaction analytics for the given tracker name. Invokes {@link #getItemJs(Order, String) for each item in the given order.

getItemJs

protected String getItemJs(Order order,
               String trackerPrefix)

getVariation

protected String getVariation(OrderItem item)

Returns the product option values separated by a space if they are relevant for the item, or the product category if no options are available

Returns:

getOrderService

public OrderService getOrderService()

setOrderService

public void setOrderService(OrderService orderService)

getMasterWebPropertyId

public String getMasterWebPropertyId()

setMasterWebPropertyId

public void setMasterWebPropertyId(String masterWebPropertyId)

getAffiliation

public String getAffiliation()

setAffiliation

public void setAffiliation(String affiliation)

getWebPropertyId

public String getWebPropertyId()

setWebPropertyId

public void setWebPropertyId(String webPropertyId)

isIncludeLinkAttribution

public boolean isIncludeLinkAttribution()

setIncludeLinkAttribution

public void setIncludeLinkAttribution(boolean includeLinkAttribution)

isIncludeDisplayAdvertising

public boolean isIncludeDisplayAdvertising()

setIncludeDisplayAdvertising

public void setIncludeDisplayAdvertising(boolean includeDisplayAdvertising)