Adobe Web SDK scaffold for tracking to Adobe Analytics via the Adobe Client Data Layer (ACDL) using Adobe Experience Platform Tags (Adobe Launch)

If you're using Adobe Web SDK to send events for Adobe Analytics, one of the biggest challenges is figuring out how to even do it in the first place. Adobe has a helpful article that covers the end-to-end basics, but sometimes, you just need a basic setup to get you going.

Here's a scaffold that I designed for Adobe Web SDK with Adobe Client Data Layer (ACDL) as the data layer and Adobe Experience Platform Tags (a.k.a. Adobe Launch) as the tag management system.

The full gist is at https://gist.github.com/yuhui/0cb20fdcc21a03357c4a217edc58d63a.

I've listed out the minimal set of:

  • extensions
  • data elements, and
  • rules

that need to be set up in Adobe Launch to enable complete tracking of your website's usage data to Adobe Analytics via Web SDK + ACDL, i.e. your website with Adobe Launch -> ACDL -> Web SDK -> Analytics.

Hopefully, this scaffold is useful for those of you who are getting started with implementing Web SDK for Analytics, or migrating from Analytics' AppMeasurement to Web SDK.

If you find any errors or have any comments, please feel free to leave them here so that I can address them and/or correct myself.

(A "scaffold" is a software implementation term referring to a minimal setup that's needed for any software project to begin development. Reference: Wikipedia)

view raw 0 Adobe Launch property scaffold using Adobe Web SDK to send events to Adobe Analytics.md hosted with ❤ by GitHub
{
"event": "string",
"eventInfo": {
"category": "string",
"destination": "string",
"name": "string"
},
"commerce": {
"checkout": {
"stepName": "string",
"stepNumber": "integer"
},
"eventType": "string",
"order": {
"currencyCode": "string",
"payments": [
{
"paymentType": "string"
}
]
"priceTotal": "float",
"purchaseID": "string"
},
"promotionID": "string"
},
"form": {
"errorFields": [
"string"
],
"eventType": "string",
"fields": [
"string"
],
"name": "string"
},
"internalSiteSearch": {
"numberOfResults": "integer",
"term": "string"
},
"productListItems": [
{
"lineItemId": "string",
"name": "string",
"quantity": "integer",
"SKU": "string",
"unitPrice": "float",
"discount": "float"
}
],
"userAccount": {
"loginID": "string",
"loginStatus": "string",
},
"userFlow": {
"name": "string",
"step": "string"
},
"web": {
"webPageDetails": {
"language": "string",
"name": "string",
"siteSection": "string"
}
}
}
view raw ACDL schema.json hosted with ❤ by GitHub

Extension: Mapping Table

Data Element type: Mapping Table
Enable Default Value: checked
Default Value: 0

  • Default Value: checked
  • Data Element: %checkout step number and name%
Method Input Output
regular expression \d|[\w\s]+ 1
view raw Data Element: checkout step counter.md hosted with ❤ by GitHub

Extension: Core

Data Element type: Conditional Value
Enable Default Value: unchecked

  • Left operand: %event.message.event%
  • Operator: Equals
  • Case Insensitive: unchecked
  • Right operand: checkout step event
  • Return conditional value: checked
  • If true, return this value: %ACDL commerce.eventType%
  • Return fallback value: unchecked
view raw Data Element: checkout step event type.md hosted with ❤ by GitHub

Extension: Data Element Assistant

Data Element type: Concatenate
Enable Default Value: unchecked

  • Leading Delimiter: (blank) Input: Data Element: %ACDL commerce.checkout.stepNumber% Omit if empty: unchecked
  • Delimiter: | Input: Data Element: %ACDL commerce.checkout.stepName% Omit if empty: unchecked
view raw Data Element: checkout step number and name.md hosted with ❤ by GitHub

Extension: Mapping Table

Data Element type: Mapping Table
Enable Default Value: checked
Default Value: 0

  • Default Value: unchecked
  • Data Element: %ACDL commerce.eventType%
Method Input Output
exact match add to cart 1
exact match checkout 1
exact match product detail 1
exact match purchase 1
exact match remove from cart 1
exact match view cart 1
view raw Data Element: commerce counter.md hosted with ❤ by GitHub

Extension: Core

Data Element type: Conditional Value
Enable Default Value: unchecked

  • Left operand: %event.message.event%
  • Operator: Equals
  • Case Insensitive: unchecked
  • Right operand: commerce event
  • Return conditional value: checked
  • If true, return this value: %ACDL commerce.eventType%
  • Return fallback value: unchecked
view raw Data Element: commerce event type.md hosted with ❤ by GitHub

Extension: Core

Data Element type: Conditional Value
Enable Default Value: unchecked

  • Left operand: %event.message.event%
  • Operator: Matches Regex
  • Case Insensitive: unchecked
  • Right operand: ^(add to|remove from) cart$
  • Return conditional value: checked
  • If true, return this value: %event.message.productListItems%
  • Return fallback value: checked
  • Otherwise, return this value: %ACDL productListItems%

Notes:
"add to cart" and "remove from cart" events need to get the products from the pushed data because the resolved %ACDL productListItems% data element merges previous products into one final array. This results in wrong products being tracked with these 2 events.

view raw Data Element: commerce products.md hosted with ❤ by GitHub

Extension: Mapping Table

Data Element type: Mapping Table
Enable Default Value: unchecked

  • Default Value: checked
  • Data Element: %ACDL form.eventType%
Method Input Output
exact match error 1
exact match start 1
exact match submit 1
view raw Data Element: form counter.md hosted with ❤ by GitHub

Extension: Core

Data Element type: Conditional Value
Enable Default Value: unchecked

  • Left operand: %event.message.event%
  • Operator: Equals
  • Case Insensitive: unchecked
  • Right operand: form event
  • Return conditional value: checked
  • If true, return this value: %ACDL form.eventType%
  • Return fallback value: unchecked
view raw Data Element: form event type.md hosted with ❤ by GitHub

Extension: Core

Data Element type: JavaScript Tools
Enable Default Value: unchecked

  • Data Element (required): %ACDL form.fields%
  • Function: Array
  • Value Separator (required): |
view raw Data Element: form fields submitted successfully.md hosted with ❤ by GitHub

Extension: Core

Data Element type: JavaScript Tools
Enable Default Value: unchecked

  • Data Element (required): %ACDL form.errorFields%
  • Function: Array
  • Value Separator (required): |
view raw Data Element: form fields submitted with errors.md hosted with ❤ by GitHub
view raw Data Element: link name.md hosted with ❤ by GitHub
view raw Data Element: link type.md hosted with ❤ by GitHub

Extension: Core

Data Element type: Page Info
Enable Default Value: unchecked

  • Attribute: Hostname
view raw Data Element: Page Info hostname.md hosted with ❤ by GitHub

Extension: Core

Data Element type: Query String Parameter
Enable Default Value: checked
Default Value: leave blank

  • URL Query String Parameter Name (required): cmp
  • Allow capitalization differences (case-insensitive): checked
view raw Data Element: Query String Parameter cmp.md hosted with ❤ by GitHub

Extension: Core

Data Element type: Runtime Environment
Enable Default Value: unchecked

  • Attribute: Environment Stage
view raw Data Element: Runtime Environment Stage.md hosted with ❤ by GitHub

Extension: Mapping Table

Data Element type: Mapping Table
Enable Default Value: checked
Default Value: 0

  • Default Value: checked
  • Data Element: %userflow name and step%
Method Input Output
exact match login|logged in 1
exact match signup|signed up 1
view raw Data Element: userflow completed counter.md hosted with ❤ by GitHub

Extension: Data Element Assistant

Data Element type: Concatenate

Enable Default Value: unchecked
Force lowercase value: checked
Clean text: checked

Storage Duration: None

  • Leading Delimiter: (blank) Input: Data Element: %ACDL userFlow.name% Omit if empty: unchecked
  • Delimiter: | Input: Data Element: %ACDL userFlow.step% Omit if empty: unchecked
view raw Data Element: userflow name and step.md hosted with ❤ by GitHub

Extension: Mapping Table

Data Element type: Mapping Table
Enable Default Value: checked
Default Value: 0

  • Default Value: checked
  • Data Element: %userflow name and step%
Method Input Output
exact match login|start 1
exact match signup|start 1
view raw Data Element: userflow started counter.md hosted with ❤ by GitHub

Extension: Mapping Table

Data Element type: Mapping Table
Enable Default Value: unchecked

  • Default Value: checked
  • Data Element: %event.message.event%
Method Input Output
exact match page view web.webpagedetails.pageViews
exact match checkout step event web.webinteraction.linkClicks
exact match commerce event web.webinteraction.linkClicks
exact match custom link web.webinteraction.linkClicks
exact match download link web.webinteraction.linkClicks
exact match exit link web.webinteraction.linkClicks
exact match form event web.webinteraction.linkClicks
exact match internal search results event web.webinteraction.linkClicks
exact match userflow event web.webinteraction.linkClicks
view raw Data Element: Web SDK Send Event type.md hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('checkout step event type', event);
if (!commerceEventType || commerceEventType !== 'checkout') {
return {};
}
return {
customDimensions: {
eVars: {
eVar61: _satellite.getVar('checkout step number and name', event),
},
},
event1to100: {
event61: {
value: Number(_satellite.getVar('checkout step counter', event)) || 0,
},
},
};
view raw Data Element: XDM _experience.analytics checkout step events.js hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType || commerceEventType !== 'purchase') {
return {};
}
let paymentMethod = '';
const paymentTypes = _satellite.getVar('ACDL commerce.order.payments');
if (paymentTypes && Object.prototype.toString.call(paymentTypes) === '[object Array]' && paymentTypes.length > 0) {
paymentMethod = paymentTypes[0].paymentType;
}
return {
customDimensions: {
eVars: {
eVar62: paymentMethod,
eVar63: _satellite.getVar('ACDL commerce.promotionID'),
},
},
};
view raw Data Element: XDM _experience.analytics commerce events.js hosted with ❤ by GitHub
if (_satellite.getVar('Web SDK Send Event type', event) !== 'web.webinteraction.linkClicks') {
return {};
}
return {
customDimensions: {
eVars: {
eVar11: _satellite.getVar('link name', event),
},
},
event1to100: {
event11: {
value: 1,
},
},
};
view raw Data Element: XDM _experience.analytics custom links.js hosted with ❤ by GitHub
const formName = _satellite.getVar('form name', event);
const formEventType = _satellite.getVar('form event type', event);
if (!formName || !formEventType || formEventType !== 'error') {
return {};
}
return {
customDimensions: {
eVars: {
eVar21: formName,
eVar22: _satellite.getVar('form fields submitted successfully', event),
eVar23: _satellite.getVar('form fields submitted with errors', event),
},
},
event1to100: {
event23: {
value: Number(_satellite.getVar('form counter', event)) || 0,
},
},
};
view raw Data Element: XDM _experience.analytics form event error.js hosted with ❤ by GitHub
const formName = _satellite.getVar('form name', event);
const formEventType = _satellite.getVar('form event type', event);
if (!formName || !formEventType || formEventType !== 'start') {
return {};
}
return {
customDimensions: {
eVars: {
eVar21: formName,
},
},
event1to100: {
event21: {
value: Number(_satellite.getVar('form counter', event)) || 0,
},
},
};
view raw Data Element: XDM _experience.analytics form event start.js hosted with ❤ by GitHub
const formName = _satellite.getVar('form name', event);
const formEventType = _satellite.getVar('form event type', event);
if (!formName || !formEventType || formEventType !== 'submit') {
return {};
}
return {
customDimensions: {
eVars: {
eVar21: formName,
eVar22: _satellite.getVar('form fields submitted successfully', event),
},
},
event1to100: {
event22: {
value: Number(_satellite.getVar('form counter', event)) || 0,
},
},
};
view raw Data Element: XDM _experience.analytics form event submit.js hosted with ❤ by GitHub

