文档Experience PlatformWeb SDK 指南

context

最近更新: 2024年8月19日
  • 主题:

创建对象:

  • 开发人员

context属性是一个字符串数组,用于确定Web SDK可自动收集的内容。 虽然此数据可以带来巨大价值,但忽略某些此类数据可能会有助益,这样您就可以遵守组织的隐私政策。

上下文关键字和XDM元素

如果您包含给定的上下文关键词,则Web SDK会自动填充其所有关联的XDM元素。 如果要在允许其他元素的同时忽略特定XDM元素,可以使用onBeforeEventSend清除值。 如果您在一个页面上发送多个事件,则Web SDK会在每SendEvent调用中包含这些字段。

Web

"web"关键字收集有关当前页面的信息。

维度描述XDM 路径示例值
Page URL当前页面的URL。xdm.web.webPageDetails.URLhttps://example.com/index.html
反向链接URL访问的上一个页面的URL。xdm.web.webReferrer.URLhttp://example.org/linkedpage.html

设备

"device"关键字收集有关用户设备的信息。

维度描述XDM 路径示例值
屏幕高度屏幕的高度(像素)。xdm.device.screenHeight900
屏幕宽度屏幕的宽度(像素)。xdm.device.screenWidth1440
屏幕方向屏幕的方向。xdm.device.screenOrientationlandscape或portrait

环境

"environment"关键字收集有关用户浏览器的信息。

维度描述XDM 路径示例值
环境类型体验通过哪种环境浮现。 Web SDK始终将此字段设置为browser。xdm.environment.typebrowser
视区高度浏览器内容区域的高度(像素)。xdm.environment.browserDetails.viewportHeight679
视区宽度浏览器内容区域的宽度(像素)。xdm.environment.browserDetails.viewportWidth642

地点上下文

"placeContext"关键字收集有关用户位置的信息。

维度描述XDM 路径示例值
本地时间以简化的扩展ISO 8601格式表示的最终用户的本地时间戳。xdm.placeContext.localTimeYYYY-08-07T15:47:17.129-07:00
本地时区偏移用户从GMT偏移的分钟数。xdm.placeContext.localTimezoneOffset360
国家/地区代码最终用户的国家/地区代码。xdm.placeContext.geo.countryCodeUS
省/市/自治区最终用户的省/市/自治区代码。xdm.placeContext.geo.stateProvinceCA
纬度最终用户位置的纬度。xdm.placeContext.geo._schema.latitude37.3307447
经度最终用户位置的经度。xdm.placeContext.geo._schema.longitude-121.8945965

时间戳

timestamp关键字收集有关事件时间戳的信息。 无法删除此上下文部分。

维度描述XDM 路径示例值
事件的时间戳以简化的扩展ISO 8601格式表示的最终用户的UTC时间戳。xdm.timestamp2019-08-07T22:47:17.129Z

实施详细信息

implementationDetails关键字收集有关用于收集事件的SDK版本的信息。

维度描述XDM 路径示例值
名称软件开发工具包(SDK)标识符。 此字段使用URI来改进由不同软件库提供的标识符之间的唯一性。xdm.implementationDetails.name使用独立库时,值为https://ns.adobe.com/experience/alloy。 当库用作标记扩展的一部分时,值为https://ns.adobe.com/experience/alloy+reactor。
版本软件开发工具包(SDK)版本。xdm.implementationDetails.version使用独立库时,该值为库版本。 当库用作标记扩展的一部分时,该值为库版本和使用+联接的标记扩展版本。 例如,如果库版本为2.1.0,而标记扩展版本为2.1.3,则值将为2.1.0+2.1.3。
环境收集数据的环境。 此项始终设置为browser。xdm.implementationDetails.environmentbrowser

高熵客户端提示

TIP
有关如何配置用户代理客户端提示的详细信息,请参阅相关文档。

"highEntropyUserAgentHints"关键字收集有关用户设备的详细信息。 此数据包含在发送到Adobe的请求的HTTP标头中。 数据抵达Edge网络后,XDM对象填充其各自的XDM路径。 如果您在sendEvent调用中设置相应的XDM路径,则该路径优先于HTTP标头值。

如果在配置数据流时使用设备查找,则可以清除数据,以支持设备查找值。 某些客户端提示字段和设备查找字段不能存在于同一点击中。

属性
描述
HTTP标头
XDM 路径
示例
操作系统版本
操作系统的版本。
Sec-CH-UA-Platform-Version
xdm.environment.browserDetails.
userAgentClientHints.platformVersion
10.15.7
架构
底层CPU体系结构。
Sec-CH-UA-Arch
xdm.environment.browserDetails.
userAgentClientHints.architecture
x86
设备型号
使用的设备的名称。
Sec-CH-UA-Model
xdm.environment.browserDetails.
userAgentClientHints.model
Intel Mac OS X 10_15_7
位数
基础CPU体系结构支持的位数。
Sec-CH-UA-Bitness
xdm.environment.browserDetails.
userAgentClientHints.bitness
64
浏览器供应商
创建浏览器的公司。 低熵提示Sec-CH-UA也收集此元素。
Sec-CH-UA-Full-Version-List
xdm.environment.browserDetails.
userAgentClientHints.vendor
Google
浏览器名称
使用的浏览器。 低熵提示Sec-CH-UA也收集此元素。
Sec-UA-Full-Version-List
xdm.environment.browserDetails.
userAgentClientHints.brand
Chrome
浏览器版本
浏览器的重要版本。 低熵提示Sec-CH-UA也收集此元素。 不会自动收集确切的浏览器版本。
Sec-UA-Full-Version-List
xdm.environment.browserDetails.
userAgentClientHints.version
105

使用Web SDK标记扩展收集上下文信息

在配置标记扩展时,上下文信息设置是单选按钮和复选框的组合。 每个复选框都映射到context关键字。

  1. 使用您的Adobe ID凭据登录experience.adobe.com。
  2. 导航到​ 数据收集 > 标记。
  3. 选择所需的标记属性。
  4. 导航到​ 扩展,然后单击Adobe Experience Platform Web SDK卡片上的​ 配置。
  5. 向下滚动到数据收集部分,然后选择​ 所有默认上下文信息 ​或​ 特定上下文信息。
  6. 如果选择​ 特定上下文信息,请启用每个所需上下文信息元素旁边的复选框。
  7. 单击​ 保存,然后发布更改。

使用Web SDK JavaScript库收集上下文信息

运行configure命令时设置context字符串数组。 如果在配置SDK时省略此属性,则默认情况下将收集除"highEntropyUserAgentHints"之外的所有上下文信息。 如果要收集高熵客户端提示,或者要从数据收集中忽略其他上下文信息,请设置此属性。 字符串可以按任意顺序包含。

NOTE
如果要收集所有上下文信息,包括高熵客户端提示,则必须在context数组字符串中包含每个值。 默认context值省略highEntropyUserAgentHints,如果您设置context属性,则任何省略的值都不会收集数据。
alloy("configure", {
  datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
  orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg",
  context: ["web", "device", "environment", "placeContext", "highEntropyUserAgentHints"]
});
recommendation-more-help
ad108910-6329-42f1-aa1d-5920a2b13636