配置平台Web SDK

SDK的配置已通过 configure 命令。

重要

configure is always 第一个命令名为。

alloy("configure", {
  "edgeConfigId": "ebebf826-a01f-4458-8cec-ef61de241c93",
  "orgId":"ADB3LETTERSANDNUMBERS@AdobeOrg"
});

在配置过程中可以设置许多选项。 所有选项都可在下面找到,并按类别分组。

常规选项

edgeConfigId

注意

边缘配置已重新命名为数据流。 数据流ID与配置ID相同。

类型 必需 默认值
字符串 None

您分配的配置ID,用于将SDK关联到相应的帐户和配置。 在单个页面中配置多个实例时,必须配置其他 edgeConfigId (对于每个实例)。

context

类型 必需 默认值
字符串数组 ["web", "device", "environment", "placeContext", "highEntropyUserAgentHints"]

指示要自动收集的上下文类别,如 自动信息. 如果未指定此配置,则默认使用所有类别。

重要

highEntropyUserAgentHints,则默认情况下处于启用状态。 如果您在Web SDK配置中手动指定上下文属性,则必须启用所有上下文属性才能继续收集所需的信息。

启用 高熵客户端提示 在Web SDK部署中,您必须包含 highEntropyUserAgentHints 上下文选项,以及现有配置。

例如,要从Web属性中检索高熵客户端提示,您的配置将如下所示:

context: ["highEntropyUserAgentHints", "web"]

debugEnabled

类型 必需 默认值
布尔型 false

指示是否启用调试。 将此配置设置为 true 启用以下功能:

功能 函数
控制台日志记录 允许在浏览器的JavaScript控制台中显示调试消息

edgeDomain

使用第一方域填充此字段。 有关更多详细信息,请参阅 文档.

域类似于 data.{customerdomain.com} 网站www.{customerdomain.com}。

edgeBasePath

用于与Adobe服务通信和交互的edgeDomain后面的路径。 通常,仅当不使用默认生产环境时,这种情况才会发生更改。

类型 必需 默认值
字符串 ee

orgId

类型 必需 默认值
字符串

您分配的 Experience Cloud 组织ID。 在一个页面中配置多个实例时,必须配置其他 orgId (对于每个实例)。

数据收集

clickCollectionEnabled

类型 必需 默认值
布尔型 true

指示是否自动收集与链接点击量关联的数据。 请参阅 自动链接跟踪 以了解更多信息。 如果链接包含下载属性或链接以文件扩展名结尾,则也会将其标记为下载链接。 下载链接限定符可以配置正则表达式。 默认值为 "\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$"

onBeforeEventSend

类型 必需 默认值
函数 ()=>未定义

在发送每个事件之前,配置为其调用的回调。 具有字段的对象 xdm 将发送到回调。 要更改发送的内容,请修改 xdm 对象。 在回调函数中, xdm 对象已在event命令中传递了数据,并且自动收集了信息。 有关此回调的时间和示例的更多信息,请参阅 全局修改事件.

隐私选项

类型 必需 默认值
对象 "in"

设置用户的默认同意。 如果尚未为用户保存同意首选项,则使用此设置。 其他有效值为 "pending""out". 此默认值不会持久保留在用户的配置文件中。 用户的配置文件仅在 setConsent 调用。

  • "in":如果设置此设置或未提供任何值,则在未使用用户同意首选项的情况下继续工作。
  • "pending":设置此设置后,工作将排入队列,直到用户提供同意首选项为止。
  • "out":设置此设置后,将丢弃工作,直到用户提供同意首选项为止。
    在提供用户的首选项后,根据用户的首选项继续或中止工作。 请参阅 支持同意 以了解更多信息。

个性化选项

prehidingStyle

类型 必需 默认值
字符串

用于创建CSS样式定义,当从服务器加载个性化内容时,该定义会隐藏网页的内容区域。 如果未提供此选项,则SDK在加载个性化内容时不会尝试隐藏任何内容区域,这可能会导致“闪烁”。

例如,如果网页上的某个元素的ID为 container,当您从服务器加载个性化内容时要隐藏的默认内容,请使用以下预隐藏样式:

  prehidingStyle: "#container { opacity: 0 !important }"

targetMigrationEnabled

从迁移单个页面时,应使用此选项 at.js 到Web SDK。

使用此选项可启用Web SDK以读取和写入旧版 mboxmboxEdgeCluster 由 at.js. 这有助于您在从使用Web SDK的页面移动到使用 at.js 图书馆,反之亦然。

类型 必需 默认值
布尔型 false

受众选项

cookieDestinationsEnabled

类型 必需 默认值
布尔型 true

启用 Audience Manager cookie目标,允许根据区段鉴别来设置cookie。

urlDestinationsEnabled

类型 必需 默认值
布尔型 true

启用 Audience Manager URL目标,允许根据区段鉴别触发URL。

身份选项

idMigrationEnabled

类型 必需 默认值
布尔型 true

如果为true,则SDK会读取并设置旧的AMCV Cookie。 此选项有助于过渡到使用Adobe Experience Platform Web SDK,而网站的某些部分可能仍使用Visitor.js。

如果页面上定义了访客API,SDK将查询访客API以获取ECID。 此选项允许您使用Adobe Experience Platform Web SDK创建双标记页面,但仍然具有相同的ECID。

thirdPartyCookiesEnabled

类型 必需 默认值
布尔型 true

启用Adobe第三方Cookie的设置。 SDK可以在第三方上下文中保留访客ID,以便允许在网站之间使用相同的访客ID。 如果您有多个网站,或者希望与合作伙伴共享数据,请使用此选项;但是,有时出于隐私原因不需要此选项。

在此页面上