Extension: Core

Data Element type: Merged Objects
Enable Default Value: unchecked

  • Object (required): %XDM _experience.analytics form event start%
  • Object (required): %XDM _experience.analytics form event submit%
  • Object (required): %XDM _experience.analytics form event error%
view raw Data Element: XDM _experience.analytics form events.md hosted with ❤ by GitHub
const pageName = _satellite.getVar('ACDL web.webPageDetails.name');
const pageLanguage = _satellite.getVar('ACDL web.webPageDetails.language');
const siteSection = _satellite.getVar('ACDL web.webPageDetails.siteSection');
return {
customDimensions: {
eVars: {
eVar1: pageName,
eVar2: pageLanguage,
eVar3: siteSection,
},
hierarchies: {
hier1: {
delimiter: ':',
values: pageName.split(':'),
},
},
},
};
view raw Data Element: XDM _experience.analytics global.js hosted with ❤ by GitHub
if (_satellite.getVar('Web SDK Send Event type', event) !== 'web.webpagedetails.pageViews' || (!event.message || !event.message.event || event.message.event !== 'internal search results event')) {
return {};
}
const internalSiteSearchTerm = _satellite.getVar('ACDL internalSiteSearch.term');
let internalSiteSearchNumberOfResults = Number(_satellite.getVar('ACDL internalSiteSearch.numberOfResults')) || 0;
// first, change the number 0 to 'zero'
if (internalSiteSearchNumberOfResults === 0) {
internalSiteSearchNumberOfResults = 'zero';
}
// then, stringify the value
internalSiteSearchNumberOfResults = String(internalSiteSearchNumberOfResults);
if (!internalSiteSearchTerm || !internalSiteSearchNumberOfResults) {
return {};
}
return {
customDimensions: {
eVars: {
eVar31: internalSiteSearchTerm,
eVar32: internalSiteSearchNumberOfResults,
},
},
event1to100: {
event31: {
value: 1,
},
},
};
view raw Data Element: XDM _experience.analytics internal search results.js hosted with ❤ by GitHub
const loginId = _satellite.getVar('ACDL userAccount.loginID');
if (!loginId) {
return {};
}
return {
customDimensions: {
eVars: {
eVar4: _satellite.getVar('ACDL userAccount.loginStatus'),
eVar5: loginId,
},
},
};
view raw Data Element: XDM _experience.analytics member.js hosted with ❤ by GitHub
if (!event.message || !event.message.event || event.message.event !== 'userflow event') {
return {};
}
const userflowStartedCounter = Number(_satellite.getVar('userflow started counter', event)) || 0;
const userflowCompletedCounter = Number(_satellite.getVar('userflow completed counter', event)) || 0;
return {
customDimensions: {
eVars: {
eVar41: _satellite.getVar('ACDL userFlow.name'),
},
},
event1to100: {
event41: {
value: userflowCompletedCounter,
},
event42: {
value: userflowStartedCounter,
},
},
};
view raw Data Element: XDM _experience.analytics userflow events.js hosted with ❤ by GitHub

