Campaign tag

This tag collects the following data to pass to an external analytics system:

• Marketing campaign name, if applicable
• Template name (email only)
• Activity type (web or email)
• Activity name
• Name of the e-Marketing Spot in which the activity ran
• Content name

Parameters

The following is a list of required and optional parameters for the campaign tag.

To pass the campaign data that is listed at the beginning of this topic to an external analytics system, use one of the following parameters:

databean

Use this parameter if your store uses data beans and URL commands for marketing runtime functions. This parameter is a populated instance of an e-Marketing Spot data bean.

espotData

Use this parameter if your store uses web services for marketing runtime functions. This parameter is a populated instance of the com.ibm.commerce.marketing.facade.datatypes.MarketingSpotDataType class.

The following are additional required and optional parameters:

id

A required parameter that identifies the variable name in which to place the modified URL.

url

A required parameter that is a string representation of a URL, or a variable that is created using the <c:url> tag to be modified.

initiative

A required parameter that identifies the ID of the particular marketing activity that is assigned to the e-Marketing Spot to which the URL corresponds.

name

This variable is used to override the name of the content (collateral, catalog entry, category, or associated catalog entry). If supplied, it is used instead of the default value that is obtained by a lookup.

activityName

The name of the activity. Use only when the databean and espotData data is not available.

campaignName

The name of the campaign. Use only when the databean and espotData data is not available.

experiment

An optional parameter. This parameter is a boolean value that indicates whether the data belongs to a marketing experiment. If set to true, the data belongs to a marketing experiment.

experimentName

The name of the experiment. Use only when the databean and espotData data is not available.

experimentViewed

An optional parameter. This parameter is a boolean value that indicates whether the marketing experiment data is from a test or control element. If set to true, the data is from a test element.

testElementName

The name of the element on the experiment path in the experiment. Use only when the databean and espotData data is not available.

controlElement

The name of the element on the control path in the experiment. Use only when the databean and espotData data is not available.

marketingSpotName

The name of the e-Marketing Spot. Use only when the databean and espotData data is not available.

scope

An optional parameter that specifies the scope in which the variable of the modified URL applies. Valid values are:

1

(Default) The variable applies to this page. The variable might be different the next time the page is loaded.

2

The variable applies to this request. The variable might be different the next time the e-Marketing Spot is requested, even for the same page.

3

The variable applies to the current session. The variable might be different the next time the customer browses your site.

4

The variable applies to the current application, and does not change.

Tag versions

HCL Commerce provides two versions of the campaign tag:

1. An abstract base tag implementation class: com.ibm.commerce.bi.taglib.CampaignBaseTag. Analytics vendors who want to track marketing campaign interactions in their web analytics JSP tag library for HCL Commerce can extend this base tag class and implement their own logic to send marketing activity data to data collection servers.
2. A default implementation of the campaign tag (<cm:campurl />) for IBM Digital Analytics. This implementation takes an e-Marketing Spot URL as input and updates the URL by appending parameter values that represent the marketing activity data that IBM Digital Analytics requires.