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 |
---|---|---|---|
banners | java.util.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 | OffsetDateTime | Output only. Time the promotion was created. | [optional] [readonly] |
disabled | Boolean | If disabled, the promotion is never triggered. | [optional] |
displayName | String | The promotion's display name. | |
endTime | OffsetDateTime | If specified, the promotion is considered disabled after this time. | [optional] |
exclusions | java.util.List<PromotionExclusion> | The records to exclude from search results, if the promotion is enabled. | [optional] |
filterBoosts | java.util.List<PromotionFilterBoost> | The filter boosts to apply to searches, if the promotion is enabled. | [optional] |
filterConditions | java.util.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 | java.util.List<PromotionPin> | The items to fix to specific positions in the search results. | [optional] |
rangeBoosts | java.util.List<PromotionRangeBoost> | The range boosts to apply to searches, if the promotion is enabled. | [optional] |
startTime | OffsetDateTime | If specified, the promotion is considered disabled before this time. | [optional] |
updateTime | OffsetDateTime | Output only. Time the promotion was last updated. | [optional] [readonly] |