Extension: Core

Data Element type: Merged Objects
Enable Default Value: unchecked

  • Object (required): %XDM _experience.analytics global%
  • Object (required): %XDM _experience.analytics member%
  • Object (required): %XDM _experience.analytics custom links%
  • Object (required): %XDM _experience.analytics userflow events%
  • Object (required): %XDM _experience.analytics checkout step events%
  • Object (required): %XDM _experience.analytics commerce events%
  • Object (required): %XDM _experience.analytics form events%
  • Object (required): %XDM _experience.analytics internal search results%
view raw Data Element: XDM _experience.analytics.md hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType || commerceEventType !== 'checkout') {
return {};
}
return {
checkouts: {
value: Number(_satellite.getVar('commerce counter', event)) || 0,
},
};
view raw Data Element: XDM commerce.checkouts.js hosted with ❤ by GitHub

Extension: Core

Data Element type: Merged Objects
Enable Default Value: unchecked

  • Object (required): %XDM commerce.productViews%
  • Object (required): %XDM commerce.productListViews%
  • Object (required): %XDM commerce.productListAdds%
  • Object (required): %XDM commerce.productListRemovals%
  • Object (required): %XDM commerce.checkouts%
  • Object (required): %XDM commerce.order, promotionID, purchases%
view raw Data Element: XDM commerce.md hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType || commerceEventType !== 'purchase') {
return {};
}
return {
order: {
currencyCode: _satellite.getVar('ACDL commerce.order.currencyCode'),
payments: _satellite.getVar('ACDL commerce.order.payments'),
priceTotal: _satellite.getVar('ACDL commerce.order.priceTotal') || 0.00,
purchaseID: _satellite.getVar('ACDL commerce.order.purchaseID'),
},
promotionID: _satellite.getVar('ACDL commerce.promotionID'),
purchases: {
value: Number(_satellite.getVar('commerce counter', event)) || 0,
},
};
view raw Data Element: XDM commerce.order, promotionID, purchases.js hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType || commerceEventType !== 'add to cart') {
return {};
}
return {
productListAdds: {
value: Number(_satellite.getVar('commerce counter', event)) || 0,
},
};
view raw Data Element: XDM commerce.productListAdds.js hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType || commerceEventType !== 'remove from cart') {
return {};
}
return {
productListRemovals: {
value: Number(_satellite.getVar('commerce counter', event)) || 0,
},
};
view raw Data Element: XDM commerce.productListRemovals.js hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType || commerceEventType !== 'view cart') {
return {};
}
return {
productListViews: {
value: Number(_satellite.getVar('commerce counter', event)) || 0,
},
};
view raw Data Element: XDM commerce.productListViews.js hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType || commerceEventType !== 'product detail') {
return {};
}
return {
productViews: {
value: Number(_satellite.getVar('commerce counter', event)) || 0,
},
};
view raw Data Element: XDM commerce.productViews.js hosted with ❤ by GitHub
/**
*
* Dependencies:
*
* Experience Platform > Customer > Identities:
* includes an identity symbol: "Membership"
*/
const loginID = _satellite.getVar('ACDL userAccount.loginID');
if (!loginID) {
return {};
}
if (event.message && event.message.event && event.message.event === 'logout event') {
// received ACDL push when the member logged out
return {
'Membership': [
{
'id': loginID,
'authenticatedState': 'loggedOut',
},
],
};
}
return {
'Membership': [
{
'id': loginID,
'authenticatedState': 'authenticated',
},
],
};
view raw Data Element: XDM identityMap.js hosted with ❤ by GitHub

