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。您可以设置 containerNSID 如果您拥有 DIL 跨多个站点部署。 每个网站都有自己的容器ID和ID同步。 当您只有1个网站时,容器ID在默认情况下为0,您无需正确进行设置。 请联系您的顾问,以获取您的网站及其容器ID的列表。

Adobe Experience Platform Identity服务,属性 idSyncContainerID 对应于 containerNSID 在 DIL . 如果您使用的是 DIL 跨多个网站的ID服务:

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

另请参阅, idSyncContainerID.

declaredId
对象

declaredId 用于传入:

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

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

注意:如果您使用 Adobe Experience Platform Identity服务,使用设置客户ID setCustomerIDs 方法,而不是 DIL . 请参阅 客户ID和身份验证状态.

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

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

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

disableIDSyncs
布尔值

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

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

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

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

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

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

必需.

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

partner
字符串

必需.

合作伙伴名称由提供 Audience Manager .

removeFinishedScriptsAndCallbacks
布尔值
删除脚本和回调。 默认值为 False . 应用于当前 DIL 仅实例。 随v3.3发布。
uuidCookie
对象
使用从返回的独特用户ID设置Cookie Audience Manager . 请参阅 uuidCookie属性.
visitorService
对象

必需,与 DIL 6.2或更高版本。

DIL依赖于 setCustomerIDs 中的函数 Adobe Experience Platform Identity服务 将声明的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