DIL create メソッド dil-create
DIL create dil-create-new
パートナー専用の DIL インスタンスを作成します。
関数シグネチャ:DIL.create: function (initConfig) {}
initConfig の要素
visitorService
プロパティは 常に 必須です。一覧にある他のプロパティは、別途指示がない限りオプションです。initConfig
では次の要素を使用できます。
containerNSID
このプロパティは、ID 同期用に Audience Manager で使用されるコンテナ ID を設定します。DIL が複数のサイトにまたがってデプロイされている場合は、 containerNSID
を設定します。このサイトのそれぞれに、個別のコンテナと ID 同期が設定されます。サイトが 1 つしかない場合は、コンテナ ID はデフォルトで 0 となり、このプロパティを設定する必要はありません。サイトと各サイトのコンテナ ID のリストについては、担当のコンサルタントにお問い合わせください。
Adobe Experience Platform ID サービスでは、プロパティ 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 ID サービスを使用している場合、DIL ではなく setCustomerIDs
メソッドを使用して顧客 ID を設定します。詳しくは、顧客 ID と認証状態を参照してください。
delayAllUntilWindowLoad
Page Load
イベントが実行されるまで、すべてのリクエスト(IFRAME、イベント呼び出し、ID 同期、宛先設定)が遅延されます。初期設定は false
です。disableDeclaredUUIDCookie
disableDestinationPublishingIframe
重要:この要素は、DIL バージョン 8.0(2018 年 8 月にリリース)で非推奨(廃止予定)となりました。代わりに、Adobe Experience Platform ID サービスの visitor.disableIdSyncs
関数を使用してください。
true
の場合、宛先パブリッシング IFRAME が DOM に付加されたり、宛先が有効になることはありません。初期設定は false
です。
disableIDSyncs
重要:この要素は、DIL バージョン 8.0(2018 年 8 月にリリース)で非推奨(廃止予定)となりました。代わりに、Adobe Experience Platform ID サービスの visitor.disableIdSyncs
関数を使用してください。
ID 同期を無効にします。DIL v6.2 以降と訪問者 ID サービスを使用する場合、ID 同期を無効にする必要があります。この操作は visitorService
関数でおこないます(以下のサンプルコードを参照)。
enableErrorReporting
true
に設定すると、ページ上のすべての DIL インスタンスのエラーレポートが有効になります。ブール値 true
のみ機能します。iframeAkamaiHTTPS
重要:この要素は、DIL バージョン 8.0(2018 年 8 月にリリース)で非推奨(廃止予定)となりました。代わりに、Adobe Experience Platform ID サービスの visitor.idSyncSSLUseAkamai
関数を使用してください。
宛先の公開テンプレートで HTTPS 接続に Akamai を使用するかを指定します。パートナーごとに有効化されます。
namespace
必須。
namespace
キー値ペアには、Experience Cloud の組織 ID が格納されます。この ID がわからない場合、Experience Cloud ダッシュボードの「Administration」セクションで確認できます。このダッシュボードを表示するには、管理者権限が必要です。製品の特長と機能の FAQ と管理 - ユーザー管理と FAQ を参照してください。
partner
必須。
Audience Manager で指定されたパートナー名。
removeFinishedScriptsAndCallbacks
False
です。現在の DIL インスタンスにのみ適用されます。v3.3 でリリースされています。visitorService
DIL 6.2 以降で必要です。
DIL では、Adobe Experience Platform ID サービスで 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
aam_did
)。days
path
'/test'
など。デフォルトは /
)。domain
'adobe.com'
など。デフォルトは '.'+document.domain
)。secure
visitorService プロパティ visitor-service-props
visitorService
変数で使用するプロパティを定義します。この変数は DIL.create
メソッドの一部です。
visitorService
には次のプロパティがあります。
namespace
コードサンプル:
var vDil = DIL.create({
partner: 'demofirst',
visitorService: {
namespace: "INSERT-EXPCLOUD-ORG-ID-HERE"
}
});