A quoi sert la persistance dans le marquage des propriétés personnalisées ?

Avec le SDK Piano Analytics, vous pouvez tagger des propriétés personnalisées sans utiliser de méthode spécifique grâce à l'approche "tag first". Vous pouvez tagger vos propriétés personnalisées comme dans l'exemple ci-dessous :

pa.sendEvent('page.display', {
  'page':'pagename',
  'custom_prop':'value'
})

 Cependant, si vous devez envoyer cette propriété sur plusieurs événements pendant le même chargement de page, vous pouvez utiliser pa.setProperty() (cette méthode permet d'ajouter une notion de persistance à vos propriétés) : 

pa.setProperty('custom_prop', 'value', {
  'persistent':true
});

pa.sendEvent('page.display', {
  'page':'pagename'
})

Comment fonctionne la persistance

La persistance dans le SDK Piano Analytics signifie que la valeur de la propriété est stockée par le SDK et automatiquement ajoutée aux événements suivants jusqu'à ce que le SDK soit rechargé (par exemple, lors d'un rechargement complet de la page). En d'autres termes :

• La persistance est limitée à un seul chargement de page dans les implémentations web traditionnelles.

• Lorsque l'utilisateur navigue vers une nouvelle page, et que le SDK est réinitialisé, la persistance est perdue et doit être définie à nouveau si nécessaire.

• La persistance s'applique au sein de la même instance de tracker/SDK (si une nouvelle instance est créée sans la propriété, la propriété ne sera pas incluse).

Valeurs de l'option persistent

Le paramètre persistent peut prendre les valeurs suivantes :

• persistent: true ajoute cette propriété personnalisée à tous les événements suivants (pendant le même chargement de page, au sein de la même instance SDK).

• persistent: false applique la propriété uniquement au prochain événement envoyé après l'appel de cette méthode.

Limiter la persistance à des événements spécifiques

Vous pouvez définir quels événements vont être remplis avec la propriété personnalisée en utilisant le paramètre events.

Exemple :

pa.setProperty('custom_prop', 'value', {
  'persistent':true,
  'events': ['page.*', 'click.navigation']
});

 Dans l'exemple ci-dessus, seuls les événements commençant par page. et les événements click.navigation seront remplis avec la propriété custom_prop. Les autres événements (par exemple click.action, click.download, click.exit) ne la recevront pas.

Appliquer la persistance à tous les événements

Si vous voulez que la propriété soit appliquée à chaque type d'événement suivant, vous pouvez omettre le filtre ou passer un tableau events vide :

pa.setProperty('live_id', 'value', { persistent: true, events: [] })

Définir plusieurs propriétés persistantes en une fois

Si vous voulez envoyer une liste de propriétés, vous pouvez utiliser pa.setProperties().

Vous pouvez aussi mélanger les comportements persistants et non persistants en appelant pa.setProperties() plusieurs fois avec différentes options, selon les propriétés qui doivent être transmises aux événements suivants.

Exemple :

pa.setProperties(
  { custom_property: 'value' },
  { persistent: true, events: ['page.*', 'click.*'] }
)