Macros de sortie Studio

Objectif

Insérer des informations ou des macros Studio dans votre URL de sortie

Solution

Il existe deux moyens d'ajouter des informations Studio (telles qu'un identifiant d'annonce) dans une annonce :

• Insérer des macros Studio dans l'URL de destination à partir de l'interface utilisateur Web de Studio

• Obtenir les informations Studio à l'aide de l'API Studio en créant une chaîne de requête ou une URL complète dans le code de la création, puis utiliser Enabler.exitQueryString(id, queryString).

Avec des URL de sortie dynamiques, il est possible que la page de destination redirige l'internaute vers une autre URL. C'est le serveur de la page de destination, et non pas Studio, qui contrôle ce paramètre.

Configuration

Avant d'ajouter des macros Studio à des sorties, consultez le tableau ci-dessous pour en savoir plus sur les macros disponibles et sur les appels d'API Studio équivalents. Si vous souhaitez ajouter des paramètres Studio à une URL de sortie directement dans le code de la création, assurez-vous que l'API Studio propose une méthode correspondant à ces derniers. S'il n'existe aucune méthode, il vous sera impossible d'intégrer les informations Studio dans l'URL de sortie.

Macros acceptées dans Studio

Macro	Méthode de l'API Studio	Paramètre de l'ad server Studio
%eadv!	Enabler.getParameter("adv");	Référence annonceur
%eaid!	Enabler.getDartAdId();	Identifiant de l'annonce
%ebuy!	Enabler.getParameter(“buy”);	ID de la campagne
%ecid!	Enabler.getDartCreativeId();	ID de la création
%epid!	Enabler.getDartPageId();	ID de l'emplacement
%erid!	Enabler.getDartRenderingId();	ID du rendu
%esid!	Enabler.getDartSiteId();	ID du site
%n	Aucune API disponible	Nombre aléatoire
%p	Aucune API disponible	Correspondance de structure
%s	Enabler.getDartSiteName();	Nom du site

 

Les informations Studio ne sont disponibles qu'une fois la création diffusée via un tag actif. Lors de l'aperçu dans Studio, les macros renvoient 0 ou une valeur non résolue. Les méthodes d'API Studio équivalentes renvoient 0, la valeur null ou "" lors de l'aperçu dans Studio ou des tests en local.

Si la création génère des URL de sortie à partir d'une source externe (XML, JSON) et si ces URL contiennent des valeurs de macro Studio, vous devez remplacer les valeurs de macro de l'annonce par les méthodes correspondantes de l'API Studio en utilisant la logique de remplacement de chaîne dans le code de la création. Le tableau ci-dessus permet de déterminer la macro associée à chaque méthode de l'API Studio. Ne codez pas en dur les valeurs de macro Studio dans votre création.

Si les valeurs de macro Studio sont codées en dur dans la création, elles ne seront jamais remplacées par les paramètres de l'ad server Studio qui leur sont associés dans un tag actif. Il est possible par ailleurs que l'URL déclenche le blocage des fenêtres pop-up dans Internet Explorer lorsqu'un internaute accède à celle-ci en cliquant sur la création. Les URL de sortie codées en dur dans votre création ne peuvent pas être remplacées dans l'interface utilisateur Web de Studio ou dans DCM.

Exemples

Insérer des macros Studio dans l'URL de destination à partir de Studio

Collez l'URL de la page de destination qui contient les données de la macro Studio dans le champ URL de destination de l'onglet Événements > Sorties dans Studio.

Exemple d'URL de redirection tierce
Les macros sont mises en surbrillance en rouge dans l'exemple ci-dessous.

http://yourdomain.com/clk?aAgencyId=01&aSource=adsrv&aTrackDataExt=
123456;%epid!;%eaid!;%ecid!&migRandom=%n&aTrackFmtExt=client;io;ad;crtv&
aUnencodedDest=http://yourdomain.com

Utiliser les paramètres Studio dans le code de la création, puis saisir l'URL de base dans Studio

1. Au lieu d'utiliser la méthode Enabler.exit() dans votre code, remplacez la sortie à laquelle vous voulez ajouter des paramètres par Enabler.exitQueryString(). Cette méthode vous permet de définir une URL de base dans Studio, puis d'ajouter des paramètres à cette URL de base dans le code de la création.
2. Ajoutez les méthodes de l'API Studio qui correspondent à chaque paramètre Studio dans le deuxième paramètre de la méthode exitQueryString. Les méthodes disponibles sont répertoriées dans le SDK HTML5 de Studio. Recherchez la page relative à "getDart" pour accéder directement à la liste. Voici un exemple de code JavaScript utilisable pour les créations HTML5 :

   
   var adIdVar = Enabler.getDartAdId();
   var siteIdVar = Enabler.getDartSiteId();
   
   function exitHandler() {
     Enabler.exitQueryString("my exit", "adid=" + adIdVar + "&siteid=" + siteIdVar);
   }
   
   exitBtn.addEventListener('click', exitHandler, false);

3. Ajoutez l'URL de base dans le champ de l'URL de destination de l'onglet Événements > Sorties.

   Par exemple, si l'URL de base http://yourdomain.com/ est utilisée, l'URL obtenue suite à un clic de l'internaute sur l'annonce peut se présenter comme suit lorsque cette dernière se trouve sur un tag actif :
   
   http://yourdomain.com/?adid=123456789&siteid=12345