Show Menu
トピック×

DIL create メソッド。

DIL create

パートナー専用の DIL インスタンスを作成します。
関数シグネチャ: DIL.create: function (initConfig) {}
initConfig の要素
visitorService プロパティは​ 常に ​必須です。一覧にある他のプロパティは、別途指示がない限りオプションです。
initConfig では次の要素を使用できます。
名前 タイプ 説明
containerNSID
整数
このプロパティは、ID 同期用に Audience Manager で使用されるコンテナ ID を設定します。 DIL が複数のサイトにまたがってデプロイされている場合は、 containerNSID を設定します。このサイトのそれぞれに、個別のコンテナと ID 同期が設定されます。サイトが 1 つしかない場合は、コンテナ ID はデフォルトで 0 となり、このプロパティを設定する必要はありません。サイトと各サイトのコンテナ ID のリストについては、担当のコンサルタントにお問い合わせください。
Experience Cloud ID サービス では、 idSyncContainerID プロパティは DIL containerNSID に対応します。複数のサイトで DIL ID サービスの両方を使用している場合は、次の点に注意してください。
  • 各サイトで、 containerNSID idSyncContainerID に同じコンテナ ID を設定します。
  • DIL と ID サービスの両方が、ID 同期をデータ収集 iFrame に送信しようと試みます。しかし、iFrame は DIL による ID 同期の実行を停止します。これにより、重複が防止されます。
  • DIL のみが URL の宛先 にデータを送信します。
idSyncContainerID も参照してください。
declaredId
オブジェクト
delcaredId は次のいずれかを渡します。
  • dpid Audience Manager により割り当てられたデータパートナー ID。
  • dpuuid :ユーザーの一意の ID。
重要:エンコードされていない ID 値のみを使用してください。エンコードによって、識別子が二重にエンコードされます。
注意: Experience Cloud ID サービス を使用している場合、 DIL ではなく setCustomerIDs メソッドを使用して顧客 ID を設定します。詳しくは、 顧客 ID と認証状態 を参照してください。
delayAllUntilWindowLoad
ブール値
true の場合、 ページ読み込み イベントが実行されるまで、すべてのリクエスト(IFRAME、イベント呼び出し、ID 同期、宛先設定)が遅延されます。デフォルトは、 false です。
disableDeclaredUUIDCookie
ブール値
デフォルトは false です。この場合、 Audience Manager はパートナーのドメインに Cookie (ファーストパーティの Cookie を設定)を設定します。
disableDestinationPublishingIframe
ブール値
重要:この要素は、 DIL バージョン 8.0(2018 年 8 月にリリース)で廃止されました。Experience Cloud ID サービスでは、代わりに visitor.disableIdSyncs 関数 を使用します。
true の場合、宛先パブリッシング IFRAME が DOM に付加されたり、宛先が有効になることはありません。デフォルトは、 false です。
disableIDSyncs
ブール値
重要:この要素は、 DIL バージョン 8.0(2018 年 8 月にリリース)で廃止されました。Experience Cloud ID サービスでは、代わりに visitor.disableIdSyncs 関数 を使用します。
ID 同期を無効にします。DIL v6.2 以降と訪問者 ID サービスを使用する場合、ID 同期を無効にする必要があります。この操作は visitorService 関数でおこないます(以下のサンプルコードを参照)。
enableErrorReporting
ブール値
true に設定すると、ページ上のすべての DIL インスタンスのエラーレポートが有効になります。 ブール値 true のみ機能します。
iframeAkamaiHTTPS
ブール値
重要:この要素は、 DIL バージョン 8.0(2018 年 8 月にリリース)で廃止されました。Experience Cloud ID サービスでは、代わりに visitor.idSyncSSLUseAkamai 関数 を使用します。
宛先の公開テンプレートで HTTPS 接続に Akamai を使用するかを指定します。パートナーごとに有効化されます。
mappings
オブジェクト
キーと値のペアの値を、別のペアに関連付けます。詳しくは、 キーの値を他のキーにマッピング を参照してください。v2.4 でリリースされています。
namespace
文字列
必須。
キーと値ペア namespace には、 Experience Cloud の組織 ID が格納されます。この ID がわからない場合、 Experience Cloud ダッシュボードの「 Administration 」セクションで確認できます。このダッシュボードを表示するには、管理者権限が必要です。 製品の特長と機能の FAQ 管理 - ユーザー管理と FAQ を参照してください。
partner
文字列
必須。
Audience Manager で指定されたパートナー名。
removeFinishedScriptsAndCallbacks
ブール値
スクリプトとコールバックを削除します。デフォルトは、 False です。現在の DIL インスタンスにのみ適用されます。v3.3 でリリースされています。
uuidCookie
オブジェクト
Audience Manager により返された個別ユーザー ID を Cookie に設定します。 uuidCookie プロパティ を参照してください。
visitorService
オブジェクト
DIL 6.2 以降で必要です。
DIL では、 Experience Cloud 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 変数で使用するプロパティを定義します。この変数は DIL.create メソッドの一部です。
uuidCookie には次のプロパティがあります。
名前
説明
name
Cookie の名前(デフォルトは aam_did )。
days
Cookie の有効期間(デフォルトは 100 日)。
path
Cookie のパス( '/test' など。デフォルトは / )。
domain
Cookie が設定されているドメイン( 'adobe.com' など。デフォルトは '.'+document.domain )。
secure
データを HTTPS 接続経由でのみ送信するようフラグを設定します。

visitorService プロパティ

visitorService 変数で使用するプロパティを定義します。この変数は DIL.create メソッドの一部です。
visitorService には次のプロパティがあります。
名前
タイプ
説明
namespace
文字列
必須。Experience Cloud 組織 ID を表します。Experience Cloud コアサービス機能で必要となります。訪問者 ID 機能のインスタンス化に使用するパラメーターと同じです。
コードサンプル:
var vDil = DIL.create({ 
    partner: 'demofirst', 
    visitorService: { 
        namespace: "INSERT-EXPCLOUD-ORG-ID-HERE" 
    } 
});