DIL创建方法 dil-create

WARNING
从2023年7月开始,Adobe已停止开发Data Integration Library (DIL)和DIL扩展。
现有客户可以继续使用其DIL实施。 但是,Adobe在此点之后不会开发DIL。 建议客户评估Experience PlatformWeb SDK的长期数据收集策略。
如果客户希望在2023年7月之后实施新的数据收集集成,则应改用Experience PlatformWeb SDK

DIL创建 dil-create-new

创建特定于合作伙伴的DIL实例。

函数签名: DIL.create: function (initConfig) {}

initConfig元素

IMPORTANT
visitorService属性是​ 始终 ​必需的。 此处列出的其他属性是可选的,除非另有说明。

initConfig接受以下元素:

名称
类型
描述
containerNSID
整数

此属性设置Audience Manager使用的容器ID以进行ID同步。 如果您在多个站点上部署了DIL,则将设置 containerNSID 。 每个网站都有自己的容器ID和ID同步。 当您只有1个网站时,容器ID在默认情况下为0,您无需正确进行设置。 请联系您的顾问,以获取您的网站及其容器ID的列表。

Adobe Experience Platform Identity服务中,属性 idSyncContainerID 对应于DIL中的 containerNSID 。 如果您在多个网站上使用DIL ID服务,请注意以下事项:

  • 对于每个网站,在 containerNSID idSyncContainerID 上设置相同的容器ID。
  • DIL和ID服务都将尝试将ID同步发送到我们的数据收集iFrame。 但是,iFrame会确保DIL不会触发ID同步。 这样可以防止重复。
  • 仅DIL将数据发送到 URL目标

另请参阅 idSyncContainerID

declaredId
对象

declaredId 用于传入:

  • dpid : Audience Manager分配给您的数据合作伙伴ID。
  • dpuuid :您的用户唯一ID。

重要信息:请仅将未编码的值用于您的ID。 编码将创建双重编码的标识符。

注意:如果您使用 Adobe Experience Platform Identity Service,请使用 setCustomerIDs 方法而不是DIL设置客户ID。 查看客户ID和身份验证状态

delayAllUntilWindowLoad
布尔值
如果为true,则延迟执行所有请求(IFRAME、事件调用、ID同步和目标),直到触发 Page Load 事件。 默认值为 false
disableDeclaredUUIDCookie
布尔值
默认为False,表示Audience Manager在合作伙伴的域中设置Cookie(设置第一方Cookie)。
disableDestinationPublishingIframe
布尔值

重要信息:此元素已在DIL版本8.0(2018年8月发布)中被弃用。 请改用Adobe Experience Platform Identity服务中的 visitor.disableIdSyncs 函数

如果 true ,则不会将目标发布IFRAME附加到DOM或触发目标。 默认值为 false

disableIDSyncs
布尔值

重要信息:此元素已在DIL版本8.0(2018年8月发布)中被弃用。 请改用Adobe Experience Platform Identity服务中的 visitor.disableIdSyncs 函数

禁用ID同步。 在使用DILv6.2及更高版本和访客ID服务时,必须禁用ID同步。 visitorService 函数(请参阅下面的示例代码)负责此操作。

enableErrorReporting
布尔值
设置为 true 可为页面上的所有DIL实例启用错误报告。 仅适用于布尔值 true
iframeAkamaiHTTPS
布尔值

重要信息:此元素已在DIL版本8.0(2018年8月发布)中被弃用。 请改用Adobe Experience Platform Identity服务中的 visitor.idSyncSSLUseAkamai 函数

指定目标发布模板是否应使用Akamai进行HTTPS连接。 针对每个合作伙伴启用。

mappings
对象
将值从一个键值对关联到另一个键值对。 查看将键值映射到其他键。 随v2.4发布。
namespace
字符串

必需。

namespace 键值对包含您的Experience Cloud组织ID。 如果您没有此ID,则可以在Experience Cloud仪表板的管理部分中找到它。 您需要管理员权限才能查看此仪表板。 查看产品特性和功能常见问题解答管理 — 用户管理和常见问题解答

partner
字符串

必需。

由Audience Manager提供的合作伙伴名称。

removeFinishedScriptsAndCallbacks
布尔值
删除脚本和回调。 默认值为 False 。 仅适用于当前DIL实例。 随v3.3发布。
uuidCookie
对象
使用从用户返回的唯一Audience ManagerID设置Cookie。 查看 uuidCookie属性
visitorService
对象

需要DIL 6.2或更高版本。

DIL依赖于 Adobe Experience Platform Identity Service 中的 setCustomerIDs 函数将声明的ID传递到Audience Manager。 有关详细信息,请参阅客户ID和身份验证状态

示例代码

示例DIL调用可能类似于以下内容:

var partnerObject1 = DIL.create({
  partner: "partner name",
  visitorService:{
    namespace: "INSERT-ORGANIZATION-ID-HERE"
  },
  containerNSID: 3,
  uuidCookie:{
    name:'ad_uuid',
    days:200,
    path:'/test',
    domain:'adobe.com',
    secure:true
  }
});

var partnerObject2 = DIL.create({
  partner: "partner name",
  visitorService:{
    namespace: "INSERT-MCORG-ID-HERE"
  },
  containerNSID: 3
});

成功的响应返回了DIL实例。 如果代码配置不正确或遇到错误,则失败的尝试会返回错误对象(未引发)。

uuidCookie属性 uuidcookie-props

定义uuidCookie变量使用的属性。 此变量是DIL.create方法的一部分。

uuidCookie具有以下属性:

名称
描述
name
Cookie名称(aam_did是默认名称)。
days
Cookie生命周期(默认为100天)。
path
Cookie路径,例如'/test'/是默认路径)。
domain
设置Cookie的域,如'adobe.com''.'+document.domain为默认设置)。
secure
设置仅通过HTTPS连接发送数据的标志。

visitorService属性 visitor-service-props

定义visitorService变量使用的属性。 此变量是DIL.create方法的一部分。

visitorService具有以下属性:

名称
类型
描述
namespace
字符串
必需。表示Experience Cloud的组织ID。 这是Experience Cloud核心服务功能所需的权限。 用于实例化访客ID功能的相同参数。

代码示例:

var vDil = DIL.create({
    partner: 'demofirst',
    visitorService: {
        namespace: "INSERT-EXPCLOUD-ORG-ID-HERE"
    }
});
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695