Show Menu
TOPICS×

s.linkTrackVars

The variable is a comma-separated list of variables that are sent with custom, exit, and download links.
The linkTrackVars parameter should include each variable that you want to track with every file download, exit link, and custom link.
The settings for linkTrackVars and linkTrackEvents within the JS file affect every file download, exit link, and custom link. Instances of each variable and event can be inflated in situations where the variable (or event) applies to the current page, but not the specific file download, exit link,or custom link.
To ensure that the proper variables are set with custom link code, Adobe recommends setting linkTrackVars and linkTrackEvents within the custom link code, as follows:
<a href="index.html" onClick=" 
var s=s_gi('rsid'); 
s.linkTrackVars='prop1,prop2,eVar1,eVar2,events'; 
s.linkTrackEvents='event1'; 
s.prop1='Custom Property of Link'; 
s.events='event1'; 
s.tl(this,'o','Link Name'); 
">My Page 


In the above example, the value for prop1 is set within the custom link code itself. The value of prop2 comes from the current value of the variable as set on the page.
The values of linkTrackVars and linkTrackEvents override the settings in the JS file and ensure only the variables and events specified in the custom link code are set for the specific link.
Note: If linkTrackVars (or linkTrackEvents ) is null (or an empty string such as ""), all Analytics variables (or events) that are defined for the current page are tracked. In other words, all variables that have values would be sent with link data. This will most likely inflate instances of each variable. To avoid inflation of instances or page views associated with other variables, Adobe recommends populating linkTrackVars and linkTrackEvents in the onClick event of a link that is used for link tracking.
All variables that should be sent with link data (custom, exit, and download links) should be listed in linkTrackVars . If linkTrackEvents is used, linkTrackVars should contain "events."
Max Size
Debugger Parameter
Reports Populated
Default Value
N/A
N/A
Any
"None"
When populating linkTrackVars , do not use the 's.' prefix for variables. For example, instead of populating linkTrackVars with "s.prop1," you should populate it with "prop1." The following example illustrates how linkTrackVars should be used.
s.linkTrackVars="eVar1,events" 
s.linkTrackEvents="event1" 
s.events="event1" 
s.eVar1="value A" 
s.eVar2="value B" 
s.t() // eVar1, event1 and event2 are recorded 
<a href="https://google.com">event1 and eVar1 are recorded</a> 
<a href="test.php" onClick="s=s_gi('rs1');s.eVar1='value C';s.events='';s.tl(this,'o')">eVar1 is recorded</a> 


Because the link to google.com is an exit link (unless you are Google), event1 and eVar1 are sent with the exit link data, increasing the instances associated with eVar1 and the number of times event1 is fired. In the link to test.php, eVar1 is sent with a value of 'value C' because that is the current value of eVar1 at the time that tl() is called.

Syntax and Possible Values

The linkTrackVars variable is a case-sensitive, comma-separated list of variable names, without the object name prefix. Use 'eVar1' instead of 's.eVar1.'
s.linkTrackVars="variable_name[,variable_name[...]]"

The linkTrackVars variable may contain only variables that are sent to Analytics, namely: events , campaign , purchaseID , products , eVar1-75 , prop1-75 , hier1-5 , channel , server , state , zip , and pageType .

Examples

s.linkTrackVars="events,prop1,eVar49"

s.linkTrackVars="products"

Configuration Settings

None

Pitfalls, Questions, and Tips

  • If linkTrackVars is blank, all variables that have values are tracked with all server calls.
  • Any variable listed in linkTrackVars that has a value at the time of any download, exit, or custom link, are tracked.
  • If linkTrackEvents is used, linkTrackVars must contain "events."
  • Do not use the "s." or "s_objectname." prefix for variables.