Extension: Core

Data Element type: Conditional Value
Enable Default Value: checked
Default Value: leave blank

  • Left operand: %Web SDK Send Event type%
  • Operator: Equals
  • Case Insensitive: unchecked
  • Right operand: web.webpagedetails.pageViews
  • Return conditional value: checked
  • If true, return this value: %Query String Parameter cmp%
  • Return fallback value: unchecked
view raw Data Element: XDM marketing.trackingCode.md hosted with ❤ by GitHub

Extension: Adobe Experience Platform Web SDK

Data Element type: XDM object
Enable Default Value: unchecked

  • _experience:
    • analytics:
      • Provide entire object: selected
      • Data element: %XDM _experience.analytics%
  • commerce:
    • Provide entire object: selected
    • Data element: %XDM commerce%
  • identityMap:
    • Data element: %XDM identityMap%
  • marketing:
    • trackingCode:
      • Value: %XDM marketing.trackingCode%
  • productListItems:
    • Provide entire array: selected
    • Data element: %XDM productListItems%
  • web:
    • webInteraction:
      • Provide entire object: selected
      • Data element: %XDM web.webInteraction%
    • webPageDetails:
      • Provide entire object: selected
      • Data element: %XDM web.webPageDetails%
view raw Data Element: XDM object.md hosted with ❤ by GitHub
const commerceEventType = _satellite.getVar('commerce event type', event);
if (!commerceEventType) {
return [];
}
const products = _satellite.getVar('commerce products', event);
if (!products || Object.prototype.toString.call(products) !== '[object Array]' || products.length === 0) {
return [];
}
return products.sort((x, y) => {
if (x.SKU > y.SKU) {
return 1;
} else if (x.SKU < y.SKU) {
return -1;
} else {
return 0;
}
}).map((product) => {
const {lineItemId, name, SKU} = product;
const [productCategory, productName, productSku] = [lineItemId, name, SKU].map((p) => {
p = p.replace('&amp;', 'and');
p = p.replace('&apos;', "'");
p = p.replace('&colon;', ':');
p = p.replace('&commat;', '@');
p = p.replace('&comma;', ''); // special case! because "," is a reserved character in Adobe Analytics
p = p.replace('&dollar;', '$');
p = p.replace('&equals;', '=');
p = p.replace('&excl;', '!');
p = p.replace('&grave;', '`');
p = p.replace('&gt;', '>');
p = p.replace('&hat;', '^');
p = p.replace('&lbrace;', '{');
p = p.replace('&lbrack;', '[');
p = p.replace('&lcub;', '{');
p = p.replace('&lpar;', '(');
p = p.replace('&lowbar;', '_');
p = p.replace('&lsqb;', '[');
p = p.replace('&lt;', '<');
p = p.replace('&nbsp;', ' ');
p = p.replace('&num;', '#');
p = p.replace('&percnt;', '%');
p = p.replace('&period;', '.');
p = p.replace('&plus;', '+');
p = p.replace('&quest;', '?');
p = p.replace('&quot;', '"');
p = p.replace('&rbrace;', '}');
p = p.replace('&rbrack;', ']');
p = p.replace('&rcub;', '}');
p = p.replace('&rpar;', ')');
p = p.replace('&rsqb;', ']');
p = p.replace('&semi;', ''); // special case! because ";" is a reserved character in Adobe Analytics
p = p.replace('&sol;', '/');
p = p.replace('&verbar;', ''); // special case! because "|" is a reserved character in Adobe Analytics
p = p.replace('&vert;', ''); // special case! because "|" is a reserved character in Adobe Analytics
p = p.replace('&verticalline;', ''); // special case! because "|" is a reserved character in Adobe Analytics
p = p.replace(/[,;\|]/g, ''); // finally, just remove all of the reserved characters
return p.trim();
});
const productQuantity = Number(product.quantity) || 0;
const productPrice = Number(product.unitPrice) || 0.0;
const productRevenue = productQuantity * productPrice;
const productDiscount = Number(product.discount) || 0.0;
const productListItem = {
lineItemId: productCategory.toLowerCase(),
name: productName.toLowerCase(),
priceTotal: productRevenue,
quantity: productQuantity,
_experience: {
analytics: {
customDimensions: {
eVars: {
eVar71: productSku,
},
},
event1to100: {
event71: {
value: priceDiscount,
},
},
},
},
};
return productListItem;
});
view raw Data Element: XDM productListItems.js hosted with ❤ by GitHub
if (_satellite.getVar('Web SDK Send Event type', event) !== 'web.webinteraction.linkClicks') {
return {};
}
return {
URL: event.message.eventInfo.destination || '',
linkClicks: {
value: Number(_satellite.getVar('XDM web.webInteraction.linkClicks.value', event)) || 0,
},
name: _satellite.getVar('link name', event),
type: _satellite.getVar('link type', event),
};
view raw Data Element: XDM web.webInteraction.js hosted with ❤ by GitHub

