API Javascript

20 novembre 2020 15:23

Obtenir une liste des fonctions de l'API du JS

Entrez dans la console sitegainer et appuyez sur Entrée pour obtenir une liste des fonctionnalités de l'API JS.

sitegainer // Retourne la liste des fonctions

debug()

Si vous activez le mode de débogage, Symplify produira des logs et des objets complets dans la console.

sitegainer.debug(1); // Active le mode débogage

sitegainer.debug(0); // Désactive le mode débogage

forceProject()

Si vous voulez faire rouler un projet indépendamment du fait que l'audience est vraie, utilisez cet extrait à l'intérieur du code de la variante Symplify ou dans votre propre environnement tant que le script Symplify est chargé.

sitegainer.forceProject([The project ID]); // Add your project ID here

getActiveProjects()

Retourne l'ensemble de projets actifs.

sitegainer.getActiveProjects();

getActiveVariation()

Retourne la variation active d'un projet. Utile pour récupérer la variation active après avoir utilisé sitegainer.runProject() ;.

sitegainer.getActiveVariation([id du projet]);

getCTMData()

Les données retournées seraient celles envoyées à "CallTrackingMetrics" si le projet était actif.

getGeo()

Pour récupérer l'adresse IP ou les géodonnées des visiteurs, il suffit d'utiliser ce simple extrait :

sitegainer.getGeo([clé]); // Entrer la clé pour obtenir la valeur

Exemples de clés et de valeurs (clés en gras) :

as:"AS2119 Telenor Norge AS"
city:"Stockholm"
country:"Sweden"
countryCode:"US"
isp:"Bredbandsbolaget AB"
lat:59.3333
lon:18.05
org:"Bredbandsbolaget AB"
query:"213.115.103.83"
region:"AB"
regionName:"Stockholm"
status:"success"
timezone:"Europe/Stockholm"
zip:"173 11"

getSupressedFields()

Retourne l'ensemble des éléments supprimés pour les projets de "Visitor Recording".

sitegainer.getSuppressedFields(); // Liste des éléments supprimés

newPage()

Si vous utilisez des applications monopages avec des bibliothèques comme react.js et node.js ou si, pour toute autre raison, vous souhaitez exécuter Symplify de manière dynamique, vous pouvez simplement exécuter sitegainer.newPage(); . Cela permet d'exécuter la même fonctionnalité que celle qui est exécutée sur les chargements de pages. Il nettoie également votre DOM de tout changement que Symplify a exécuté avant sitegainer.newPage(); est appelé.

sitegainer.newPage();

Ce qui se passe :

1. Rafraîchit dynamiquement le DOM à partir des modifications de Symplify ( pas de rechargement et aucun effet sur les liens javascript )
2. Met à jour des informations sur l'URL, de l'utilisateur et du DOM.
3. Contrôle de l'audience pour chaque projet actif sur la base d'informations actualisées
4. Dirige des projets où l'audience est réelle
5. Envoie la page et des événements à Symplify et des intégrations

optOut()

Si vous avez besoin d'empêcher temporairement Symplify d'exécuter des projets, vous pouvez utiliser notre fonction ci-dessous pour vous désengager. Vous pouvez également ajouter ?sg_optout ( ou #sg_optout / &sg_optout ) dans l'URL et appuyer sur Entrée. Ceci chargera la page sans Symplify.

Cela crée un cookie de session qui sera supprimé lorsque l'onglet et/ou le navigateur sera fermé. Vous pouvez également supprimer le cookie sg_optout pour quitter ce mode.

sitegainer.optout(1); // Active optout

previewProject()

Ouvre un aperçu d'un projet spécifique et d'une variation.

sitegainer.previewProject([project id], [variation id]]); // Entrez les id du projet et la variation

pushGoal()

Symplify propose des objectifs personnalisés standardisés pour des points de mesure généraux. Grâce à ces objectifs, vous n'avez pas besoin de créer d'objectifs dans votre projet. Ils seront créés automatiquement et apparaîtront dans les statistiques lors de l'enregistrement des données. Veuillez vous assurer que Symplify a bien chargé ces objectifs avant de les appeler afin d'éviter les erreurs :

if(sitegainer) {
	sitegainer.pushGoal("{id de l'objectif}");
} else {
  document.addEventListener("sitegainer-loaded", function(e) {
  	sitegainer.pushGoal("{id de l'objectif}");
  });
}

Exemples d'objectifs standard à utiliser ;

sitegainer.pushGoal("order"); // Enregistrer les visiteurs qui ont passé une commande
sitegainer.pushGoal("checkout"); // Enregistrer les visiteurs qui sont allés à la caisse de sortie
sitegainer.pushGoal("addtocart"); // Enregistrer les visiteurs qui ont ajouté un article au panier
sitegainer.pushGoal("cartpage"); // Enregistrer les visiteurs qui sont allés à la page du panier si elle est différente de la page de caisse (checkoutpage)
sitegainer.pushGoal("productpage"); // Enregistrer les visiteurs qui sont allés à la page du produit
sitegainer.pushGoal("product-listing"); // Enregistrer les visiteurs qui sont allés sur la liste des produits
sitegainer.pushGoal("homepage"); // Enregistrer les visiteurs qui sont allés sur la page d'accueil
sitegainer.pushGoal("searchpage"); // Enregistrer les visiteurs qui sont allés sur la page de recherche
sitegainer.pushGoal("searched"); // Enregistrer les visiteurs qui ont utilisé la recherche
sitegainer.pushGoal("loggedin"); // Enregistrer les visiteurs qui se sont connectés

runProject()

Fait rouler un projet spécifique, que l'audience soit vraie ou non.

sitegainer.runProject([The project ID]); // Fait rouler un projet spécifique

setGeo()

Définit l'IP ou les géodonnées pour l'utilisateur actuel.

sitegainer.setGeo([clé], [valeur]); // Entrez la clé et la valeur