Transmission de données supplémentaires à IBM Digital Analytics avec le paramètre extraparms

Vous pouvez transmettre plus de données à IBM Digital Analytics qui ne sont pas collectées automatiquement par les balises d'analyse HCL Commerce. Par exemple, vous pouvez transmettre des informations sur la marque des produits que les clients affichent pour un rapport d'exploration IBM Digital Analytics, ou transmettre des données d'enregistrement spécifiques pour un rapport personnalisé dans IBM Digital Analytics. Si c'est le cas, utilisez le paramètre extraparms de la balise d'analyse HCL Commerce lorsque vous placez la balise dans votre page de magasin. Vous pouvez également utiliser le paramètre extraparms pour remplacer l'ID de catégorie généré par la balise d'analyse HCL Commerce. De nombreuses balises d'analyse HCL Commerce prennent en charge le paramètre extraparms.
Remarque : Ces informations s'appliquent également aux paramètres orderExtraparms et extraparmsMap pris en charge par certaines balises d'analyse HCL Commerce. Pour plus d'informations sur la transmission des valeurs avec le paramètre orderExtraparms, voir la section 3. Format pour définir des valeurs extraparms pour d'autres balises d'analyse HCL Commerce.

Comment le paramètre extraparms transmet les données à IBM Digital Analytics

Au moment de l'exécution, les balises d'analyse HCL Commerce génèrent des balises de données IBM Digital Analytics. Si vous incluez le paramètre extraparms dans la balise d'analyse HCL Commerce, ses valeurs sont transmises sous forme de chaîne à un ou plusieurs des paramètres de balise de données IBM Digital Analytics suivants, selon la façon dont vous spécifiez les valeurs :

Paramètre dans la balise de données IBM Digital Analytics générée Description
catIDoverride Utilisez ce paramètre pour remplacer explicitement l'ID de catégorie généré par les balises d'analyse HCL Commerce suivantes : <cm:cart />, <cm:order /> et balise <cm:product />.
attributes Ce paramètre fournit des attributs Explore à IBM Digital Analytics Explore, une solution de reporting ad hoc que vous pouvez utiliser pour créer des rapports personnalisés.
extraFields Ce paramètre fournit plus de données pour les rapports personnalisés dans IBM Digital Analytics.
cm_vc Ce paramètre est le paramètre "catégorie virtuelle", utilisé uniquement pour la balise <cm:product />. Utilisez ce paramètre pour catégoriser les vues de produit provenant de liens spéciaux, tels que les recommandations de vente croisée, plutôt que de la navigation de catégorie normale.
Le format que vous utilisez pour transmettre des valeurs extraparms diffère selon la balise d'analyse HCL Commerce. Les règles de format sont fournies dans les trois sections suivantes :
Remarque : Les exemples de cette rubrique utilisent la syntaxe simplifiée pour spécifier des valeurs extraparms. Vous devez spécifier les valeurs à l'aide de JavaScript correctement échappé :
Exemple de syntaxe simplifiée
extraparms="value1-_-value2,value3-_-value4"
Exemple de JavaScript correctement échappé
extraparms="\"value1-_-value2\",\"value3-_-value4\""

Si l'une de vos valeurs extraparms est une variable JavaScript, consultez les règles de syntaxe expliquées dans Syntaxe pour la transmission de variables JavaScript en tant que paramètres supplémentaires.

1. Format pour définir les valeurs extraparms pour les balises <cm:cart /> et <cm:order />

Lorsque vous définissez les valeurs extraparms de l'une ou l'autre de ces balises, vous devez suivre un format spécifique pour contrôler les valeurs transmises au paramètre catIDoverride, au paramètre attributes et au paramètre extraFields. L'exemple suivant illustre le format correct :


extraparms format de paramètre 1
Les règles de format sont les suivantes :
  • Spécifiez des valeurs pour les trois paramètres IBM Digital Analytics dans l'ordre affiché dans l'exemple précédent. Spécifiez la valeur catIDoverride en première position, suivie d'une virgule, puis d'une ou de plusieurs valeurs attributes en deuxième position, suivie d'une virgule, puis d'une ou plusieurs valeurs extraFields en troisième position.
  • Utilisez la valeur null pour indiquer quand aucune valeur n'est transmise pour catIDoverride ou attributes.
  • Pour transmettre plusieurs valeurs pour un paramètre, séparez chaque valeur avec le délimiteur suivant : -_-

Les exemples suivants montrent comment appliquer ces règles de format lorsque vous utilisez le paramètre extraparms. Les exemples utilisent le <cm:cart tag />, mais ils s'appliquent également à la balise <cm:order />.

  • Exemple 1 :

    Pour transmettre une valeur au paramètre catIDoverride :

    <cm:cart orderId="${order_OrderId}" extraparms="categoryID" />

    Étant donné qu'aucune valeur n'est transmise au paramètre attributes ou extraFields, aucune virgule ni valeur null n'est requise.

  • Exemple 2 :

    Pour transmettre une seule valeur au paramètre attributes :

    <cm:cart orderId="${order_OrderId}" extraparms="null,attr1"/>

    La valeur null à gauche de la virgule est nécessaire pour indiquer qu'aucune valeur n'est transmise au paramètre catIDoverride.

  • Exemple 3 :

    Pour transmettre deux valeurs au paramètre attributes :

    <cm:cart orderId="${order_OrderId}" extraparms="null,attr1-_-attr2"/>
  • Exemple 4 :

    Pour transmettre une seule valeur au paramètre extraFields :

    <cm:cart OrderId="${order_OrderId}" extraparms="null,null,exField1"/>

