DIL モジュール dil-modules

WARNING
2023 年 7 月以降、Adobeは Data Integration Library (DIL) と DIL の開発を廃止しました。
既存のお客様は、DIL 実装を引き続き使用できます。 ただし、Adobeはこの先 DIL は発展しません。 お客様は、長期的なデータ収集戦略について 🔗0}Experience Platform Web SDK} を評価することをお勧めします。
2023 年 7 月以降、新しいデータ収集統合機能の実装を検討しているお客様は、代わりに Experience Platform Web SDK を使用する必要があります。

DIL.modules 名前空間のメソッドについて説明します。これらのモジュールを使用すると、データの収集や Audience Manager オブジェクトの操作をプログラムでおこなうことができます。

siteCatalyst.init sitecat-init

DIL と連携して、Analytics のタグ要素(変数、prop、eVar など)をAudience Manager に送信します。データをコンマ区切りリストで返します。バージョン 2.6 で使用できます。

関数シグネチャ:DIL.modules.siteCatalyst.init(siteCatalystReportingSuite, dilInstance, trackVars, options)

NOTE
このコードは、ページ上で s.t(); 関数よりも​ ​に配置する必要があります。

パラメーター

名前
のタイプ
説明
names
文字列
非列挙型の Analytics 変数( pageName channel campaign product など)が格納されている、文字列の配列。
iteratedNames
オブジェクト
prop や eVar のような列挙型の Analytics 変数( prop1 prop2 evar3 evar4 など)が格納されている、オブジェクトの配列。
maxIndex
整数
繰り返されている名前を何個返すかを表します。例えば、2 つの prop または evar を返すには、 maxIndex:2 を設定します。
siteCatalystReportingSuite
オブジェクト
Analytics オブジェクトを表すオブジェクト。
dilInstance
オブジェクト
DIL を表すオブジェクト。
options
オブジェクト

追加のオプション。

  • replaceContextDataPeriodsWith

    他に何も指定しない場合、ピリオドはデフォルトのアンダースコア( _ )に置き換えられます。

    例えば、 s.contextData = {abc.def = '123'} は、イベント呼び出しクエリ文字列では c_contextData_abc_def=123 となります。

    このオプションは DIL バージョン 5.0 以降でのみ使用できます。

  • filterFromContextVariables

    例えば、 filterFromContextVariables: ['email', 'zip', 'accountNumber'] を実行すると、この文字列の配列がコンテキストデータのデータ収集から除外されます。このオプションでは、個人識別情報(PII)は対象外となります。

siteCatalyst.init によりキャプチャされるデータ

この関数は、次の Analytics プロパティの詳細を返します。

  • pageName
  • channel
  • campaign
  • products
  • events
  • eVar(1~250)
  • prop(1~75)
  • pe
  • pev1
  • pev2
  • pev3

サンプルコード

このコードにより、Analytics イベント(prop、eVar など)の値が存在する場合に、これらのイベントのコンマ区切りのリストが作成されます。

// Get the Site Catalyst object instance:
var s = s_gi(s_account);

// Instantiate DIL code:
var scDil = DIL.create({
        partner: 'adobe',
        containerNSID: 5
});

// Use the module:
DIL.modules.siteCatalyst.init(s, scDil, {
        //Specify the Site Catalyst variables you want to capture:
        names: ['pageName', 'channel', 'campaign'],
        //Use this to create iterated variable names:
        iteratedNames: [{
               name: 'eVar',
               maxIndex: 75
        }, {
               name: 'prop',
               maxIndex: 75
        }]
});

監視対象の Analytics データポイントを、前述の追加の関数を使用せずに追跡するには、次のように siteCatalyst.init を単独で呼び出します。

DIL.modules.siteCatalyst.init(s, scDil);

GA.submitUniversalAnalytics ga-submit-universal-analytics

GA.submitUniversalAnalytics(); 関数は、Google Universal Analyticsのデータを Audience Manager に送信します。 この DIL 関数は、analytics.js(Google Universal Analyticsの最新コードライブラリ)と連携するように設計されています。

IMPORTANT
  • Audience Manager では、Google の analytics.js コードライブラリの状況把握や管理をおこないません。 Google が DIL の新バージョンをリリースした場合は、analytics.js データ収集がまだ機能するかどうかを確認してください。

  • 従来の Google アナリティクストラッキングコード(ga.jsdc.js など)をまだ利用している場合は、GA.submitUniversalAnalytics(); を使用できません。 代わりに GA.init を参照してください。

関数シグネチャ:DIL.modules.GA.submitUniversalAnalytics(gaObject, dilInstance, internalPropertyName);

プロパティ

GA.submitUniversalAnalytics(); 関数は次のプロパティを受け取ります。

プロパティ
説明
gaObject
Google Analytics のインスタンスを表すグローバル変数。 Google Analytics コードをカスタマイズしている場合を除き、これは通常デフォルトで ga になっています。
dilInstance
DIL のインスタンスを表す変数。
internalPropertyName

