DIL建立方法 dil-create

WARNING
自2023年7月起,Adobe已停止開發Data Integration Library (DIL)和DIL擴充功能。
現有客戶可以繼續使用其DIL實作。 不過,Adobe不會在此時間點之後開發DIL。 建議客戶針對Experience Platform Web SDK的長期資料收集策略進行評估。
如果客戶希望在2023年7月之後實作新的資料收集整合,應改用Experience Platform Web 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 Service中,屬性 idSyncContainerID 對應至 containerNSID DIL 中的。 如果您在多個網站上使用 DIL ID服務,請注意下列事項:

  • 針對每個網站,在 containerNSID idSyncContainerID 上設定相同的容器ID。
  • DIL 和ID服務都會嘗試將ID同步傳送至我們的資料收集iFrame。 不過,iFrame會確保 DIL 不會引發ID同步處理。 如此可防止重複。
  • 只有 DIL 會將資料傳送至 URL目的地

另請參閱 idSyncContainerID

declaredId
物件

declaredId 是用來傳入:

  • dpid : Audience Manager 指派給您的資料合作夥伴識別碼。
  • dpuuid :您的使用者唯一ID。

重要:請僅將未編碼的值用於ID。 編碼將會建立雙重編碼的識別碼。

注意:如果您使用 Adobe Experience Platform Identity Service,請使用 setCustomerIDs 方法設定客戶ID,而非 DIL 。 檢視客戶ID與驗證狀態

delayAllUntilWindowLoad
布林值
若為true,則會延遲執行所有要求(IFRAME、事件呼叫、ID同步和目的地),直到 Page Load 事件引發為止。 預設值為 false
disableDeclaredUUIDCookie
布林值
預設為False,表示 Audience Manager 在合作夥伴的網域中設定Cookie (設定第一方Cookie)。
disableDestinationPublishingIframe
布林值

重要:此元素已在 DIL 8.0版(2018年8月發行)中棄用。 請改用Adobe Experience Platform Identity Service中的 visitor.disableIdSyncs 函式

如果 true ,將不會將目的地發佈IFRAME附加至DOM或引發目的地。 預設值為 false

disableIDSyncs
布林值

重要:此元素已在 DIL 8.0版(2018年8月發行)中棄用。 請改用Adobe Experience Platform Identity Service中的 visitor.disableIdSyncs 函式

停用ID同步。 使用DIL v6.2+和訪客ID服務時,您必須停用ID同步。 visitorService 函式(請參閱下列範常式式碼)負責此作業。

enableErrorReporting
布林值
設定為 true 以啟用頁面上所有個DIL 執行個體的錯誤報告。 僅適用於布林值 true
iframeAkamaiHTTPS
布林值

重要:此元素已在 DIL 8.0版(2018年8月發行)中棄用。 請改用Adobe Experience Platform Identity Service中的 visitor.idSyncSSLUseAkamai 函式

指定目的地發佈範本是否應該針對HTTPS連線使用Akamai。 每位合作夥伴皆啟用。

mappings
物件
將一個機碼值組的值與另一個機碼值組建立關聯。 請參閱將索引鍵值對應到其他索引鍵。 隨v2.4發行。
namespace
字串

必填。

namespace 機碼值組包含您的 Experience Cloud 組織識別碼。 如果您沒有此ID,可以在 Experience Cloud 儀表板的管理區段中找到。 您需要管理員許可權才能檢視此儀表板。 請參閱產品特色與功能常見問題集管理 — 使用者管理與常見問題集

partner
字串

必填。

由 Audience Manager 提供的合作夥伴名稱。

removeFinishedScriptsAndCallbacks
布林值
移除指令碼和回呼。 預設值為 False 。 僅套用至目前的 DIL 執行個體。 隨v3.3發行。
uuidCookie
物件
使用從 Audience Manager 傳回的不重複使用者識別碼設定Cookie。 請參閱 uuidCookie屬性
visitorService
物件

DIL 6.2或更新版本時需要。

DIL仰賴 setCustomerIDs Adobe Experience Platform Identity Service 中的函式將已宣告的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