Promotion.md

SajariAPIClient::Promotion

Properties

Name	Type	Description	Notes
banners	Array<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	Time	Output only. Time the promotion was created.	[optional][readonly]
disabled	Boolean	If disabled, the promotion is never triggered.	[optional]
display_name	String	The promotion's display name.
end_time	Time	If specified, the promotion is considered disabled after this time.	[optional]
exclusions	Array<PromotionExclusion>	The records to exclude from search results, if the promotion is enabled.	[optional]
filter_boosts	Array<PromotionFilterBoost>	The filter boosts to apply to searches, if the promotion is enabled.	[optional]
filter_conditions	Array<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	Array<PromotionPin>	The items to fix to specific positions in the search results.	[optional]
range_boosts	Array<PromotionRangeBoost>	The range boosts to apply to searches, if the promotion is enabled.	[optional]
start_time	Time	If specified, the promotion is considered disabled before this time.	[optional]
update_time	Time	Output only. Time the promotion was last updated.	[optional][readonly]

Example

require 'sdk_ruby'

instance = SajariAPIClient::Promotion.new(
  banners: null,
  collection_id: null,
  condition: null,
  create_time: null,
  disabled: null,
  display_name: null,
  end_time: null,
  exclusions: null,
  filter_boosts: null,
  filter_conditions: null,
  id: null,
  pins: null,
  range_boosts: null,
  start_time: null,
  update_time: null
)