Guide de programmation pour l'API Rich Media

Ajouter des valeurs ou des paramètres à une URL de sortie

Objectif

Vous souhaitez ajouter des valeurs à une URL correspondant à des valeurs dynamiques ou saisies par l'utilisateur à partir de votre création.

Cette solution permet d'ajouter des paramètres aux URL de sortie définies dans Studio ou Campaign Manager 360. Si vous souhaitez utiliser des URL de sortie dynamiques extraites d'une source de données externe (un flux XML ou une feuille de calcul Google Sheets, par exemple) consultez plutôt l'article Utiliser des URL de sortie dynamiques.

Solution

Utilisez une chaîne de requête de sortie en ajoutant la méthode Enabler.exitQueryString(). Pour en savoir plus, consultez le SDK HTML5 de Studio.

La chaîne de requête de sortie s'avère utile lorsque vous souhaitez envoyer des données vers une page de destination. Prenons l'exemple d'une création contenant un champ de texte qui invite l'internaute à saisir son code postal. Grâce à une chaîne de requête de sortie, vous pouvez transmettre ce code postal vers une page de destination à l'aide de l'URL de destination.

Studio vous permet seulement d'ajouter une chaîne de requête à une URL de sortie. Vous ne pouvez pas vous en servir pour contrôler l'utilisation de ces données sur la page de destination. Pour que les données de chaîne de requête fonctionnent sur le site Web, ce dernier doit être informé des paramètres de requête actuellement en cours de transmission.

Exemples

Cet article présente deux façons d'utiliser une chaîne de requête de sortie :

Vous pouvez ajouter des valeurs à l'URL de destination d'une sortie en tant que chaîne de requête standard. Pour ce faire, utilisez la méthode Enabler.exitQueryString(id, opt_queryString) et non Enabler.exit(). La procédure consiste à saisir l'URL de base dans l'interface utilisateur Web de Studio, comme pour un événement de sortie standard. Le paramètre queryString est ajouté à la fin de l'URL.

Avec cette méthode, Studio détecte automatiquement si l'URL indiquée comporte déjà une chaîne de requête. Le séparateur "?" ou "&" est alors choisi en conséquence, ce qui vous évite d'ajouter manuellement un séparateur à la valeur de la chaîne de requête dans votre création.

Découvrez comment Studio détermine le séparateur qui doit être utilisé dans une chaîne de requête de sortie ("?" ou "&").

L'exemple ci-dessous correspond à un appel standard permettant de renseigner la valeur d'une variable theaterVar dans votre URL. L'URL complète qui en résulte (une fois le signe de ponctuation ajouté par Studio) vous est également fournie.

Enabler.exitQueryString("Buy Tickets","venue="+theaterVar);
Si l'URL correspondant à "Buy Tickets" est https://www.yoursite.com/purchasetickets.html, vous obtenez le résultat suivant : https://www.yoursite.com/purchasetickets.html?venue=thecoliseum

L'URL saisie dans Studio ne contient pas encore de chaîne de requête. Par conséquent, le séparateur "?" est ajouté à la valeur. En revanche, si l'URL associée à "Buy Tickets" est https://www.yoursite.com/purchasetickets.html?showid=1234, vous obtenez le résultat suivant :

https://www.yoursite.com/purchasetickets.html?showid=1234&venue=thecoliseum

Dans la mesure où l'URL saisie dans Studio comporte déjà une chaîne de requête, le séparateur "&" est ajouté à la valeur.

En ajoutant une valeur saisie par l'internaute à une URL de sortie

Pour ajouter à une page de destination un code postal saisi par l'internaute dans un champ de texte de votre création, suivez l'exemple ci-dessous.

var zipCode = document.getElementById("zipcode").value;

function zipExitHandler() {

  // Imaginons par exemple que la valeur "10023" figure dans un champ de texte associé à l'ID "zipcode".
  Enabler.exitQueryString("my zip exit", "zip="+ zipCode);
}

exitBtn.addEventListener('click', zipExitHandler, false);

Dans Studio, si vous saisissez l'URL http://www.purchasetickets.com pour my zip exit, vous obtenez le résultat suivant :

http://www.purchasetickets.com?zip=10023
En ajoutant des paires clé/valeur à une URL de sortie

Suivez l'exemple ci-dessous pour ajouter à une page de destination les valeurs loc et name définies par un trafficker ou un site.

Vous devez vous servir de la méthode Studio Enabler.getParameter() pour accéder aux valeurs loc et name. Pour en savoir plus sur la méthode, consultez la documentation concernant le SDK HTML5 de Studio.


var locVar = Enabler.getParameter("loc");
var nameVar = Enabler.getParameter("name");

function onKeyValueExitHandler() {
  Enabler.exitQueryString(
      "my key value exit",
      "loc="+locVar+"&name="+nameVar);
}

exitBtn.addEventListener('click', onKeyValueExitHandler, false);

Dans Studio, si vous saisissez l'URL http://www.purchasetickets.com pour my key value exit, et si la paire clé/valeur est définie sur "madison" (pour loc) et "mraz" (pour name), vous obtenez le résultat suivant :

http://www.purchasetickets.com?loc=madison&name=mraz

Ces informations vous-ont elles été utiles ?

Comment pouvons-nous l'améliorer ?

Vous avez encore besoin d'aide ?

Essayez les solutions ci-dessous :

Recherche
Effacer la recherche
Fermer le champ de recherche
Menu principal
907606737289114784
true
Rechercher dans le centre d'aide
true
true
true
true
true
74220
false
false