Extension: Core

Data Element type: Conditional Value
Enable Default Value: checked
Default Value: 0

  • Left operand: %Web SDK Send Event type%
  • Operator: Equals
  • Case Insensitive: unchecked
  • Right operand: web.webinteraction.linkClicks
  • Return conditional value: checked
  • If true, return this value: 1
  • Return fallback value: checked
  • Otherwise, return this value: 0
view raw Data Element: XDM web.webInteraction.linkClicks.value.md hosted with ❤ by GitHub
const pageName = _satellite.getVar('ACDL web.webPageDetails.name');
const siteSection = _satellite.getVar('ACDL web.webPageDetails.siteSection');
return {
name: pageName,
pageViews: {
value: Number(_satellite.getVar('XDM web.webPageDetails.pageViews.value', event)) || 0,
},
server: _satellite.getVar('Page Info hostname'),
siteSection: siteSection,
};
view raw Data Element: XDM web.webPageDetails.js hosted with ❤ by GitHub

Extension: Core

Data Element type: Conditional Value
Enable Default Value: checked
Default Value: 0

  • Left operand: %Web SDK Send Event type%
  • Operator: Equals
  • Case Insensitive: unchecked
  • Right operand: web.webpagedetails.pageViews
  • Return conditional value: checked
  • If true, return this value: 1
  • Return fallback value: checked
  • Otherwise, return this value: 0