2. Format pour définir des valeurs extraparms pour la balise <cm:product />

Lorsque vous définissez les valeurs extraparms de la balise <cm:product />, vous devez suivre un format spécifique pour contrôler les valeurs transmises au paramètre catIDoverride, au paramètre attributes et au paramètre cm_vc. L'exemple suivant illustre le format correct :


extraparms format de paramètre II
Les règles de format sont les suivantes :
  • Spécifiez des valeurs pour les trois paramètres IBM Digital Analytics de l'ordre affiché dans l'exemple précédent. Spécifiez la valeur catIDoverride en première position, suivie d'une virgule, puis d'une ou de plusieurs valeurs attributes en deuxième position, suivie d'une virgule, puis d'un nom de catégorie virtuelle en tant que valeur cm_vc en troisième position.
  • Utilisez la valeur null pour indiquer quand aucune valeur n'est transmise pour catIDoverride ou attributes.
  • Pour transmettre plusieurs valeurs pour un paramètre, séparez chaque valeur avec le délimiteur suivant : -_-

Les exemples suivants montrent comment appliquer ces règles de format lorsque vous utilisez le paramètre extraparms avec la balise <cm:product /> :

  • Exemple 1 :

    Pour transmettre une valeur au paramètre catIDoverride :

    <cm:product catentryId="${product_catentryId}" extraparms="categoryID"/>

    Étant donné qu'aucune valeur n'est transmise au paramètre attributes ou cm_vc, aucune virgule ni valeur null n'est requise.

  • Exemple 2 :

    Pour transmettre une seule valeur au paramètre attributes :

    <cm:product catentryId="${product_catentryId}" extraparms="null,attr1"/>

    La valeur null à gauche de la virgule est nécessaire pour indiquer qu'aucune valeur n'est transmise au paramètre catIDoverride.

  • Exemple 3 :

    Pour transmettre deux valeurs au paramètre attributes :

    <cm:product catentryId="${product_catentryId}" extraparms="null,attr1-_-attr2"/>
  • Exemple 4 :

    Pour transmettre une seule valeur au paramètre cm_vc :

    <cm:product catentryId="${product_catentryId}" extraparms="null, null, virtualCategory"/>

3. Format pour définir des valeurs extraparms pour d'autres balises d'analyse HCL Commerce

Les règles et exemples de format suivants s'appliquent à la balise <pageview /> et à toutes les autres balises d'analyse HCL Commerce qui transmettent des valeurs aux paramètres IBM Digital Analytics attributes et extraFields. Lorsque vous définissez les valeurs extraparms de ces balises, vous devez suivre un format spécifique pour contrôler les valeurs transmises au paramètre attributes et/ou au paramètre extraFields. L'exemple suivant illustre le format correct :


extraparms format de paramètre III
Les règles de format sont les suivantes :
  • Spécifiez des valeurs pour les deux paramètres dans la commandée affichée dans l'exemple précédent. Spécifiez une ou plusieurs valeurs attributes en première position, suivies d'une virgule, puis une ou plusieurs valeurs extraFields en deuxième position.
  • Utilisez la valeur null pour indiquer quand aucune valeur n'est transmise pour le paramètre attributes.
  • Pour transmettre plusieurs valeurs pour un paramètre, séparez chaque valeur avec le délimiteur suivant : -_-

Les exemples suivants montrent comment appliquer ces règles de format. Les exemples utilisent la balise <cm:pageview />, mais ils s'appliquent également à d'autres balises qui transmettent des valeurs à attributes et extraFields.

  • Exemple 1 :

    Pour transmettre une seule valeur au paramètre attributes :

    <cm:pageview extraparms="attr1"/>

    Comme aucune valeur n'est transmise au paramètre extraFields, la virgule n'est pas requise.

  • Exemple 2 :

    Pour transmettre une seule valeur au paramètre extraFields :

    <cm:pageview extraparms="null,exField1"/>

    La valeur null à gauche de la virgule est nécessaire pour indiquer qu'aucune valeur n'est transmise au paramètre attributes.

  • Exemple 3 :

    Pour transmettre plusieurs valeurs au paramètre attributes :

    <cm:pageview extraparms="attr1-_-attr2"/>
  • Exemple 4 :

    Pour transmettre plusieurs valeurs au paramètre extraFields :

    <cm:pageview extraparms="null,exField1-_-exField2"/>

    La valeur null à gauche de la virgule est nécessaire pour indiquer qu'aucune valeur n'est transmise au paramètre attributes.

  • Exemple 5 :

    Pour transmettre plusieurs valeurs au paramètre attributes et au paramètre extraFields :

    <cm:pageview extraparms="attr1-_-attr2,exField1-_-exField2"/>