Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 12.6 KB

Promotion.md

File metadata and controls

23 lines (20 loc) · 12.6 KB

# Promotion

Properties

Name Type Description Notes
banners \Sajari\Model\Banner[] The banners that are injected into the result set when the promotion is triggered. [optional]
collection_id string Output only. The ID of the collection that owns this promotion. [optional] [readonly]
condition string A condition expression applied to a search request that determines which searches the promotion is active for. For example, to apply the promotion's pins and boosts whenever a user searches for 'shoes' set condition to `q = 'shoes'`.
create_time \DateTime Output only. Time the promotion was created. [optional] [readonly]
disabled bool If disabled, the promotion is never triggered. [optional]
display_name string The promotion's display name.
end_time \DateTime If specified, the promotion is considered disabled after this time. [optional]
exclusions \Sajari\Model\PromotionExclusion[] The records to exclude from search results, if the promotion is enabled. [optional]
filter_boosts \Sajari\Model\PromotionFilterBoost[] The filter boosts to apply to searches, if the promotion is enabled. [optional]
filter_conditions \Sajari\Model\PromotionFilterCondition[] The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. A filter condition is comprised of a set of filters of the form `field = value` and matches a query if all of those filters are present in the query. For example, a query with the filter `productType = 'shirt' AND size = 'medium'` triggers a promotion with the filter condition `productType = 'shirt'`, but not one with both `productType = 'shirt', and `size = 'small'`. [optional]
id string The promotion's ID. [optional]
pins \Sajari\Model\PromotionPin[] The items to fix to specific positions in the search results. [optional]
range_boosts \Sajari\Model\PromotionRangeBoost[] The range boosts to apply to searches, if the promotion is enabled. [optional]
start_time \DateTime If specified, the promotion is considered disabled before this time. [optional]
update_time \DateTime Output only. Time the promotion was last updated. [optional] [readonly]

[Back to Model list] [Back to API list] [Back to README]