本节介绍有关开发与内容定位一起使用的组件的主题。
在AEM作者中定位某个组件时,该组件会向Adobe Target发起一系列服务器端调用,以注册该促销活动、设置选件和检索Adobe Target区段(如果已配置)。 不会从AEM发布到Adobe Target中进行服务器端调用。
要在与Adobe Target交互的页面中使用目标组件,请在<head>
元素中包含特定的客户端代码。
将以下两个代码块添加到页面的<head>部分:
<!--/* Include Context Hub */-->
<sly data-sly-resource="${'contexthub' @ resourceType='granite/contexthub/components/contexthub'}"/>
<cq:include script="/libs/cq/cloudserviceconfigs/components/servicelibs/servicelibs.jsp"/>
此代码可添加所需的Analytics Javascript对象并加载与网站关联的云服务库。 对于Target服务,将通过/libs/cq/analytics/components/testandtarget/headlibs.jsp
加载库
加载的库集取决于Target配置中使用的Target客户端库(mbox.js或at.js)类型:
对于默认的mbox.js
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/parameters.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/mbox.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/personalization/integrations/commons.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/util.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/init.js"></script>
对于自定义mbox.js
<script type="text/javascript" src="/etc/cloudservices/testandtarget/<CLIENT-CODE>/_jcr_content/public/mbox.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/parameters.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/personalization/integrations/commons.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/util.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/init.js"></script>
对于at.js
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/parameters.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/atjs-integration.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/atjs.js"></script>
仅支持随产品一起提供的at.js
版本。 通过查看位于/etc/clientlibs/foundation/testandtarget/atjs/source/at.js
的at.js
文件,可以获取随产品一起提供的at.js
版本。
对于自定义at.js
<script type="text/javascript" src="/etc/cloudservices/testandtarget/<CLIENT-CODE>/_jcr_content/public/at.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/parameters.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/atjs-integration.js"></script>
客户端上的Target功能由CQ_Analytics.TestTarget
对象管理。 因此,页面将包含一些init代码,如以下示例中所示:
<script type="text/javascript">
if ( !window.CQ_Analytics ) {
window.CQ_Analytics = {};
}
if ( !CQ_Analytics.TestTarget ) {
CQ_Analytics.TestTarget = {};
}
CQ_Analytics.TestTarget.clientCode = 'my_client_code';
</script>
...
<div class="cloudservice testandtarget">
<script type="text/javascript">
CQ_Analytics.TestTarget.maxProfileParams = 11;
if (CQ_Analytics.CCM) {
if (CQ_Analytics.CCM.areStoresInitialized) {
CQ_Analytics.TestTarget.registerMboxUpdateCalls();
} else {
CQ_Analytics.CCM.addListener("storesinitialize", function (e) {
CQ_Analytics.TestTarget.registerMboxUpdateCalls();
});
}
} else {
// client context not there, still register calls
CQ_Analytics.TestTarget.registerMboxUpdateCalls();
}
</script>
</div>
JSP会将所需的Analytics Javascript对象和引用添加到客户端Javascript库。 testandtarget.js
文件包含mbox.js
函数。 脚本生成的HTML与以下示例类似:
<script type="text/javascript">
if ( !window.CQ_Analytics ) {
window.CQ_Analytics = {};
}
if ( !CQ_Analytics.TestTarget ) {
CQ_Analytics.TestTarget = {};
}
CQ_Analytics.TestTarget.clientCode = 'MyClientCode';
</script>
<link rel="stylesheet" href="/etc/clientlibs/foundation/testandtarget/testandtarget.css" type="text/css">
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/testandtarget.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/testandtarget/init.js"></script>
在<body>
标记后面添加以下代码,以将客户端上下文功能添加到页面:
<cq:include path="clientcontext" resourceType="cq/personalization/components/clientcontext"/>
在</body>
结束标记之前添加以下代码:
<cq:include path="cloudservices" resourceType="cq/cloudserviceconfigs/components/servicecomponents"/>
此组件的JSP脚本生成对Target Javascript API的调用并实现其他必需的配置。 脚本生成的HTML与以下示例类似:
<div class="servicecomponents cloudservices">
<div class="cloudservice testandtarget">
<script type="text/javascript">
CQ_Analytics.TestTarget.maxProfileParams = 11;
CQ_Analytics.CCM.addListener("storesinitialize", function(e) {
CQ_Analytics.TestTarget.registerMboxUpdateCalls();
});
</script>
<div id="cq-analytics-texthint" style="background:white; padding:0 10px; display:none;">
<h3 class="cq-texthint-placeholder">Component clientcontext is missing or misplaced.</h3>
</div>
<script type="text/javascript">
$CQ(function(){
if( CQ_Analytics &&
CQ_Analytics.ClientContextMgr &&
!CQ_Analytics.ClientContextMgr.isConfigLoaded )
{
$CQ("#cq-analytics-texthint").show();
}
});
</script>
</div>
</div>
如果您没有使用DTM或其他Target营销系统,则可以使用自定义Target库文件。
默认情况下,mbox是隐藏的 — mboxDefault类确定此行为。 隐藏mbox可确保访客在交换默认内容之前不会看到默认内容;但是,隐藏mbox会影响感知到的性能。
用于创建mbox的默认mbox.js文件位于/etc/clientlibs/foundation/testandtarget/mbox/source/mbox.js
。 要使用客户mbox.js文件,请将该文件添加到Target云配置中。 要添加文件,文件系统上必须有mbox.js
文件。
例如,如果您要使用Marketing CloudID服务,则需要下载mbox.js,以便它包含imsOrgID
变量的正确值,该值基于您的租户。 与Marketing CloudID服务集成时需要此变量。 有关信息,请参阅Adobe Analytics作为Adobe Target和实施之前的报表源。
如果在Target配置中定义了自定义mbox,则每个人都必须拥有对发布服务器上**/etc/cloudservices**的读取访问权限。 如果没有此访问权限,则在发布网站上加载mbox.js文件会导致404错误。
您的Target配置包含一个自定义mbox.js文件, 页面标题部分中的所需代码会将该文件添加到客户端库框架中,而不是对testandtarget.js库的引用。
大多数组件都可以使用上下文菜单中的Target命令转换为目标组件。
要从上下文菜单中删除Target命令,请将以下属性添加到组件的cq:editConfig节点:
cq:disableTargeting
Boolean
True
例如,要禁用Geometrixx演示网站页面标题组件的定位,请将属性添加到/apps/geometrixx/components/title/cq:editConfig
节点。
如果您没有使用DTM,则会向Adobe Target发送订单确认。
要跟踪网站的性能,请将购买信息从订单确认页面发送到Adobe Target。 (请参阅Adobe Target文档中的创建orderConfirmPage Mbox 。) 当您的MBOX名称为orderConfirmPage
时,Adobe Target会将mbox数据识别为订单确认数据,并使用以下特定参数名称:
呈现的HTML页面上用于创建mbox的代码与以下示例类似:
<script type="text/javascript">
mboxCreate('orderConfirmPage',
'productPurchasedId=product1 product2 product3',
'orderId=order1234',
'orderTotal=24.54');
</script>
每个顺序的每个参数的值都不同。 因此,您需要一个组件,该组件会根据购买的属性生成代码。 CQ 电子商务集成框架允许您与产品目录集成并实施购物车和结帐页面。
Geometrixx Outdoors示例在访客购买产品时显示以下确认页面:
组件的JSP脚本的以下代码访问购物车的属性,然后打印用于创建mbox的代码。
<%--
confirmationmbox component.
--%><%
%><%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false"
import="com.adobe.cq.commerce.api.CommerceService,
com.adobe.cq.commerce.api.CommerceSession,
com.adobe.cq.commerce.common.PriceFilter,
com.adobe.cq.commerce.api.Product,
java.util.List, java.util.Iterator"%><%
/* obtain the CommerceSession object */
CommerceService commerceservice = resource.adaptTo(CommerceService.class);
CommerceSession session = commerceservice.login(slingRequest, slingResponse);
/* obtain the cart items */
List<CommerceSession.CartEntry> entries = session.getCartEntries();
Iterator<CommerceSession.CartEntry> cartiterator = entries.iterator();
/* iterate the items and get the product IDs */
String productIDs = new String();
while(cartiterator.hasNext()){
CommerceSession.CartEntry entry = cartiterator.next();
productIDs = productIDs + entry.getProduct().getSKU();
if (cartiterator.hasNext()) productIDs = productIDs + ", ";
}
/* get the cart price and orderID */
String total = session.getCartPrice(new PriceFilter("CART", "PRE_TAX"));
String orderID = session.getOrderId();
%><div class="mboxDefault"></div>
<script type="text/javascript">
mboxCreate('orderConfirmPage',
'productPurchasedId=<%= productIDs %>',
'orderId=<%= orderID %>',
'orderTotal=<%= total %>');
</script>
在上一个示例中,当组件包含在结帐页面中时,页面源将包含以下创建mbox的脚本:
<div class="mboxDefault"></div>
<script type="text/javascript">
mboxCreate('orderConfirmPage',
'productPurchasedId=47638-S, 46587',
'orderId=d03cb015-c30f-4bae-ab12-1d62b4d105ca',
'orderTotal=US$677.00');
</script>
Target组件允许作者从CQ内容组件创建动态mbox。 (请参阅内容定位。) Target组件位于/libs/cq/personalization/components/target。
target.jsp脚本访问页面属性以确定要用于组件的定位引擎,然后执行相应的脚本:
/libs/cq/personalization/components/target/engine_tnt.jsp
/libs/cq/personalization/components/target/engine_atjs.jsp
/libs/cq/personalization/components/target/engine_cq_campaign.jsp
/libs/cq/personalization/components/target/engine_cq.jsp
默认情况下,mbox是隐藏的 — mboxDefault类确定此行为。 隐藏mbox可确保访客在交换默认内容之前不会看到默认内容;但是,隐藏mbox会影响感知到的性能。
当Adobe Target执行内容定位时,engine_tnt.jsp脚本会创建包含目标体验内容的mbox:
根据Adobe Target API的要求,添加类为mboxDefault
的div
元素。
在div
元素中添加mbox内容(目标体验的内容)。
在mboxDefault
div元素之后,插入创建mbox的javascript:
以下是可用的clientlib类别:
testandtarget.mbox
testandtarget.init
testandtarget.util
testandtarget.atjs
testandtarget.atjs-integration