Developers » Généralités » Construire votre hit
Construire votre hit
Base
Tout hit doit être envoyé sur une adresse de collecte fixe, composée de plusieurs éléments
Information | Description | Règles | Exemple | Commentaire |
---|---|---|---|---|
Protocole | Type de protocole | Doit être égal à http ou https | https | |
Log de collecte | Serveur de collecte auquel le site est rattaché | logs | Un log est spécifique à un protocole | |
Domaine de collecte | Domaine de collecte des informations | Peut être égal à .xiti.com ou .ati-host.net | .xiti.com | Un log est rattaché à un domaine spécifique |
Ressource | Ressource à demander sur le serveur | Doit être égal à hit.xiti | hit.xiti |
Exemple:
L’ensemble des paramètres sera ensuite contenu dans la querystring de cette requête GET.
Global
Certains paramètres doivent être présents dans l’ensemble des hits afin d’assurer un suivi correct des informations.
Paramètre | Description | Règles | Exemple | Requis | Commentaire |
---|---|---|---|---|---|
col | Version du protocole | Doit être égal à 1 | col=1 | Oui | |
from | Méthode de génération du hit | Doit être égal à p | from=p | Oui | |
s | Numéro de site | Doit correspondre au site sur lequel les données doivent être comptabilisées | s=123456 | Oui | |
idclient | Identifiant de visiteur unique | Doit être unique par visiteur | idclient=e5c728db-b510-41a3-9de5-117f0321bae4 | Non | Empêche le dépôt du cookie tiers |
an | Identifiant numérique de visiteur identifié | Doit être un entier | an=1337 | Non | an et at sont exclusifs : il ne peut y en avoir qu’un dans le hit. an est prioritaire |
at | Identifiant textuel de visiteur identifié | at=p250 | Non | an et at sont exclusifs : il ne peut y en avoir qu’un dans le hit. an est prioritaire | |
ac | Identifiant de catégorie de visiteur identifié | Doit être un entier | ac=1 | Non | |
dg | Dimension du moniteur (pour apps) | Doit être un entier | dg=7 | Non | <2 : non défini <7 : smartphone >=7 : tablette >=19 : smartTV |
Exemple:
Page
Pour un hit de page on peut avoir trois renseignements : son libellé, son chapitrage (jusqu’à trois niveaux) et son niveau 2.
Le libellé et le chapitrage sont donnés dans un paramètre p de la manière suivante:
– si l’on veut renseigner de un à trois chapitres on les écrit en début de chaîne en les séparant par deux fois deux points (« :: ») et on ajoute le libellé de page à la fin après cette même séparation (On a donc le format <chapitre1>::<chapitre2>::<chapitre3>::<libellé>).
– sinon on ne met que le libellé
Si le paramètre p est vide, l’URL de la page remontera comme libellé de page
Le niveau 2 est un identifiant que l’on indique dans le paramètre s2. Le niveau 2 doit être configuré au préalable dans l’interface, afin de récupérer l’identifiant correspondant.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
p | <chap1::chap2::chap3::libellé> | 250 caractères max. Pas de caractères spéciaux | Oui |
s2 | <niveau 2> | Nombre entier | Non |
Exemple:
Hit de page vue de la page page_cuisson, appartenant à l’arborescence maison > electromenager > cuisine, et appartenant au niveau 2 45 :
Clic
Comme pour un hit de page le clic a trois renseignements possibles : son libellé, son chapitrage et son niveau 2 donnés dans les mêmes paramètres de hit p et s2.
En revanche il faut renseigner en plus le paramètre click qui a quatre valeurs possibles :
– « N » pour un clic de navigation
– « S » pour un clic de sortie
– « T » pour un téléchargement
– « A » pour une action
On peut aussi donner dans ce même hit des renseignements de la page sur laquelle l’action est réalisée, via les paramètres pclick et s2click.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
click | « N », « S », « T » ou « A » | Oui | |
p | <chap1::chap2::chap3::libellé> | 250 caractères max. Pas de caractères spéciaux | Oui |
s2 | <niveau 2> | Nombre entier | Non |
pclick | <libellé page> | 250 caractères max. Pas de caractères spéciaux | Non |
s2click | <niveau 2 page> | Nombre entier | Non |
Exemple:
Hit de téléchargement nommé notice2, avec l’arborescence maison > electromenager > cuisine, appartenant au niveau 2 45 et ayant été réalisé sur la page maison > electromenager > cuisine > page_cuisson appartenant également au niveau 2 45 :
Moteur Interne
Deux types de marquage sont à distinguer : le marquage de la page de résultats de recherche et celui d’un clic sur un résultat particulier.
Page de résultat
Dans le cas d’une du marquage de page de résultat, seuls le mot clé recherché et la pagination en supplément du marquage classique de la page (voir plus haut).
Le mot clé est indiqué dans la variable mc et la pagination dans np.
Dans le cas d’une recherche sans résultat, renseigner le paramètre np avec la valeur 0
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
mc | <mot clé> | Chaîne de caractères sans espaces | Oui |
np | <page de résultat> | Nombre entier. 0 si aucun résultat | Oui |
Exemple:
Résultats pour le mot « cuisine » et sur la troisième page de résultats :
Clic sur résultat
Dans le cas d’un clic réalisé sur une page de résultat, il faudra, en plus des deux paramètres précédents, la position du résultat dans la variable mcrg et le paramètre click qui sera valué obligatoirement à « IS ».
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
mc | <mot clé> | Chaîne de caractères sans espaces | Oui |
np | <page de résultat> | Nombre entier | Oui |
mcrg | <position> | Nombre entier | Oui |
click | IS | Valeur à IS | Oui |
Exemple:
Clic sur le résultat en 2ème position sur la page de résultats de l’exemple précédent :
Indicateurs personnalisés
Les indicateurs personnalisés sont liés à une page.
Un indicateur de pages est renseignée dans le paramètre f suivi de son numéro de rang. Un indicateur de site sera renseigné dans le paramètre x suivi de son numéro de rang.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
x<n> | <indicateur de site> | Non | |
f<n> | <indicateur de page> | Non |
Les indicateurs de type texte doivent être renseignés entre crochets
x1=[my_text]
Exemple:
Deux indicateurs de site : le numéro 1 avec la valeur dentist et le numéro 3 avec la valeur women.
Deux indicateurs de page : le numéro 5 avec la valeur chair et le numéro 2 avec la valeur 5.
Arborescence personnalisée
L’arborescence personnalisée permet de déclarer une arborescence de catégories jusqu’à trois niveaux. Ces trois niveaux sont dans un même paramètre « ptype » représentées par des identifiants séparés par des tirets. L’arborescence de ces catégories doit être configurée au préalable dans l’interface, afin de récupérer les identifiants correspondants.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
ptype | <id categorie 1>-<id categorie 2>-<id categorie 3> | Oui |
Exemple:
Rayons
On peut avoir jusqu’à six niveaux de rayons. Chaque niveau a un identifiant numérique et un libellé.
Le tout est renseigné dans le paramètre « aisl » de la forme suivante:
– pour un rayon, on renseigne son identifiant suivi de son libellé entre crochets (<id>[<libellé>])
– pour séparer les rayons, on utilise deux fois deux point (<rayon1>::<rayon2>::…::<rayon6>)
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
aisl | <id1>[<libellé1>]::<id2>[<libellé2>]::…<id6>[<libellé6>] | – l’identifiant est un nombre entier – le libellé est une chaîne de caractères | Oui |
Exemple:
Rich Media
La mesure Rich Media permet de comptabiliser les lectures, le temps passé ainsi que les actions réalisées sur des contenus vidéos ou audio.
La mesure passe par l’envoi d’actions différentes, permettant le calcul des différentes analyses.
Types de media
Il existe plusieurs types de media mesurables :
- « video » : mesure de vidéo
- « audio » : mesure d’une piste audio
- « vpre » : mesure d’une vidéo pre-roll
- « vmid » : mesure d’une vidéo mid-roll
- « vpost » : mesure d’une vidéo post-roll
Play
L’action play
est la plus importante, puisqu’elle est nécessaire pour toute mesure de lecture.
Elle doit être la première action de mesure.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
action | Action | « play » | Oui |
type | Type de media | « video », « audio », « vpre », « vmid » ou « vpost » | Oui |
m6 | Type de broadcast | « clip » pour un contenu à durée définie ou « live » pour un contenu en diffusion continue | Oui |
m1 | Durée du contenu | En secondes | Oui si m6=clip. Non si m6=live |
p | Libellé du contenu | Peut contenir 3 niveaux d’arborescence (thèmes), séparés par :: | Oui |
s2 | Niveau 2 du contenu | Non | |
m5 | Lieu de diffusion | « int » si le contenu est diffusé sur un site interne, « ext » si le contenu est diffusé sur un site externe | Oui |
buf | Le contenu est-il en chargement (buffering) | « 1 » pour indiquer le buffering, « 0 » en fin de buffering | Non |
prich | Libellé de la page sur laquelle le contenu est diffusé (avec arborescence) | Non | |
s2rich | Niveau 2 de la page sur laquelle le contenu est diffusé | Non | |
plyr | Identifiant de player. Permet de distinguer plusieurs lecteurs présents dans la page | Non | |
clnk | Libellé de la vidéo liée (avec arborescence) dans le cas d’un contenu pre/mid/post-roll | Oui si type=vpre/vmid/vpost | |
m9 | Domaine de lecture du contenu, dans le cas d’une lecture externe | Oui si m5=ext |
Refresh
L’action refresh
permet d’indiquer qu’une lecture est en toujours en cours.
Cette action est nécessaire à la mesure du temps de lecture juste.
Le rythme maximum d’envoi des refresh est de 1 hit toutes les 5 secondes
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
action | Action | « refresh » | Oui |
type | Type de media | « video », « audio », « vpre », « vmid » ou « vpost » | Oui |
m6 | Type de broadcast | « clip » pour un contenu à durée définie ou « live » pour un contenu en diffusion continue | Oui |
m1 | Durée du contenu | En secondes | Oui si m6=clip. Non si m6=live |
p | Libellé du contenu | Peut contenir 3 niveaux d’arborescence (thèmes), séparés par :: | Oui |
s2 | Niveau 2 du contenu | Non | |
plyr | Identifiant de player. Permet de distinguer plusieurs lecteurs présents dans la page | Non |
Pause
L’action pause
permet d’indiquer une pause dans la lecture d’un contenu.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
action | Action | « pause » | Oui |
type | Type de media | « video », « audio », « vpre », « vmid » ou « vpost » | Oui |
m6 | Type de broadcast | « clip » pour un contenu à durée définie ou « live » pour un contenu en diffusion continue | Oui |
m1 | Durée du contenu | En secondes | Oui si m6=clip. Non si m6=live |
p | Libellé du contenu | Peut contenir 3 niveaux d’arborescence (thèmes), séparés par :: | Oui |
s2 | Niveau 2 du contenu | Non | |
plyr | Identifiant de player. Permet de distinguer plusieurs lecteurs présents dans la page | Non |
Stop
L’action stop
permet d’indiquer une fin de lecture de contenu.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
action | Action | « stop » | Oui |
type | Type de media | « video », « audio », « vpre », « vmid » ou « vpost » | Oui |
m6 | Type de broadcast | « clip » pour un contenu à durée définie ou « live » pour un contenu en diffusion continue | Oui |
m1 | Durée du contenu | En secondes | Oui si m6=clip. Non si m6=live |
p | Libellé du contenu | Peut contenir 3 niveaux d’arborescence (thèmes), séparés par :: | Oui |
s2 | Niveau 2 du contenu | Non | |
plyr | Identifiant de player. Permet de distinguer plusieurs lecteurs présents dans la page | Non |
Move
L’action move
permet d’indiquer un déplacement dans la lecture d’un contenu.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
action | Action | « move » | Oui |
type | Type de media | « video », « audio », « vpre », « vmid » ou « vpost » | Oui |
m6 | Type de broadcast | « clip » pour un contenu à durée définie ou « live » pour un contenu en diffusion continue | Oui |
m1 | Durée du contenu | En secondes | Oui si m6=clip. Non si m6=live |
p | Libellé du contenu | Peut contenir 3 niveaux d’arborescence (thèmes), séparés par :: | Oui |
s2 | Niveau 2 du contenu | Non | |
plyr | Identifiant de player. Permet de distinguer plusieurs lecteurs présents dans la page | Non |
Objet personnalisé
Vous avez la possibilité de renseigner un objet personnalisé, au format JSON et correctement encodé, afin de traiter ces informations dans Data Manager.
Paramètres | Description | Restrictions | Requis |
---|---|---|---|
stc | Objet JSON, correctement encodé | Oui |
Exemple:
Dernière mise à jour : 09/10/2019