view raw Data Element: XDM web.webPageDetails.pageViews.value.md hosted with ❤ by GitHub
// Modify content.xdm or content.data as necessary. There is no need to wrap the
// code in a function or return a value. For example:
// content.xdm.web.webPageDetails.name = "Checkout";
let sendHit = true;
switch (content.xdm.eventType) {
case 'web.webpagedetails.pageViews':
// nothing to do here
// keep calm and carry on
break;
case 'web.webinteraction.linkClicks':
if (content.xdm.web && content.xdm.web.webInteraction) {
// Click data collection is great for automatically tracking clicks on links but it has room for improvement:
// 1. Don't collect click data automatically for "other" links (i.e. custom links).
// 2. Delete the link name for "download" and "exit" links.
if (content.xdm.web.webInteraction.name === 'Link Click') {
switch (content.xdm.web.webInteraction.type) {
case 'other':
// ** DO NOT track "other" web.webInteraction.type **
// For navigational links, explicit Custom Links should be tracked instead.
_satellite.logger.debug('abort Web SDK for automatic Link Click tracking!');
sendHit = false;
break;
case 'download':
case 'exit':
// ** DELETE web.webInteraction.name when web.webInteraction.type is "download" or "exit" **
// This is for Adobe Analytics' benefit, so that the resulting Download Links and Exit Links dimensions
// get populated with the download/exit links' URLs, instead of the default "Link Click".
_satellite.logger.debug('delete link name for Web SDK for automatic Download/Exit Link Click tracking!');
delete content.xdm.web.webInteraction.name;
break;
}
}
}
break;
default:
if (content.xdm.web && content.xdm.web.webPageDetails) {
if (content.xdm.web.webPageDetails.pageViews && (!content.xdm.web.webPageDetails.pageViews.value || content.xdm.web.webPageDetails.pageViews.value === 0)) {
// A page is being tracked when there was no intention to, e.g. when getting personalisation data from Target
// but this causes the web.webPageDetails.pageViews.value to be unset or 0
// so change this to a Custom Link
// DON'T drop the hit! Otherwise dependent executions, e.g. getting Target personalisation data, will fail.
content.xdm.web.webInteraction = content.xdm.web.webInteraction || {};
content.xdm.web.webInteraction.type = 'other';
content.xdm.web.webInteraction.name = `ExperienceEvent type: ${content.xdm.eventType || 'no Web SDK event type'}`;
}
}
break;
}
if (sendHit) {
// An automatically tracked hit ONLY has the default XDM object fields set in it
// so set all of the other fields that are required globally
// Test for presence of eVar1, which is sent with every hit
if (!content.xdm._experience || !content.xdm._experience.analytics || !content.xdm._experience.analytics.customDimensions || !content.xdm._experience.analytics.customDimensions.eVars || !content.xdm._experience.analytics.customDimensions.eVars.eVar1) {
const globalXdmObject = _satellite.getVar('XDM object', event);
content.xdm = Object.assign({}, globalXdmObject, content.xdm); // ensure that content.xdm is the last object to be assigned because it could have been updated above
}
}
// Log the XDM object for debugging purposes
if (_satellite.getVar('Runtime Environment Stage') !== 'production') {
_satellite.logger.debug('final XDM object to track', content.xdm);
}
return sendHit;
view raw Extension: Data Collection: Edit on before send event callback code.js hosted with ❤ by GitHub

