...
| Info |
|---|
* for the cases of CONSIDERATION, as they are becoming quickly complicated, it is advised to consider using the Boxalino Narrative API as early as possible as this will make the tracking much simpler as it is all automated by the Boxalino Narrative API response. Adding elements in Boxalino there will be automatically tracked in the proper way without additional efforts on your side. |
data-bx-narrative-
...
There you can indicate the name of the component of a page.
Component might vary from
images
banners
data-bx-narrative-field & data-bx-narrative-value
...
For the case of content, same thing, but of course use an standard or custom attribute name as field which you are exporting in your doc_content data.
Read more:
doc_product https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/252149870 the export data structure of your product
doc_content https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/252280968 the export data structure of your headless content
doc_attribute https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/252280945 the list of standard attribute names (like ‘sku’, ‘id’, ‘external_id’ and ‘products_group_id’ which are always there when you are exporting your data to Boxalino).
data-bx-narrative-name
As you will do it anyway in your Boxalino Narrative Layout projects, we recommend you to use a component-base architecture for all visual displays of your front-end.
The main idea being to create modular front-end component which are re-used in many different places of your front-end as we document it here: Check-list: empower your Website Layout with Narratives
There you can simply indicate the name of the component and, if needed, the role it has on its page in the parameter (this is particularly useful if the same component is used several times on the same page for different reasons).
You do not need to indicate anything about the page itself, as you are already providing this information in the attribute bdata-x-narrative-type (as indicated above).
Here are a few examples.
image-slider|section=main-pdp-images
banners-slider-full-width|section=top-campaigns
data-bx-narrative-group-by & data-bx-item-id
We speak here of what qualify the visual element which is shown to the user (an image in a slider, a price, a delivery information, …)
This is the part of the tracking which is the less possible to standardize as it really depends of many aspects specific to your projects.
Typically, we recommend to leave the data-bx-narrative-group-by with it’s default value ‘id’, unless you are able to define the nature of the value in a clear name.
For example, if you are tracking as value the url of an image (because you do not have any better name/value to provide), then you can set the value of the data-bx-narrative-group-by with “src” or “url” to indicate what it is.
For the value of the data-bx-item-id
...
[VALUE]|[PARAMETERS]istelf, we recommend to put a value which is descriptive and easy to read and to use as a group and to only put the specific value as a parameter (with the exception of a price which should be set as the numerical value of the price directly).
For example, for such a case:
...
we recomend a tracking like :
orange|date=17.02.22
So that you will have easily the reports on all the cases “orange” together and, only for advanced analysis can you go in the decoding and mining of the displayed date.
data-bx-variant-uuid
Typically do not set. Only if you have another tracking system and you would like to inform us of the unique identifier used in the other tracking system