Campos de datos del JSON

En nuestro modelo de datos JSON, tenemos varios atributos para registrar la actividad del usuario. A continuación describimos cada uno de esos campos y en que circunstancias, paginas y comportamientos de usuario se deben utilizar. 
 

Campo de datos	Tipo de página	Descripción
pagetype	todos	Este campo se utiliza para indicar a BrainSINS qué tipo de página está visualizando el usuario. Debemos cambiar PAGE_TYPE por los siguientes valores: pagetype: PAGE_TYPE product: Cuando el usuario está visitando la página de producto. home: Cuando el usuario está visitando la home o página de inicio. category: Cuando el usuario está visitando la página categoría. cart: Cuando el usuario está en la página de carrito. checkout: Cuando el usuario está en la página de comienzo del checkout. Algunas veces esta página coincide con la página de carrito, en ese caso usaremos "checkout" como pagetype. thankYou: Cuando el usuario ha completado la compra. login: Cuando el usuario es redirigido a una página especifica después del proceso de login. Por ejemplo, si un usuario está visitando la página de home, el JSON debe contener: pagetype: "home",
language	todos	Si tu tienda tiene varios idiomas, puedes especificar en este campo el lenguaje concreto con que el usuario visita la web. Esto es necesario para mostrar los detalles de los productos recomendados en el idioma adecuado. Si tienes varios idiomas en tu tienda, debes configurar el feed de productos para enviarnos la información en cada idioma.  Por ejemplo, si un usuario visita la web en catalán y hemos configurado el campo "lang" en el catálogo como "ca", tendremos que poner lo siguiente en el JSON:  language: "ca",
productId	producto	Cuando el usuario visita la página de producto, el campo de productId debe contener el id interno del producto. Este id tiene que coincidir con el id proporcionado en el feed de productos. Por ejemplo, si el usuario está visitando la página del producto cuyo id es 676, el JSON debe contener lo siguiente:  pagetype: "product", productId: 676, Este id tiene que ser un número natural sin caracteres ni símbolos.
totalAmount	thankYou	Usamos totalAmount cuando el usuario finaliza una compra. totalAmount nos indica el valor final de la compra realizada para fines estadisticos de la herramienta. Por ejemplo, si el usuario ha realizado una compra de 1.249,32€ lo que deberías enviarnos es un float de la siguiente manera:   pagetype: "thankYou", totalAmount: 1249.32,
categories	categoría (todos)	El campo categories se usa para proporcionar a BrainSINS una o varias categorías para, por ejemplo, filtrar en base a la categoría que el usuario visita en ese momento. Por ejemplo, si el usuario está visitando el listado de categorías para camisetas en la tienda, se debe incluir lo siguiente en el JSON:  pagetype: "category", categories: "shirts", Si el usuario no esta visitando ningún listado de categorías, podemos incluir el campo "categories" para filtrar el resultado de los recomendadores de acuerdo con una categoría que le indiquemos. Podrás ver mejor como funciona este campo en la documentación relacionada con el objeto recommender.   Por ejemplo, si se quiere mostrar productos recomendados in la home pero necesitas que los productos pertenezcan a las categorías "navidad" y "vacaciones" debes incluir lo siguiente en el JSON: pagetype: "home", categories: "navidad, vacaciones", recommenders: [ { recommenderId: 13, location: "recommendation-home", position: "replace", filter: "any" }], En BrainSINS asociamos este campo categories con la información de categorías que recibimos en el feed de productos. Por tanto, las categorías de un sitio y otro deben ser consistentes entre si.
userEmail	todos	En BrainSINS podemos almacenar emails de usuarios y asociarlos a la sesión de navegación. De esta formas podrás configurar reglas de email retargeting para recuperar abandonos de carrito o compra o, incluso, newsletter personalizadas. Siempre que un usuario se registre o haga login en la web tendrás que incluir el campo userEmail. pagetype: "login", userEmail: "[e-mail]", Generalmente el email del usuario se envía en la página de confirmación de login pero puedes añadirlo con userEmail en cualquier tipo de página. En este caso, se debe añadir el campo userNewsletter igual a 1 para que se envíe el email. Un ejemplo:  pagetype: "checkout", userEmail: "[e-mail]", userNewsletter: 1
userNewsletter	todos	Este campo es una modificación de userEmail y se usa solamente para notificar que el usuario recogido no desea recibir ningún tipo de comunicación por email. Por ejemplo, si un usuario con el email [e-mail] se registra en la tienda pero no quiere recibir comunicacion se debe incluir lo siguiente:  pagetype: "login", userEmail: "[e-mail]", userNewsletter: 0,
cart	carrito	El campo "cart" se usa para enviar a BrainSINS informacion sobre el contenido del carrito del usuario actual. Normalmente esto será en la página de carrito donde se visualiza su contenido. Por ejemplo, si un usuario añade una unidad del producto con id=13 y tres unidades del producto con id=27, el código que deberás poner es el siguiente: pagetype: "cart", cart: { products: [ { id: 13, quantity: 1 }, { id: 27, quantity: 3 }] } Este campo debe contener una lista de N pares {id, quantity}, donde N es el numero de productos diferentes en el carrito del usuario. Aunque el principal uso de este campo es en la página de carrito, se puede incluir en cualquier otra página para trackear los productos del carrito. En algunos casos puede ser necesario sincronizar el carrito en la página de checkout en donde tendrás que incluir el siguiente código: pagetype: "checkout", cart: { products: [ { id: 13, quantity: 1 }, { id: 27, quantity: 3 }] } Para otras opciones de trackeo de carritos por favor visita nuestra documentación sobre página de carrito.
recommenders	todos	Los recomendadores deben ser añadidos a nuestro objeto BrainSINSData. En el siguiente ejemplo veremos como se inserta un recomendador con lo básico para la página de home: <script type="text/javascript">    var BrainSINSData = {        pageType:"home",        recommenders: [ { recommenderId: ID, location: UBICACIÓN, position: POSICIÓN }] }; </script> Cómo configurar los parámetros: recommenderId: el id del recomendador. Se puede encontrar en la lista de recomendadores. location: debemos indicar el elemento HTML de referencia. Podemos identificarlo gracias a su id o clase y podemos señalarlo igual que en jQuery o CSS con "." para las clases y "#" para los id. position: puede ser "before", "after", "replace", "first" or "last". También se pueden usar otros parámetros para dar al recomendador más precisión o adecuarlo a lo que queremos que muestre: categories: este es un parámetro típico de la página de categoría pero también se puede poner dentro del recomendador para que solo dicho recomendador filtre por una o más categorías (separadas por comas). Este parámetro solo afecta al recomendador concreto donde lo ponemos. filter: puede ser "any", "all" o "forbid". Si no lo configuramos, el parámetro categories no tendrá efecto. También se puede usar este parámetro en la página de categoría usando como referencia el campo categories del BrainSINSData, fuera del recomendador.  any: el recomendador mostrará productos que contengan al menos una categoría igual. all: los productos deben contener todas las categorías del campo categories para mostrarse en el recomendador. forbid: los productos con todas las categorías iguales a las del campo categories no se mostrarán en el recomendador. Un ejemplo, si se quieren dos recomendadores para la página home, uno con el recomendador con id 1 (Basado en tendencias de navegación) y otro con el recomendador id 2 (Más vendidos):  <script type="text/javascript">    var BrainSINSData = {        pageType:"home",        recommenders: [ { recommenderId: 1, location: "#brainsins_rec", position: "replace" },{ recommenderId: 2, location: ".main_row", position: "after", categories: "camisetas,rojo", filter: "forbid" } ] }; </script>