Présentation de l’extension de modules externes SDK Web courants

Ce document explique comment configurer l’extension de balise des modules externes du SDK Web et l’utiliser pour augmenter le Extension SDK Web Adobe Experience Platform.

Configuration de l’extension de modules externes SDK Web courants

Cette section fournit une référence pour les options disponibles lors de la configuration de l’extension des modules externes SDK Web.

Ajout de modules externes à l’extension SDK Web Adobe Experience Platform

Aucune configuration n’est nécessaire pour initialiser ou ajouter un module externe à votre bibliothèque en dehors de l’utilisation des éléments de données natifs suivants fournis par l’extension des modules externes du SDK Web courants :

• getAndPersistValue
• getGeoCoordinates
• getNewRepeat
• getPageName
• getPreviousValue
• getQueryParam
• getTimeParting
• getTimeSinceLastVisit
• getValOnce
• getVisitDuration
• getVisitNum
• pFo

getAndPersistValue

Permet de configurer et de configurer le getAndPersistValue Module externe Analytics. Le getAndPersistValue l’élément de données stocke une valeur dans un cookie qui peut être récupérée ultérieurement au cours d’une visite.

Le getAndPersistValue L’élément de données fournit les arguments suivants :

• vtp (obligatoire) : valeur à conserver d’une page à l’autre.
• cn (facultatif) : nom du cookie permettant de stocker la valeur. Si cet argument n’est pas défini, le cookie est nommé "s_gapv".
• ex (facultatif) : nombre de jours avant l’expiration du cookie. Si cet argument est défini sur 0 ou n’est pas défini, le cookie expire à la fin de la visite (30 minutes d’inactivité).

Si la variable dans la variable vtp est défini, puis l’élément de données définit le cookie, puis renvoie la valeur du cookie. Si la variable dans la variable vtp n’est pas défini, l’élément de données renvoie uniquement la valeur du cookie.

getGeoCoordinates

Permet de configurer et de configurer le getGeoCoordinates Module externe Analytics. Le getGeoCoordinates l’élément de données capture la latitude et la longitude des appareils des visiteurs.

Le getGeoCoordinates L’élément de données n’utilise aucun argument. Elle renvoie l’une des valeurs suivantes :

• "geo coordinates not available" : pour les appareils qui ne disposent pas de données de géolocalisation au moment de l’exécution du plug-in. Cette valeur est courante lors du premier accès de la visite, en particulier lorsque les visiteurs doivent d’abord donner leur consentement pour le suivi de leur emplacement.
• "error retrieving geo coordinates" : lorsque le plug-in rencontre des erreurs lors de la tentative de récupération de l’emplacement de l’appareil.
• "latitude=[LATITUDE] | longtitude=[LONGITUDE]" : où [LATITUDE]/[LONGITUDE] sont respectivement la latitude et la longitude.

getNewRepeat

Permet de configurer et de configurer le getNewRepeat Module externe Analytics. Le getNewRepeat l’élément de données détermine si un visiteur du site est un nouveau visiteur ou un visiteur régulier pendant un nombre de jours donné.

Le getNewRepeat L’élément de données utilise les arguments suivants :

• d (entier, facultatif) : nombre minimum de jours requis entre les visites qui réinitialise le statut des visiteurs à "New". Si cet argument n’est pas défini, la période par défaut est de 30 jours.

Cet élément de données renvoie la valeur de "New" si le cookie défini par l’élément de données n’existe pas ou a expiré. Elle renvoie la valeur de "Repeat" si le cookie défini par l’élément de données existe et que la durée écoulée depuis l’accès actif et celle définie dans le cookie sont supérieures à 30 minutes. Cette méthode renvoie la même valeur pour une visite complète.

getPageName

Permet de configurer et de configurer le getPageName Module externe Analytics. Le getPageName l’élément de données crée une version formatée facile à lire et conviviale de l’URL actuelle.

Le getPageName L’élément de données utilise les arguments suivants :

• si (facultatif, chaîne) : identifiant inséré au début de la chaîne représentant l’identifiant du site. Cette valeur peut être un identifiant numérique ou un nom convivial. Lorsqu’elle n’est pas définie, elle prend par défaut le domaine actuel.
• qv (facultatif, chaîne) : liste, délimitée par des virgules, de paramètres de chaîne de requête qui, s’ils figurent dans l’URL, sont ajoutés à la chaîne.
• hv (facultatif, chaîne) : liste, délimitée par des virgules, de paramètres trouvés dans le hachage de l’URL qui, s’ils figurent dans l’URL, sont ajoutés à la chaîne.
• de (facultatif, chaîne) : délimiteur permettant de séparer les différentes parties de la chaîne. Par défaut, il s’agit d’une barre verticale (|).

