Package org.ametys.web.analytics

Interface WebAnalyticsProvider

All Known Implementing Classes:

AbstractWebAnalyticsProvider, GoogleAnalyticsProvider, MatomoAnalyticsProvider

public interface WebAnalyticsProvider

Web analytics provider interface

Method Summary

Modifier and Type	Method	Description
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
String	getId()	Get the id of the provider
I18nizableText	getLabel()	Get the label of the provider

Method Details

getId

String getId()

Get the id of the provider

Returns:

the id

getLabel

I18nizableText getLabel()

Get the label of the provider

Returns:

the label

getEventImageUri

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

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

getEventLinkCampaignParams

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

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