(オプション) analytics.js ライブラリでは、内部プロパティは短縮された変数 'b' です。この変数には Google Analyticsデータが格納されます。

Google が内部変数の名前を変更しない限り、設定する必要がないので、このプロパティはオプションになっています。例えば、短縮されたこの変数が 'a' に変わった場合は、 GA.submitUniversalAnalytics(); を次のように呼び出します。

DIL.modules.GAsubmitUniversalAnalytics(ga, DilInstance, 'a');

Google Analytics および ga を呼び出す前に、まず DILの GA.submitUniversalAnalytics(); オブジェクトを必ず定義してください。次のようなコードになります。

//Instantiate DIL
var dilInstance = DIL.create({
     partner:"adobe"
});

//Call the DIL Universal Analytics function
DIL.modules.GA.submitUniversalAnalytics(ga, dilInstance);

GA.init ga-init

GA.init() 関数は、レガシー/廃止予定バージョンの Google Analyticsから Audience Manager にデータを送信します。

IMPORTANT
GA.init() は、従来の Google アナリティクストラッキングコードである ga.js または dc.js とのみ使用できます。Google DILの最新のコードライブラリである analytics.js を使用している場合、この Universal Analytics 関数は呼び出せません。Audience Manager を利用している場合に DIL および Universal Analytics を使用するには、GA.submitUniversalAnalytics を参照してください。

関数シグネチャ:DIL.modules.GA.init(_gaq, dilInstance, trackVars);

パラメーター

名前
のタイプ
説明
_gaq
配列
GA コマンドが格納されている配列。
dilInstance
オブジェクト
DIL インスタンスが格納されているオブジェクト。
trackVars
オブジェクト
(オプション)names プロパティで構成されるオブジェクト。このプロパティは、追跡する GA コマンド名の配列です。

サポートされている GA 関数呼び出し

デフォルトでは、GA.init は次の関数からのデータをキャプチャします。

  • _setCustomVar
  • _addItem
  • _addTrans
  • _setAccount
  • _trackSocial

DIL は GA データのキーを作成する

Audience Manager はデータをキーと値のペアで受け取りますが、GA は項目を配列で処理します。GA のデータを操作するために、DIL は自動的にキーと値のペアを作成し、c_ <key name> のようなキーを生成します。また、GA 配列の項目は所定の順序で配置されます。そのため、すべてのパラメーターをその順序で指定する必要があります。パラメーターにデータがない場合でも同様です。DIL は次の GA メソッドのキーをマッピングします。

// Tracking Social Interactions
_gaq.push(['_trackSocial',
    'facebook',                        // c_socialNetwork
    'like',                            // c_socialAction
    'https://www.adobe.com/cool.php',   // c_socialTarget
    '/cool.php'                        // c_socialPagePath
]);

// Tracking a Transaction
_gaq.push(['_addTrans',
   '1234',           // c_transOrderId
   'Womens Apparel', // c_transAfflication
   '28.28',          // c_transTotal
   '1.29',           // c_tranTax
   '15.00',          // c_transShipping
   'San Jose',       // c_transCity
   'California',     // c_transState
   'USA'             // c_transCountry
]);

// Tracking an item
_gaq.push(['_addItem',
   '1234',           // c_itemOrderId=1234
   'DD44',           // c_itemSku
   'T-Shirt',        // c_itemName
   'Olive Medium',   // c_itemCategory
   '11.99',          // c_itemPrice
   '1'               // c_itenQuantity
]);

サンプルコード

// DIL JavaScript library needs to be loaded and executed here
var dilInstance = DIL.create({
    partner : "adobe"
});

// Assume ga.js has not loaded
var _gaq = _gaq || [];
_gaq.push(
  ['_setAccount', 'UA-XXXXX-X'],
  ['_setDomainName', 'example.com'],
  ['_setCustomVar', 1, 'Section', 'Life & Style', 3],
  ['_trackPageview']
);
_gaq.push([
  '_addItem',
  '1234',         // order ID - necessary to associate item with transaction
  'DD44',         // SKU/code - required
  'T-Shirt',      // product name - necessary to associate revenue with product
  'Olive Medium', // category or variation
  '11.99',        // unit price - required
  '1'             // quantity - required
]);

監視対象のすべての GA 指標を、前述の追加の関数を使用せずに追跡するには、次のように GA.init を単独で呼び出します。

DIL.modules.GA.init(_gaq, dilInstance).submit();

サンプルのイベント呼び出し

Audience Manager の URL イベント呼び出しは次のようになります。

https://adobe.demdex.com/event?...c_accountId=UA-XXXXX-X&c_Section=Life%20%26%20Style &c_itemOrderId=1234&c_itemSku=DD44&c_itemName=T-Shirt&c_itemCategory=Olive%20Medium& c_itemPrice=11.99&c_itemQuantity=1

recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695