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.
| Name | Type | Description | Notes |
|---|---|---|---|
| condition | str | 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'`. | |
| display_name | str | The promotion's display name. | |
| banners | [Banner] | The banners that are injected into the result set when the promotion is triggered. | [optional] |
| collection_id | str | The ID of the collection that owns this promotion. | [optional] [readonly] |
| create_time | datetime | The time the promotion was created. | [optional] [readonly] |
| disabled | bool | If disabled, the promotion is never triggered. | [optional] |
| end_time | datetime | If specified, the promotion is considered disabled after this time. | [optional] |
| exclusions | [PromotionExclusion] | The records to exclude from search results, if the promotion is enabled. | [optional] |
| filter_boosts | [PromotionFilterBoost] | The filter boosts to apply to searches, if the promotion is enabled. | [optional] |
| filter_conditions | [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 | str | The promotion's ID. | [optional] |
| pins | [PromotionPin] | The items to fix to specific positions in the search results. | [optional] |
| range_boosts | [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 | The time the promotion was last updated. | [optional] [readonly] |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |