Moteur de recherche interne

 

Avant-propos

Avant de commencer l’implémentation du plugin Moteur de recherche interne, veuillez-vous assurer d’avoir initialisé le Tracker JavaScript AT Internet et sélectionné le plugin depuis l’interface Tag Composer.

 

Principe

L’objectif de ce plugin est de permettre la mesure des recherches internes à votre site.

 

Paramétrage du plugin

Le plugin Moteur de recherche interne peut être configuré depuis l’interface Tag Composer :

  • Variable de query string pour les mots clés saisis : récupère automatiquement les mots clés saisis lors de la recherche présent dans cette variable
  • Variable de query string pour le numéro de page : récupère automatiquement le numéro de page de résultat présent dans cette variable
  • Variable de query string pour la position du résultat cliqué : récupère automatiquement la position du résultat cliqué présent dans cette variable
  • Gestion automatique des clics : Lorsqu’un clic déclenche une navigation ou une redirection, les navigateurs empêchent la mesure de ces liens. Cette gestion permet de forcer la mesure.
  • Timeout de la gestion automatique de clic : Durée après laquelle la gestion automatique de clic forcera la navigation même si la mesure n’a pas pu se faire (en millisecondes).
 

Marquage

Pour marquer vos recherches, le tracker expose un objet internalSearch qui fournit à son tour 2 méthodes :

  • set : s’utilise avec la méthode dispatch du tracker. Permet de mesurer les informations de la page de résultats de recherche
  • send : mesure ponctuelle lors d’un événement. Permet de mesurer le clic sur un résultat de recherche

Ces méthodes sont décrites plus en détail dans les principes de fonctionnement du Tracker

Paramètres

PropriétéDescription
keywordMots clés saisis lors de la recherche
resultPageNumberNuméro de page de résultat (‘0’ si aucun résultat n’est disponible)
resultPositionPosition de l’élément sur lequel l’utilisateur a cliqué

Paramètres optionnels (uniquement pour la méthode send)

PropriétéDescription
elemElement du DOM marqué
eventEvénement JavaScript (bloque la propagation de l’événement passé en paramètre) – depuis v5.7.0
callbackFonction à exécuter – depuis v5.7.0
 

Exemples de marquage

 

Marquage d’une recherche (l’utilisateur est redirigé vers un écran contenant les résultats)

var tag = new ATInternet.Tracker.Tag();

tag.internalSearch.set({
    keyword:'mySearch',
    resultPageNumber:'2'
});
tag.page.set({name:'Search_result_page'});
tag.dispatch();
 

Exemples de marquage d’un lien de résultat

Si les informations de marquage sont disponibles lors du clic (mot clé / numéro de la page de résultat / position de l’élément cliqué dans les résultats).

<script type="text/javascript">
    var tag = new ATInternet.Tracker.Tag();
</script>
<a href="http://www.site.com" onclick="return tag.internalSearch.send({elem:this,keyword:'mySearch',resultPageNumber:'2',resultPosition:'11'});">
    Product
</a>

Si ces informations ne sont disponibles que sur la page de destination, il suffit d’ajouter le marquage suivant à la page en question :

var tag = new ATInternet.Tracker.Tag();

tag.internalSearch.send({
    keyword:'mySearch',
    resultPageNumber:'2',
    resultPosition:'11'
});
 

Marquage d’une recherche (utilisation de variables de query string)

  • Configurer les variables qui doivent être récupérées automatiquement dans l’URL (2 possibilités)
    • Via l’interface Tag Composer (préférable lorsque différentes pages de recherche sont possibles sur le site)
      • Variable de query string pour les mots clés saisis (exemple : renseigner « kw » pour keyword)
      • Variable de query string pour le numéro de page (exemple : renseigner « pagenum » pour page number)
    • Via l’initialisation du marqueur (préférable lorsqu’une seule page de recherche est mesurée)
var myConfig = {
    InternalSearch : {
        urlKeyword:'kw',
        urlResultPageNumber:'pagenum'
    }
}
var tag = new ATInternet.Tracker.Tag(myConfig);
  • Marquer la page avec les variables de query string

Exemple d’URL pour la configuration ci-dessus :

http://www.site.com/?kw=mySearch&pagenum=2

Les données de recherche sont automatiquement envoyées lors du hit de page :

tag.page.set({name:'Search Page'});
tag.page.dispatch();

Les données marquées via les méthode internalSearch.set/internalSearch.send sont prioritaires sur les données récupérées depuis l’URL

Il est possible de remplacer le « ? » par un « # » pour éviter de référencer les recherches

Dernière mise à jour : 09/10/2019