Pages
Page History
...
- Updated the validation for recommendation configurations (
/sites/<site_id>/recommendations
) whosetype
isbundle_converted
,bundle_viewed
, orbundle_viewed_converted
: The API now expects abundle
configuration to contain anoptions
property field with aproduct_attrs
child propertyfield, which is used for filtering the generated recommendation data by a product attribute.
...
- In recommendations (
/sites/<site_id>/recommendations
), updated the requirements for recommendation configurations based on the built-in recommendation types:- For the
most_viewed
andmost_converted
recommendation types:- If there are segment IDs defined in the
options
object, you can only filter recommendation data based on those segment IDs (not by any segment ID, as before). - You no longer need to define parameter values in the
params
property field. You can pass an empty string as a value. However, you must define at least one parameter (even if it's value is an empty string). - The number of parameters defined in the
params
property field must match the number of attributes defined in theproduct_attrs
property field of theoptions
object. If there are segment IDs defined in theoptions
object, there must be an additional parameter for the segment ID included in theparams
property field. - If the
category_delimiter
property field is defined in theoptions
object, thetype
product attribute must also be defined in theproduct_attrs
property field.
- If there are segment IDs defined in the
- The
bundle_converted
,bundle_viewed
, andbundle_viewed_converted
recommendation types only take a single parameter in theparams
property field. - The
value
property field of thedata point
object has been deprecated.
- For the
...
Improvements
- Added the
status
property field to the objects returned by the/sites/<site_id>/positions/<position_id>/messages
endpoint. Thestatus
property field indicates the status of the corresponding modification:active
,inactive
,invalid
,past
, orupcoming
. The Frosmo Control Panel uses thestatus
property field in the Edit placement view to list the modifications that use the placement by modification status.
...
- Migrated all existing production modifications to use the
segment_rules
property field in place of thecontexts.segments
andcontexts.segment_criteria
properties for defining their segment rules. Thecontexts.segments
andcontexts.segment_criteria
properties are no longer used by any production modification. For more information about this change, see the changelog entry for version 0.43.0.
...
- Added support for the segment selection feature for modifications, which combines selecting segments and defining a segment combination into a single workflow in the Frosmo Control Panel:
- All new modifications must define their segment rules in the
segment_rules
property field of the modification object (/sites/<site_id>/messages
). Previously, only cached modifications used thesegment_rules
property field, while other types of modifications used thecontexts.segments
andcontexts.segment_criteria
properties. - The
contexts.segments
andcontexts.segment_criteria
properties, which store segment and segment combination data, respectively, are now effectively deprecated. Existing production modifications that use these properties will be gradually migrated to use thesegment_rules
property field.
- All new modifications must define their segment rules in the
Graniitti API 0.42.3 (2019-04-08)
...
- When you export a custom script to the CDN (
/sites/<site_id>/js/export
), the API now excludes theprofile
property field from cached modification objects in cases where the site does not have selective profiling enabled. Previously, the API exported theprofile
property field for cached modifications regardless of whether or not the site used selective profiling.
...