DocumentationExperience PlatformWeb SDK Guide

clickCollectionEnabled

Last update: Tue Jul 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

The clickCollectionEnabled property is a boolean that determines if the Web SDK automatically collects link data. If you do not set this variable, its default value is true which means that link tracking data is automatically collected by default. Setting this property to false is valuable in cases where you prefer to track link data manually.

When clickCollectionEnabled is enabled, the following XDM elements automatically populate with data:

  • xdm.web.webInteraction.name
  • xdm.web.webInteraction.type
  • xdm.web.webInteraction.URL

Internal links, download links, and exit links are all automatically tracked by default when this boolean is enabled. If you want more control over automatic link tracking, Adobe recommends using the clickCollection object.

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:

  1. If the link matches criteria based on values in downloadLinkQualifier, or if the link contains a download HTML attribute, xdm.web.webInteraction.type is set to "download" (if clickCollection.downloadLinkEnabled is enabled).
  2. If the link target domain differs from the current window.location.hostname, xdm.web.webInteraction.type is set to "exit" (if clickCollection.exitLinkEnabled is enabled).
  3. If the link doesn’t qualify for either "download" or "exit", xdm.web.webInteraction.type is 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 the filterClickDetails callback in the clickCollection object.

This variable is automatically managed by the tag extension; you do not need to explicitly set it. If any of the following are selected when configuring the tag extension, the applicable link tracking data is collected:

  • Collect internal link clicks
  • Collect external link clicks
  • Collect download link clicks

See clickCollection for more information.

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 set xdm.web.webInteraction.type and xdm.web.webInteraction.value manually.

alloy(configure, {
  datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
  orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg",
  clickCollectionEnabled: false
});
recommendation-more-help
ad108910-6329-42f1-aa1d-5920a2b13636