Data collection configuration settings data-collection

This configuration section allows you to determine how data is collected across the extension.

The following options are available:

On before event send callback

A callback function to evaluate and modify the payload sent to Adobe. Within the code editor, you have access to the following variables:

Any variables defined outside of content can be used, but are not included in the payload sent to Adobe.

// Use nullish coalescing assignments to add objects if they don't yet exist
content.xdm.commerce ??= {};
content.xdm.commerce.order ??= {};

// Then add the purchase ID
content.xdm.commerce.order.purchaseID = "12345";

// Use optional chaining to prevent undefined errors when setting tracking code to lower case
if(content.xdm.marketing?.trackingCode) content.xdm.marketing.trackingCode = content.xdm.marketing.trackingCode.toLowerCase();

// Delete operating system version
if(content.xdm.environment) delete content.xdm.environment.operatingSystemVersion;

// Immediately end onBeforeEventSend logic and send the data to Adobe for this event type
if (content.xdm.eventType === "web.webInteraction.linkClicks") {
  return true;
}

// Cancel sending data if it is a known bot
if (myBotDetector.isABot()) {
  return false;
}

This callback is the tag equivalent to onBeforeEventSend in the JavaScript library.

Collect internal link clicks

A checkbox that enables the collection of link tracking data internal to your site or property. This checkbox is the tag equivalent to clickCollection.internalLinkEnabled in the JavaScript library. When you enable this checkbox, event grouping options appear:

The tag library considers a given event a “page view” when the following elements are included in the payload:

Collect external link clicks

A checkbox that enables the collection of external links. This checkbox is the tag equivalent to clickCollection.externalLinkEnabled in the JavaScript library.

Collect download link clicks

A checkbox that enables the collection of download links. This checkbox is the tag equivalent to clickCollection.downloadLinkEnabled in the JavaScript library.

Download link qualifier

A regular expression that qualifies a link URL as a download link. This string is the tag equivalent to downloadLinkQualifier in the JavaScript library.

Filter click properties

A callback function to evaluate and modify click-related properties before collection. This function runs before the On before event send callback, and is the tag equivalent to clickCollection.filterClickDetails in the JavaScript library. Within the code editor, you have access to the following variables:

Context settings

Automatically collect visitor information, which populates specific XDM fields for you. You can choose All default context information or Specific context information. It is the tag equivalent to context in the JavaScript library.