L’élément de données renvoie une chaîne contenant une version formatée de l’URL. Cette chaîne est généralement attribuée à la variable pageName, mais peut également être utilisée dans d’autres variables.

getPreviousValue

Permet de configurer et de configurer le getPreviousValue Module externe Analytics. Le getPreviousValue l’élément de données définit une variable sur une valeur définie pour un accès précédent.

Le getPreviousValue L’élément de données utilise les arguments suivants :

• v (chaîne, obligatoire) : variable dont la valeur doit être transmise à la demande d’image suivante. Une variable courante utilisée est s.pageName pour obtenir la valeur de la page précédente.
• c (chaîne, facultatif) : nom du cookie qui stocke la valeur. Si cet argument n’est pas défini, il prend par défaut la valeur "s_gpv".

Lorsque vous appelez cet élément de données, il renvoie la valeur de chaîne contenue dans le cookie. Le plug-in réinitialise ensuite l’expiration du cookie, et lui attribue la valeur de variable de l’argument v. Le cookie expire après 30 minutes d’inactivité.

getQueryParam

Permet de configurer et de configurer le getQueryParam Module externe Analytics. Le getQueryParam L’élément de données extrait la valeur de tout paramètre de chaîne de requête contenu dans une URL. Il est utile pour extraire des codes de campagne, internes et externes, provenant des URL de page de destination. Il convient également pour l’extraction de termes de recherche ou d’autres paramètres de chaîne de requête. Cet élément de données fournit des fonctionnalités puissantes pour l’analyse d’URL complexes, y compris les hachages et les URL contenant plusieurs paramètres de chaîne de requête.

Le getQueryParam L’élément de données utilise les arguments suivants :

• qsp (obligatoire) : liste, délimitée par des virgules, de paramètres de chaîne de requête à rechercher dans l’URL. Elle n’est pas sensible à la casse.
• de (facultatif) : délimiteur à utiliser si plusieurs paramètres de chaîne de requête correspondent. Valeur par défaut définie sur une chaîne vide.
• url (facultatif) : URL, chaîne ou variable personnalisée à partir de laquelle extraire les valeurs des paramètres de chaîne de requête. La valeur par défaut est window.location.

L’appel de cet élément de données renvoie une valeur en fonction des arguments ci-dessus et de l’URL :

• Si aucun paramètre de chaîne de requête correspondant n’est trouvé, la méthode renvoie une chaîne vide.
• Si un paramètre de chaîne de requête correspondant est trouvé, la méthode renvoie la valeur de ce paramètre.
• Si un paramètre de chaîne de requête correspondant est trouvé mais que la valeur est vide, la méthode renvoie true.
• Si plusieurs paramètres de chaîne de requête correspondants sont trouvés, la méthode renvoie une chaîne dont chaque valeur de paramètre est délimitée par la chaîne dans l’argument de.

getTimeParting

Permet de configurer et de configurer le getTimeParting Module externe Analytics. Le getTimeParting l’élément de données capture les détails du moment où une activité mesurable a lieu sur votre site. Cet élément de données est utile lorsque vous souhaitez ventiler les mesures selon une division répétable du temps sur une période donnée. Ainsi, vous pouvez comparer les taux de conversion entre deux jours différents de la semaine, par exemple tous les dimanches contre tous les jeudis. Vous pouvez également comparer les périodes de la journée, par exemple tous les matins contre tous les soirs.

Le getTimeParting L’élément de données utilise l’argument suivant :

t (facultatif mais recommandé, chaîne) : nom du fuseau horaire auquel convertir l’heure locale du visiteur. Par défaut, il s’agit de l’heure UTC/GMT. Reportez-vous à la section Liste des fuseaux horaires de la base TZ sur Wikipedia pour obtenir une liste complète des valeurs valides.

Les valeurs valides courantes sont les suivantes :

• "America/New_York" pour l’heure de l’Est
• "America/Chicago" pour l’heure normale du Centre
• "America/Denver" pour l’heure des Rocheuses
• "America/Los_Angeles" pour l’heure du Pacifique

L’appel de cet élément de données renvoie une chaîne contenant les éléments suivants délimités par une barre verticale (|) :

• L’année en cours
• Le mois en cours
• Le jour du mois
• Le jour de la semaine
• L’heure actuelle (matin/après-midi)

getTimeSinceLastVisit

Permet de configurer et de configurer le getTimeSinceLastVisit Module externe Analytics. Le getTimeSinceLastVisit l’élément de données effectue le suivi du temps nécessaire à un visiteur pour revenir sur votre site après sa dernière visite.

Le getTimeSinceLastVisit L’élément de données n’utilise aucun argument. Elle renvoie le temps écoulé depuis le dernier accès du visiteur au site, présenté sous le format suivant :

