Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 2.99 KB

Promotion.md

File metadata and controls

25 lines (21 loc) · 2.99 KB

Com.Sajari.Sdk.Model.Promotion

Promotion contains a trigger, determining which searches it should be active for, and a list of alterations that should be made to search results when it is active.

Properties

Name Type Description Notes
Banners List<Banner> The banners that are injected into the result set when the promotion is triggered. [optional]
CollectionId 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'`.
CreateTime DateTime Output only. Time the promotion was created. [optional] [readonly]
Disabled bool If disabled, the promotion is never triggered. [optional]
DisplayName string The promotion's display name.
EndTime DateTime If specified, the promotion is considered disabled after this time. [optional]
Exclusions List<PromotionExclusion> The records to exclude from search results, if the promotion is enabled. [optional]
FilterBoosts List<PromotionFilterBoost> The filter boosts to apply to searches, if the promotion is enabled. [optional]
FilterConditions List<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 List<PromotionPin> The items to fix to specific positions in the search results. [optional]
RangeBoosts List<PromotionRangeBoost> The range boosts to apply to searches, if the promotion is enabled. [optional]
StartTime DateTime If specified, the promotion is considered disabled before this time. [optional]
UpdateTime DateTime Output only. Time the promotion was last updated. [optional] [readonly]

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