Modules DIL dil-modules

WARNING
Depuis juillet 2023, Adobe a interrompu le développement du Data Integration Library (DIL) et de l’extension DIL.
Les clients existants peuvent continuer à utiliser leur implémentation DIL. Cependant, Adobe ne développera pas d’DIL au-delà de ce point. Nous recommandons aux clients d’évaluer Experience Platform Web SDK pour leur stratégie de collecte de données à long terme.
Les clients qui souhaitent implémenter de nouvelles intégrations de collecte de données après juillet 2023 doivent utiliser Experience Platform Web SDK à la place.

Décrit les méthodes de l’espace de noms DIL.modules. Ces modules vous permettent de collecter des données par programmation et d’utiliser des objets Audience Manager.

siteCatalyst.init sitecat-init

Fonctionne avec DIL pour envoyer des éléments de balise Analytics (variables, props, eVars, etc.) à Audience Manager. Renvoie les données dans une liste séparée par des virgules. Disponible dans la version 2.6.

Signature de fonction : DIL.modules.siteCatalyst.init(siteCatalystReportingSuite, dilInstance, trackVars, options)

NOTE
Vous devez placer ce code sur la page avant la fonction s.t();.

Paramètres

Noms
Type
Description
names
Chaîne
Tableau de chaînes contenant des variables Analytics non énumérées telles que pageName , channel , campaign , product , etc.
iteratedNames
Objet
Tableau d’objets contenant des variables énumérées Analytics telles que props et evars (par exemple prop1 , prop2 , evar3 , evar4 ).
maxIndex
Entier
Indique le nombre de noms itérés à renvoyer. Par exemple, pour renvoyer deux props ou evars, définissez maxIndex:2 .
siteCatalystReportingSuite
Objet
Objet représentant l’objet Analytics.
dilInstance
Objet
Un objet qui représente DIL.
options
Objet

Autres options :

  • replaceContextDataPeriodsWith

    Si vous ne spécifiez rien d’autre, les points sont remplacés par le trait de soulignement par défaut ( _ ).

    Par exemple, s.contextData = {abc.def = '123'} entraînerait une c_contextData_abc_def=123 dans la chaîne de requête d’appel d’événement.

    Cette option est disponible uniquement dans DIL version 5.0 ou ultérieure.

  • filterFromContextVariables

    Par exemple, la filterFromContextVariables: ['email', 'zip', 'accountNumber'] entraînerait le filtrage du tableau de chaînes de la collecte de données contextuelles. Cette option exclut les informations d’identification personnelle (PII).

Données capturées par siteCatalyst.init

Cette fonction renvoie des détails sur les propriétés de Analytics suivantes :

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

Exemple de code

Ce code crée une liste d’événements Analytics séparés par des virgules (props, eVars, etc.) si des valeurs existent pour eux.

// 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
        }]
});

Pour suivre tous les points de données Analytics surveillés sans la fonction supplémentaire affichée ci-dessus, appelez siteCatalyst.init seul comme suit :

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

GA.submitUniversalAnalytics ga-submit-universal-analytics

La fonction GA.submitUniversalAnalytics(); envoie des données du Universal Analytics Google vers Audience Manager. Cette fonction DIL est conçue pour fonctionner avec analytics.js, qui est la dernière bibliothèque de code pour Google Universal Analytics.

IMPORTANT
  • Audience Manager ne dispose d’aucun insight dans la bibliothèque de code Google analytics.js ni d’aucun contrôle sur celle-ci. Vous devez vérifier que DIL collecte de données fonctionne toujours si ou lorsque Google publie de nouvelles versions d’analytics.js.

  • Vous ne pouvez pas utiliser GA.submitUniversalAnalytics(); si vous utilisez toujours le code de suivi d’analyses hérité de Google (par exemple, ga.js ou dc.js). Voir GA.init à la place.

Signature de fonction : DIL.modules.GA.submitUniversalAnalytics(gaObject, dilInstance, internalPropertyName);

Propriétés

La fonction GA.submitUniversalAnalytics(); accepte les propriétés suivantes.

Propriété
Description
gaObject
Variable globale pour votre instance d’ Google Analytics . Cette opération est généralement ga par défaut, sauf si vous avez personnalisé votre code Google Analytics .
dilInstance
Variable qui représente votre instance DIL .
internalPropertyName

(Facultatif) Dans la bibliothèque analytics.js , la propriété interne est la 'b' de variable miniaturisée. Cette variable contient données de Google Analytics.

Cette propriété est facultative, car vous n’avez pas besoin de la définir, sauf si Google modifie le nom de sa variable interne. Par exemple, si cette variable miniaturisée est remplacée par 'a' , vous appelez GA.submitUniversalAnalytics(); comme suit :

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

Exemple

N’oubliez pas de définir d’abord l’objet Google Analytics ga avant d’appeler DIL et GA.submitUniversalAnalytics();. Votre code pourrait ressembler à ceci :

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

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

GA.init ga-init

La fonction GA.init() envoie les données de la version héritée/obsolète de Google Analytics vers Audience Manager.

IMPORTANT
GA.init() ne fonctionne qu’avec le code de suivi Analytics hérité de Google, ga.js ou dc.js. Vous ne pouvez pas appeler cette fonction DIL si vous utilisez analytics.js, qui est la dernière bibliothèque de code pour Google Universal Analytics. Audience Manager clients qui utilisent DIL et Universal Analytics doivent voir GA.submitUniversalAnalytics.

Signature de fonction : DIL.modules.GA.init(_gaq, dilInstance, trackVars);

Paramètres

Nom
Type
Description
_gaq
Tableau
Tableau contenant des commandes GA.
dilInstance
Objet
Objet contenant l’instance DIL.
trackVars
Objet
(Facultatif) Objet constitué de la propriété names. Cette propriété est un tableau de noms de commande GA dont vous souhaitez effectuer le suivi.

Appels de fonction GA pris en charge

Par défaut, GA.init capture les données des fonctions suivantes :

  • _setCustomVar
  • _addItem
  • _addTrans
  • _setAccount
  • _trackSocial

DIL crée des clés pour les données GA

Audience Manager accepte les données sous la forme de paires clé-valeur tandis que GA fonctionne avec des éléments d’un tableau . Pour utiliser les données GA, DIL crée automatiquement une paire clé-valeur et forme une clé comme celle-ci : c_ <key name>. En outre, les éléments des tableaux GA s’affichent dans un ordre spécifique. Par conséquent, vous devez fournir tous les paramètres dans cet ordre, même s’ils ne contiennent aucune donnée. DIL mappe les clés pour les méthodes GA suivantes :

// 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
]);

Exemple de code

// 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
]);

Pour suivre toutes les mesures GA surveillées sans la fonction supplémentaire affichée ci-dessus, appelez GA.init seul comme suit :

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

Exemple d’appel d’événement

L’appel d’événement d’URL à Audience Manager pourrait ressembler à ceci :

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