Pasar datos adicionales a IBM Digital Analytics utilizando el parámetro extraparms

Es posible que desee pasar datos a IBM Digital Analytics que no recopilan automáticamente las etiquetas de análisis de HCL Commerce. Por ejemplo, puede que desee pasar información sobre la marca de los productos que los clientes ven para un informe del explorador de IBM Digital Analytics, o pase datos de registro específico para un informe personalizado en IBM Digital Analytics. Si es así, utilice el parámetro extraparms en la etiqueta de análisis de HCL Commerce cuando se coloca la etiqueta en la página de la tienda. También puede utilizar el parámetro extraparms para alterar temporalmente el ID de categoría que genera las etiquetas de análisis de HCL Commerce. Muchas de las etiquetas de análisis de HCL Commerce son compatibles con el parámetro extraparms.
Nota: La información de este tema también se aplica a los parámetros orderExtraparms y extraparmsMap que son compatibles con algunas etiquetas de análisis de HCL Commerce. Para obtener más información sobre cómo pasar valores con el parámetro orderExtraparms, consulte la sección 3. Formato para definir los valores de extraparms para otras etiquetas de análisis de HCL Commerce.

Cómo el parámetro extraparms pasa los datos a IBM Digital Analytics

En tiempo de ejecución, las etiquetas de análisis de HCL Commerce generan etiquetas de datos de IBM Digital Analytics. Si incluye el parámetro extraparmsextraparmsHCL Commerce en la etiqueta de análisis, sus valores se pasan como una serie a uno o más de los siguientes parámetros de etiquetas de datos de IBM Digital Analytics, en función de cómo se especifican los valores:

Parámetro de la etiqueta de datos de IBM Digital Analytics generada Descripción:
catIDoverride Utilice este parámetro para alterar explícitamente el ID de categoría generado por las etiquetas de análisis de HCL Commerce siguientes: Etiqueta <cm:cart />, <cm:order /> y <cm:product />.
attributes Este parámetro proporciona atributos de Explore para IBM Digital Analytics Explore, una solución de informes ad hoc que puede utilizar para crear informes personalizadas.
extraFields Este parámetro proporciona datos adicionales para informes personalizados en IBM Digital Analytics.
cm_vc Es un parámetro de "categoría virtual" que solo se utiliza para la etiqueta <cm:product />. Utilice este parámetro para categorizar vistas de productos que se originan en enlaces especiales tales como recomendaciones de venta cruzada, en lugar de la navegación de categoría normal.
El formato que se utiliza para pasar valores de extraparms varía en función de la etiqueta de análisis HCL Commerce. Las reglas de formato se proporcionan en las tres secciones siguientes:
Nota: Los ejemplos de este tema utilizan la sintaxis simplificada para especificar valores extraparms. Debe especificar los valores utilizando JavaScript con escape.
Ejemplo de sintaxis simplificada
extraparms="value1-_-value2,value3-_-value4"
Ejemplo de JavaScript con escape correcto
extraparms="\"value1-_-value2\",\"value3-_-value4\""

Si alguno de estos valores extraparms son variables JavaScript, consulte las reglas de sintaxis explicadas en Sintaxis para pasar variables JavaScript como parámetros adicionales.

1. Formato para establecer valores de extraparms para las etiquetas <cm:cart /> y <cm:order />

Cuando se definen los valores de extraparms para cualquiera de estas etiquetas, debe seguir un formato específico para controlar qué valores se pasan al parámetro catIDoverride, al parámetro attributes y al parámetro extraFields. El siguiente ejemplo ilustra el formato correcto:


Formato 1 del parámetro extraparms
Las reglas del formato son:
  • Especifique los valores para los tres parámetros IBM Digital Analytics en el orden que se muestra en el ejemplo anterior. Especifique el valor de catIDoverride en la primera posición, seguido por una coma, después uno o más valores de attributes en la segunda posición, seguido por una coma, y después uno o más valores de extraFields en la tercera posición.
  • Utiliza el valor null para indicar cuándo no se están pasando valores para catIDoverride o attributes.
  • Para pasar varios valores para un parámetro, separe cada valor con el siguiente delimitador: -_-

