Package org.ametys.web.analytics

Class GoogleAnalyticsProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.analytics.AbstractWebAnalyticsProvider

org.ametys.web.analytics.GoogleAnalyticsProvider

All Implemented Interfaces:

LogEnabled, PluginAware, WebAnalyticsProvider, Configurable

public class GoogleAnalyticsProvider
extends AbstractWebAnalyticsProvider

The google analytics provider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOMAIN_HASH	The domain hash.
static final String	GA_GIF_URL	The analytics GIF URL.
static final String	GA_VERSION	The analytics API version.

Fields inherited from class org.ametys.web.analytics.AbstractWebAnalyticsProvider

_id, _label, _pluginName, RANDOM_NUMBER_TOKEN

Constructor Summary

Constructors

Constructor	Description
GoogleAnalyticsProvider()

Method Summary

Modifier and Type	Method	Description
protected String	_getEventIdentifier(String category, String action, String label, int value)	Get the event identifier
protected String	_getEventImageUri(String gaWebId, String eventIdentifier, boolean usePlaceholderTokens)	Get an event image URI.
String	getEventImageUri(Site site, String category, String action, String label, int value, boolean usePlaceholderTokens)	Get the event image URI
String	getEventLinkCampaignParams(Site site, String campaign, String medium, String source)	Get the event link campaign params

Methods inherited from class org.ametys.web.analytics.AbstractWebAnalyticsProvider

_encodeValue, configure, getId, getLabel, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

GA_GIF_URL

public static final String GA_GIF_URL

The analytics GIF URL.

See Also:

• Constant Field Values

GA_VERSION

public static final String GA_VERSION

The analytics API version.

See Also:

• Constant Field Values

DOMAIN_HASH

public static final String DOMAIN_HASH

The domain hash.

See Also:

• Constant Field Values

Constructor Details

GoogleAnalyticsProvider

public GoogleAnalyticsProvider()

Method Details

getEventImageUri

public String getEventImageUri(Site site,
 String category,
 String action,
 String label,
 int value,
 boolean usePlaceholderTokens)

Description copied from interface: WebAnalyticsProvider

Get the event image URI

Parameters:

site - the site

category - the event category

action - the event action

label - the event label

value - the event value

usePlaceholderTokens - true to use placeholder tokens in the URI

Returns:

the event image URI

_getEventIdentifier

protected String _getEventIdentifier(String category,
 String action,
 String label,
 int value)

Get the event identifier

Parameters:

category - the event category

action - the event action

label - the event label

value - the event value

Returns:

the event identifier

_getEventImageUri

protected String _getEventImageUri(String gaWebId,
 String eventIdentifier,
 boolean usePlaceholderTokens)

Get an event image URI.

Parameters:

gaWebId - the GA web ID.

eventIdentifier - the event identifier.

usePlaceholderTokens - True to use tokens instead of randomly generated values

Returns:

the event image URI.

getEventLinkCampaignParams

public String getEventLinkCampaignParams(Site site,
 String campaign,
 String medium,
 String source)

Description copied from interface: WebAnalyticsProvider

Get the event link campaign params

Parameters:

site - the site

campaign - the event campaign

medium - the event medium

source - the event source

Returns:

the event link campaign params