Deal JSON Fields
| Property | Description | Type | Optional on Creation? |
|---|---|---|---|
| name | The deal name | String(100) | No |
| public-id | The deal id shared with commercial partners | String(50) | Yes If not provided, a new one is generated. |
| start-date | The beginning date of the deal proposed to buyers | Date in YYYYMMDD format | No |
| end-date | The ending date of the deal proposed to buyers | Date in YYYYMMDD format | Yes Default is null: the deal will never expire. |
| fixed-price-cpm | The cpm to paid when a bid responds to this deal. This corresponds to an auction type 3 in the openRTB standard, if set-floor-price-policy and advertiser-floor-price should not be sent. | String with dot as decimal separator to avoid conversion issues | Yes Default is null. If fixed-price-cpm is filled, floor-price-policy and advertiser-floor-price is ignored. (Floor-price-policy is none.) |
| floor-price-policy | The floor price policy that applies when responding to this deal. Possible values are:
The value both-side is not allowed if the AdNetwork module is disabled. | String | Yes Default is publisher-side: no floor price is applies on the bid prices. |
| advertiser-floor-price | The minimum CPM (in EUR) the publisher allows when responding to this deal | String with dot as decimal separator to avoid conversion issues | Must be set only if the floor-price-policy is advertiser-side or both-side and the fixed-price-cpm is not set. |
| show-domain | The show domain policy for bidders. Possible values are:
| String | No |
| bid-priority | The priority policy of bid responding to this deal. Possible values are:
| String | No |
| buyer-group-number | The overloaded priority of the bid responding to this deal | Integer | Must be set only if the bid-priority is buyer-group-number. |
| activation-condition | A boolean expression a request must fulfill in order to be eligible for the deal. See Allowed filters below. | Object | Yes |
| target-buyers | The list of buyer ids that can respond to the deal | Array of integers | Yes If no target-* is set, the deal applies to all bidders participating to the auction. Buyers must be of type openRTB. Buyers must be able to accept audio when an audio deal is created. |
| paused | A flag indicating if the deal is paused | Boolean | Yes Default is false. |
| priority | The deal application order. Lowest is tried first. When a deal is created, the new deal is added at the bottom of the list: with a lower priority than any previously created deal. | Integer | Read Only Default: current higher value + 1. |
| is-last | Flag indicating if other deals can apply after this one has been applied | Integer | Read Only Default is 0. |
| externalref | String(50) | Yes Default is null. | |
| max-ad-duration | The maximum duration in seconds the deal allows for an ad. Zero value indicates that no limitation will be applied. | Integer | Yes Default is null. |
| seats | The seats of bidders | Array of String | Only for displaying in detail and list api |
| creator_id | The SFX user ID of the deal creator | Integer | Only for displaying in Detail and List API. Default is -1 if unknown. |
| creator_name | The SFX user name of deal creator | String | Only for displaying in Detail and List API. Default is empty string if unknown. |
| create_at | The date and time when the deal was created | Date string using IOS format , e.g., 2019-11-26T10:04:35+0100 | Only for displaying in Detail and List API. It doesn't appear if unknown. |
| update_at | The last time the deal was updated | Date string using IOS format , e.g., 2019-11-26T10:04:35+0100 | Only for displaying in Detail and List API. It doesn't appear if unknown. |
| ad-type | Defines the ad type for this site:
Audio support module is required when creating audio inventory. | integer | Yes (Default is 0, video) |
Allowed filters for "activation-condition"
- ZoneDevice
- Client_Device
- Site_Variable
- Ad_Duration
- ZoneType
- Publisher
- Zone
- Client_Browser
- Domain
- Client_OperatingSystem
- Site
- Pageurl
- Geo_CountryId