Los siguientes ejemplos muestran cómo aplicar estas reglas de formato cuando se utiliza el parámetro extraparms. Los ejemplos utilizan <cm:cart tag />, aunque también se aplican a la etiqueta <cm:order />.

  • Ejemplo 1:

    Para pasar un valor al parámetro catIDoverride:

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

    Puesto que no hay valores que se estén pasando a los parámetros attributes o extraFields, no es necesario el uso de comas o valores nulos.

  • Ejemplo 2:

    Para pasar un solo valor al parámetro attributes:

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

    El valor null a la izquierda de la coma es necesario para indicar que no se está pasando ningún valor al parámetro catIDoverride.

  • Ejemplo 3:

    Para pasar dos valores al parámetro attributes:

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

    Para pasar un solo valor al parámetro extraFields:

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

2. Formato para configurar los valores de extraparms para la etiqueta <cm:product />

Al definir los valores de extraparms para la etiqueta <cm:product />, debe seguirse un formato específico para controlar qué valores se pasan al parámetro catIDoverride, al parámetro attributes y al parámetro cm_vc. El siguiente ejemplo ilustra el formato correcto:


Formato II del parámetro extraparms
Las reglas del formato son:
  • Especifique los valores para los tres parámetros IBM Digital Analytics en el orden que se muestra en el ejemplo anterior. Especifique catIDoverride en la primera posición, seguido de una coma, después uno o más valores de attributes en la segunda posición, seguido de una coma, y después un nombre de categoría virtual como valor de cm_vc en la tercera posición.
  • Utiliza el valor null para indicar cuándo no se están pasando valores para catIDoverride o attributes.
  • Para pasar varios valores para un parámetro, separe cada valor con el siguiente delimitador: -_-

Los ejemplos siguientes muestran cómo aplicar estas normas de formato cuando se utiliza el parámetro extraparms con la etiqueta <cm:product />:

  • Ejemplo 1:

    Para pasar un valor al parámetro catIDoverride:

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

    Puesto que no hay valores que se estén pasando a los parámetros attributes o cm_vc, no es necesario el uso de comas o valores nulos.

  • Ejemplo 2:

    Para pasar un solo valor al parámetro attributes:

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

    El valor null a la izquierda de la coma es necesario para indicar que no se está pasando ningún valor al parámetro catIDoverride.

  • Ejemplo 3:

    Para pasar dos valores al parámetro attributes:

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

    Para pasar un solo valor al parámetro cm_vc:

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

3. Formato para definir los valores de extraparms para otras etiquetas de análisis de HCL Commerce

Los siguientes ejemplos y reglas de formato se aplican a la etiqueta <pageview /> y a cualquier otra etiqueta de análisis de HCL Commerce que pasa valores a los parámetros IBM Digital Analytics attributes y extraFields. Al definir los valores de extraparms para estas etiquetas, debe seguirse un formato específico para controlar qué valores se pasan al parámetro attributes, al parámetro extraFields o a ambos. El siguiente ejemplo ilustra el formato correcto:


Formato III del parámetro extraparms
Las reglas del formato son:
  • Especifique valores para los dos parámetros en el orden que se muestra en el ejemplo anterior. Especifique uno o más valores de attributes en la primera posición, seguidos de una coma y, a continuación, uno o más valores de extraFields en la segunda posición.
  • Utilice el valor de null para indicar cuándo no se pasa ningún valor para el parámetro attributes.
  • Para pasar varios valores para un parámetro, separe cada valor con el siguiente delimitador: -_-

Los siguientes ejemplos muestran cómo aplicar estas reglas de formato. Los ejemplos utilizan la etiqueta <cm:pageview />, aunque también se aplican a otras etiquetas que pasan valores a attributes y extraFields.

  • Ejemplo 1:

    Para pasar un solo valor al parámetro attributes:

    <cm:pageview extraparms="attr1"/>

    Debido a que no se pasa ningún valor al parámetro extraFields, la coma no es necesaria.

  • Ejemplo 2:

    Para pasar un solo valor al parámetro extraFields:

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

    El valor null a la izquierda de la coma es necesario para indicar que no se está pasando ningún valor al parámetro attributes.

  • Ejemplo 3:

    Para pasar varios valores al parámetro attributes:

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

    Para pasar varios valores al parámetro extraFields:

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

    El valor null a la izquierda de la coma es necesario para indicar que no se está pasando ningún valor al parámetro attributes.

  • Ejemplo 5:

    Para pasar varios valores al parámetro attributes y al parámetro extraFields:

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