clickCollectionEnabled
The clickCollectionEnabled property is a boolean that determines if the Web SDK automatically collects link data. This property is valuable in cases where you prefer to manually track link data.
If not disabled, the following XDM elements automatically populate with data:
xdm.web.webInteraction.namexdm.web.webInteraction.typexdm.web.webInteraction.URL
Automatic link tracking logic
The Web SDK tracks all clicks on <a> and <area> HTML elements if it doesn’t have an onClick attribute. Clicks are captured with a capture click event listener that is attached to the document. When a valid link is clicked, the following logic is run in order:
- If the link matches criteria based on values in
downloadLinkQualifier, or if the link contains adownloadHTML attribute,xdm.web.webInteraction.typeis set to"download". - If the link target domain differs from the current
window.location.hostname,xdm.web.webInteraction.typeis set to"exit". - If the link doesn’t qualify for either
"download"or"exit",xdm.web.webInteraction.typeis set to"other".
In all cases, xdm.web.webInteraction.name is set to the link text label and xdm.web.webInteraction.URL is set to the link destination URL. If you want to set the link name to the URL as well, you can override this XDM field using onBeforeLinkClickSend.
Enable automatic link tracking using the Web SDK tag extension
Select the Enable click data collection checkbox when configuring the tag extension.
- Log in to experience.adobe.com using your Adobe ID credentials.
- Navigate to Data Collection > Tags.
- Select the desired tag property.
- Navigate to Extensions, then click Configure on the Adobe Experience Platform Web SDK card.
- Scroll down to the Data Collection section, then select the checkbox Enable click data collection.
- Click Save, then publish your changes.
Enable automatic link tracking using the Web SDK JavaScript library
Set the clickCollectionEnabled boolean when running the configure command. If you omit this property when configuring the Web SDK, it defaults to true. Set this value to false if you prefer to manually set xdm.web.webInteraction.type and xdm.web.webInteraction.value.
alloy("configure", {
"edgeConfigId": "ebebf826-a01f-4458-8cec-ef61de241c93",
"orgId": "ADB3LETTERSANDNUMBERS@AdobeOrg",
"clickCollectionEnabled": false
});