Events

Adobe Client Data Layer - Data Pushed with all events, order 50

Extension: Adobe Client Data Layer

Event type: Data Pushed

Order: 50

  • Listen to: All Events
  • Time scope: all

Conditions

Web SDK Send Event type is truthy

Logic Type: Regular

Extension: Core

Condition type: Value Comparison

Timeout in milliseconds: 2000

  • Left Operand (required): %Web SDK Send Event type%
  • Operator: Is Truthy

Actions

Adobe Experience Platform Web SDK - Send event, render visual personalisation decisions

Extension: Adobe Experience Platform Web SDK

Action type: Send event

  • Type: %Web SDK Send Event type%
  • XDM data: %XDM object%
  • Data: blank
  • Merge ID: blank
  • Dataset ID: blank
  • Document will unload: unchecked
  • Render visual personalization decisions: checked
  • Decision scopes:
    • Manually enter scopes: selected
    • Provide a data element: unselected
    • Scope: blank
view raw Rule: ACDL (050): all events when Web SDK Send Event type is valid >>WebSDK.md hosted with ❤ by GitHub

Events

Adobe Client Data Layer - Data Pushed with all events, order 50

Extension: Adobe Client Data Layer

Event type: Data Pushed

Order: 50

  • Listen to: All Events
  • Time scope: all

