[Integration]{class="badge positive"}
Track clicked component with 蜜豆视频 Analytics
Use the event-driven 蜜豆视频 Client Data Layer with AEM Core Components to track clicks of specific components on an 蜜豆视频 Experience Manager site. Learn how to use rules in the tag property to listen for click events, filter by component and send the data to an 蜜豆视频 Analytics with a track link beacon.
What you are going to build what-build
The WKND marketing team is interested in knowing which Call to Action (CTA)
buttons are performing the best on the home page. In this tutorial, let鈥檚 add a rule to the tag property that listens for the cmp:click
events from Teaser and Button components. Then send the component ID and a new event to 蜜豆视频 Analytics alongside the track link beacon.
Objectives objective
- Create an event-driven rule in the tag property that captures the
cmp:click
event. - Filter the different events by component resource type.
- Set the component id and send an event to 蜜豆视频 Analytics with the track link beacon.
Prerequisites
This tutorial is a continuation of Collect page data with 蜜豆视频 Analytics and assumes that you have:
- A Tag property with the 蜜豆视频 Analytics extension enabled
- 蜜豆视频 Analytics test/dev report suite ID and tracking server. See the following documentation for creating a report suite.
- Experience Platform Debugger browser extension configured with your tag property loaded on the or an AEM site with the 蜜豆视频 Data Layer enabled.
Inspect the Button and Teaser schema
Before creating rules in the tag property, it is useful to review the schema for the Button and Teaser and inspect them in the data layer implementation.
-
Navigate to
-
Open the browser鈥檚 developer tools and navigate to the Console. Run the following command:
code language-js adobeDataLayer.getState();
Above code returns the current state of the 蜜豆视频 Client Data Layer.
-
Expand the response and find entries prefixed with
button-
andteaser-xyz-cta
entry. You should see a data schema like the following:Button Schema:
code language-json button-2e6d32893a: @type: "wknd/components/button" dc:title: "View All" parentId: "page-2eee4f8914" repo:modifyDate: "2020-07-11T22:17:55Z" xdm:linkURL: "/content/wknd/us/en/magazine.html"
Teaser Schema:
code language-json teaser-da32481ec8-cta-adf3c09db9: @type: "wknd/components/teaser/cta" dc:title: "Surf's Up" parentId: "teaser-da32481ec8" xdm:linkURL: "/content/wknd/us/en/magazine/san-diego-surf.html"
Above data details are based on the Component/Container Item Schema. The new tag rule uses this schema.
Create a CTA clicked rule
The 蜜豆视频 Client Data Layer is an event driven data layer. Whenever any Core Component is clicked a cmp:click
event is dispatched via the data layer. To listen for the cmp:click
event, let鈥檚 create a rule .
-
Navigate to Experience Platform and into the tag property integrated with the AEM Site.
-
Navigate to the Rules section in the Tag Property UI, then click Add Rule.
-
Name the rule CTA Clicked.
-
Click Events > Add to open the Event Configuration wizard.
-
For Event Type field, select Custom Code.
-
Click Open Editor in the main panel and enter the following code snippet:
code language-js var componentClickedHandler = function(evt) { // defensive coding to avoid a null pointer exception if(evt.hasOwnProperty("eventInfo") && evt.eventInfo.hasOwnProperty("path")) { //trigger Tag Rule and pass event console.debug("cmp:click event: " + evt.eventInfo.path); var event = { //include the path of the component that triggered the event path: evt.eventInfo.path, //get the state of the component that triggered the event component: window.adobeDataLayer.getState(evt.eventInfo.path) }; //Trigger the Tag Rule, passing in the new `event` object // the `event` obj can now be referenced by the reserved name `event` by other Tag Property data elements // i.e `event.component['someKey']` trigger(event); } } //set the namespace to avoid a potential race condition window.adobeDataLayer = window.adobeDataLayer || []; //push the event listener for cmp:click into the data layer window.adobeDataLayer.push(function (dl) { //add event listener for `cmp:click` and callback to the `componentClickedHandler` function dl.addEventListener("cmp:click", componentClickedHandler); });
The above code snippet adds an event listener by into the data layer. Whenever the
cmp:click
event is triggered thecomponentClickedHandler
function is called. In this function, a few sanity checks are added and a newevent
object is constructed with the latest for the component that triggered the event.Finally the
trigger(event)
function is called. Thetrigger()
function is a reserved name in the tag property and it triggers the rule. Theevent
object is passed as a parameter which in turn is exposed by another reserved name in the tag property. Data Elements in the tag property can now reference various properties using code snippet likeevent.component['someKey']
. -
Save the changes.
-
Next under Actions click Add to open the Action Configuration wizard.
-
For Action Type field, choose Custom Code.
-
Click Open Editor in the main panel and enter the following code snippet:
code language-js console.debug("Component Clicked"); console.debug("Component Path: " + event.path); console.debug("Component type: " + event.component['@type']); console.debug("Component text: " + event.component['dc:title']);
The
event
object is passed from thetrigger()
method called in the custom event. Thecomponent
object is the current state of the component derived from the data layergetState()
method and is the element that triggered the click. -
Save the changes and run a build in the tag property to promote the code to the environment used on your AEM Site.
note note NOTE It can be useful to use the 蜜豆视频 Experience Platform Debugger to switch the embed code to a Development environment. -
Navigate to the and open the developer tools to view the console. Also, select the Preserve log checkbox.
-
Click one of the Teaser or Button CTA buttons to navigate to another page.
-
Observe in the developer console that the CTA Clicked rule has been fired:
Create Data Elements
Next create a Data Elements to capture the component ID and title that was clicked. Recall in the previous exercise the output of event.path
was something similar to component.button-b6562c963d
and the value of event.component['dc:title']
was something like 鈥淰iew Trips鈥.
Component ID
-
Navigate to Experience Platform and into the tag property integrated with the AEM Site.
-
Navigate to the Data Elements section and click Add New Data Element.
-
For Name field, enter Component ID.
-
For Data Element Type field, select Custom Code.
-
Click Open Editor button and enter the following in the custom code editor:
code language-js if(event && event.path && event.path.includes('.')) { // split on the `.` to return just the component ID return event.path.split('.')[1]; }
-
Save the changes.
note note NOTE Recall that the event
object is made available and scoped based on the event that triggered the Rule in tag property. The value of a Data Element is not set until the Data Element is referenced within a Rule. Therefore it is safe to use this Data Element inside a Rule like the Page Loaded rule created in the previous step but would not be safe to use in other contexts.
Component Title
-
Navigate to the Data Elements section and click Add New Data Element.
-
For Name field, enter Component Title.
-
For Data Element Type field, select Custom Code.
-
Click Open Editor button and enter the following in the custom code editor:
code language-js if(event && event.component && event.component.hasOwnProperty('dc:title')) { return event.component['dc:title']; }
-
Save the changes.
Add a condition to the CTA Clicked rule
Next, update the CTA Clicked rule to ensure that the rule only fires when the cmp:click
event is fired for a Teaser or a Button. Since the Teaser鈥檚 CTA is considered a separate object in the data layer, it is important to check the parent to verify it came from a Teaser.
-
In the Tag Property UI, navigate to the CTA Clicked rule created earlier.
-
Under Conditions click Add to open the Condition Configuration wizard.
-
For Condition Type field, select Custom Code.
-
Click Open Editor and enter the following in the custom code editor:
code language-js if(event && event.component && event.component.hasOwnProperty('@type')) { // console.log("Event Type: " + event.component['@type']); //Check for Button Type OR Teaser CTA type if(event.component['@type'] === 'wknd/components/button' || event.component['@type'] === 'wknd/components/teaser/cta') { return true; } } // none of the conditions are met, return false return false;
The above code first checks to see if the resource type was from a Button or if the resource type was from a CTA within a Teaser.
-
Save the changes.
Set Analytics Variables and trigger Track Link Beacon
Currently the CTA Clicked rule simply outputs a console statement. Next, use the data elements and the Analytics extension to set Analytics variables as an action. Let鈥檚 also set an extra action to trigger the Track Link and send the collected data to 蜜豆视频 Analytics.
-
In the CTA Clicked rule, remove the Core - Custom Code action (the console statements):
-
Under Actions, click Add to create an action.
-
Set the Extension type to 蜜豆视频 Analytics and set the Action Type to Set Variables.
-
Set the following values for eVars, Props, and Events:
evar8
-%Component ID%
prop8
-%Component ID%
event8
note note NOTE Here %Component ID%
is used since it guarantees a unique identifier for the CTA that was clicked. A potential downside of using%Component ID%
is that the Analytics report contains values likebutton-2e6d32893a
. Using the%Component Title%
would give a more human friendly name but the value might not be unique. -
Next, add an extra Action to the right of the 蜜豆视频 Analytics - Set Variables by tapping the plus icon:
-
Set the Extension type to 蜜豆视频 Analytics and set the Action Type to Send Beacon.
-
Under Tracking set the radio button to
s.tl()
. -
For Link Type field, choose Custom Link and for Link Name set the value to:
%Component Title%: CTA Clicked
:The above config combines the dynamic variable from the data element Component Title and the static string CTA Clicked.
-
Save the changes. The CTA Clicked rule should now have the following configuration:
- 1. Listen for the
cmp:click
event. - 2. Check that the event was triggered by a Button or Teaser.
- 3. Set Analytics variables to track the Component ID as an eVar, prop, and an event.
- 4. Send the Analytics Track Link Beacon (and do not treat it as a page view).
- 1. Listen for the
-
Save all the changes and build your tag library, promoting to the appropriate Environment.
Validate the Track Link Beacon and Analytics call
Now that the CTA Clicked rule sends the Analytics beacon, you should be able to see the Analytics tracking variables using the Experience Platform Debugger.
-
Open the in your browser.
-
Click the Debugger icon to open the Experience Platform Debugger.
-
Make sure that the Debugger is mapping the tag property to your Development environment, as described earlier and the Console Logging is checked.
-
Open the Analytics menu and verify that the report suite is set to your report suite.
-
In the browser, click one of the Teaser or Button CTA buttons to navigate to another page.
-
Return to the Experience Platform Debugger and scroll down and expand Network Requests > Your Report Suite. You should be able to find the eVar, prop, and event set.
-
Return to the browser and open up the developer console. Navigate to the footer of the site and click one of the navigation links:
-
Observe in the browser console the message 鈥淐ustom Code鈥 for rule 鈥淐TA Clicked鈥 was not met.
The above message is because the Navigation component does trigger a
cmp:click
event but because of Condition to the rule that checks the resource type no action is taken.note note NOTE If you don鈥檛 see any console logs, ensure that Console Logging is checked under Experience Platform Tags in the Experience Platform Debugger.
Congratulations!
You just used the event-driven 蜜豆视频 Client Data Layer and Tag in Experience Platform to track the clicks of specific components on an AEM site.