• Le temps compris entre 30 minutes et une heure depuis la dernière visite est défini selon la référence d’une demi-minute la plus proche. Par exemple, "30.5 minutes", "53 minutes"
• Le temps entre une heure et un jour est arrondi à la référence d’un quart d’heure la plus proche. Par exemple, "2.25 hours", "7.5 hours"
• Le temps écoulé depuis plus d’un jour est arrondi à la référence de jour la plus proche. Par exemple, "1 day", "3 days", "9 days", "372 days"
• Si un visiteur ne s’est pas rendu sur le site avant ou si le temps écoulé est supérieur à deux ans, alors la valeur est définie sur "New Visitor".

getValOnce

Permet de configurer et de configurer le getValOnce Module externe Analytics. Le getValOnce l’élément de données empêche qu’une variable soit définie plusieurs fois sur la même valeur.

Le getValOnce L’élément de données utilise les arguments suivants :

• vtc (obligatoire, chaîne) : variable à vérifier et à examiner pour savoir si elle vient d’être définie sur une valeur identique.
• cn (facultatif, chaîne) : nom du cookie qui contient la valeur à vérifier. La valeur par défaut est "s_gvo"
• et (facultatif, entier) : expiration du cookie en jours (ou en minutes, selon l’argument ep). La valeur par défaut est 0, qui expire à la fin de la session du navigateur.
• ep (facultatif, chaîne) : ne définissez cet argument que si et est également défini. Définissez cet argument sur "m" si vous souhaitez que le délai d’expiration de l’argument et soit exprimé en minutes plutôt qu’en jours. La valeur par défaut est "d", qui définit l’argument et en jours.

Si l’argument vtc et la valeur du cookie correspondent, cette méthode renvoie une chaîne vide. Si l’argument vtc et la valeur du cookie ne correspondent pas, la méthode renvoie l’argument vtc sous forme de chaîne.

getVisitDuration

Permet de configurer et de configurer le getVisitDuration Module externe Analytics. Le getVisitDuration l’élément de données effectue le suivi en minutes du temps passé par le visiteur sur le site jusqu’à ce moment-là.

Le getVisitDuration L’élément de données n’utilise aucun argument. Elle renvoie l’une des valeurs suivantes :

• "first hit of visit"
• "less than a minute"
• "1 minute"
• "[x] minutes" (où [x] est le nombre de minutes écoulées depuis que le visiteur a accédé au site)

getVisitNum

Permet de configurer et de configurer le getVisitNum Module externe Analytics. Le getVisitNum L’élément de données renvoie le nombre de visites pour tous les visiteurs qui se rendent sur le site au cours du nombre de jours souhaité.

Le getVisitNum L’élément de données utilise les arguments suivants :

• rp (facultatif, entier OU chaîne) : nombre de jours avant la réinitialisation du compteur de visites. La valeur par défaut est 365 lorsqu’elle n’est pas définie.
  • Lorsque cet argument est défini sur "w", le compteur se réinitialise à la fin de la semaine (ce samedi à 23 h 59).
  • Lorsque cet argument est défini sur "m", le compteur se réinitialise à la fin du mois (le dernier jour de ce mois).
  • Lorsque cet argument est défini sur "y", le compteur se réinitialise à la fin de l’année (le 31 décembre).
• erp (facultatif, booléen) : lorsque l’argument rp est un nombre, cet argument détermine si le délai d’expiration du nombre de visites doit être prolongé. S’il est défini sur true, les accès ultérieurs à votre site réinitialisent le compteur de visites. S’il est défini sur false, les accès ultérieurs à votre site ne se prolongent pas lorsque le compteur de visites est réinitialisé. La valeur par défaut est true. Cet argument n’est pas valide lorsque l’argument rp est une chaîne.

Le nombre de visites augmente chaque fois que le visiteur revient sur votre site après 30 minutes d’inactivité. L’appel de cette méthode renvoie un entier représentant le nombre de visites actuel du visiteur.

p_fo (Page First Only)

Permet de configurer et de configurer le p_fo Module externe Analytics. Le p_fo L’élément de données est un utilitaire qui vérifie l’existence d’un objet JavaScript spécifique. Si l’objet n’existe pas, alors le plug-in le crée et renvoie la valeur true. Si l’objet JavaScript existe déjà sur la page, alors il renvoie la valeur false. Cet élément de données est utile pour exécuter le code une seule fois sur une page.

Le p_fo L’élément de données utilise les arguments suivants :

• on (obligatoire, chaîne) : Nom de l’objet JavaScript créé par l’élément de données si l’objet n’existe pas encore sur la page.

Si l’objet n’existe pas encore, cette méthode renvoie la valeur true et crée l’objet. Si l’objet existe déjà, cette méthode renvoie la valeur false.