Conditions

Web SDK Send Event type is truthy

Logic Type: Regular

Extension: Core

Condition type: Value Comparison

Timeout in milliseconds: 2000

  • Left Operand (required): %Web SDK Send Event type%
  • Operator: Is Truthy

Launch Build Info environment equals "production"

Logic Type: Exception

Extension: Core

Condition type: Value Comparison

Timeout in milliseconds: 2000

  • Left Operand (required): %Runtime Environment Stage%
  • Operator: Equals (Case Insensitive: checked)
  • Right Operand: production

Actions

Logging

Extension: Core

Action type: Custom Code

  • Language: JavaScript
  • Execute globally: unchecked
console.group(`logging: ${event.message.event}`);
console.log(`Web SDK Send Event type: ${_satellite.getVar('Web SDK Send Event type', event)}`);
console.log('ACDL', adobeDataLayer.getState());
console.groupEnd();
view raw Rule: ACDL (050): all events when Web SDK Send Event type is valid EXCEPT in production environment >>logging.md hosted with ❤ by GitHub

Comments

Post a Comment

Popular posts from this blog

How to "unpivot" a table in BigQuery

Recently, I was presented with a problem in BigQuery: How do I make a table's metrics be returned as rows? Normally, metrics are presented as columns and dimensions as rows. But in this case, I needed the metrics to appear as rows too. In short, I needed to "unpivot" a table like this: Dimension1 Dimension2 Metric1 Metric2 Metric3 to this: Dimension1 Dimension2 Metric Data Metric1 Metric2 Metric3 Metric1 Metric2 Metric3 Metric1 Metric2 Metric3 The solutions lay with three BigQuery features: STRUCT type ARRAY s CROSS JOIN with the UNNEST operator How to get unpivoted results in BigQuery Let's say I have data like this in a table called "Campaign_Results": Row Superhero Title Date Impressions Clicks Conversions 1 Superman Man of Steel 2013-06-14 5670096 796191 82538 2 Batman Batman v Superman: Dawn of Justice 2016-03-25 9742525 876292 63812 3 Wonder Woman Wonder Woman 2017-06-02 4847506 420674 23428 Bu...
Read more

Adobe Analytics and Google Analytics terminologies cheat sheet

When going from an Adobe Analytics world to a Google Analytics world or vice versa, you're bound to face terminologies that you're unfamiliar with, mainly because of how both products have evolved in their functionality over time. But never fear! Here's a handy cheat sheet to help you know what something in Adobe Analytics is similar ( but not always equivalent! ) to in Google Analytics, or the other way around. Base Terminologies Adobe Analytics Google Analytics Remarks Report Suite Property Besides data storage, an Adobe Analytics Report Suite provides the primary reporting interface. A Google Analytics Property does not have a reporting interface. Instead, its reporting interface is a View. Virtual Report Suite View An Adobe Analytics Virtual Report Suite is based on applying a segment to a Report Suite. A Google Analytics View is based on applying many filters to a Property. Visitor ID Client ID Modern implementations of Adobe Analytics rel...
Read more

Querying Google Analytics data as flat tables from BigQuery: The Definitive Guide and Recipe

Image
If you're using Google Analytics 360, the premium version of Google Analytics, then chances are you have setup an automatic export of your Google Analytics data into BigQuery. This allows your hit-level data in Google Analytics to be exported to BigQuery datasets every day. But Google does not provide much help with figuring out how to query your data! Google Analytics provides a cookbook of sample BigQuery queries . But these are very limited in scope. And they omit the most trivial -- yet important -- query that you will ever run: Get a flat table of results that you can export into a CSV file or a SQL database Flat tables are essential to perform further work on the results with Python, R and other data science languages. Another flaw in the cookbook is that it uses BigQuery's older Legacy SQL. BigQuery is already moving to its Standard SQL. But examples based on Google Analytics data were either difficult to find or based on guesswork that had not been tested...
Read more