Demand Side Platform JSON Fields

Property	Description	Type
name	The demand side platform name	String(255)

Trading Desk JSON Fields

Property	Description	Type
name	The trading name	String(255)

Buyer JSON Fields

Property	Description	Type
id	Buyer's identifier	Integer
name	Buyer's name	String(100)
type	Buyer's type. Values: ad-served programmatic (equivalent to direct buy on UI) sold-by-publisher open-rtb fixed-price	String
demand-side-platform-id	Buyer's demand side platform identifier	Integer
trading-desk-id	Buyer's trading desk identifier	Integer
seat-id	Buyer's actual seat id, just display for open-rtb buyers	String
accept-audio	Whether the buyer accepts audio. 0 for not accept 1 for accept	Integer

Insertion Order JSON Fields

Property	Description	Type	Optional on Create?
buyer-id	The buyer internal id	Integer	No
name	The name of the IO	String	No
internal-reference	The internal-reference of the IO	String	Yes
client-reference	The client-reference of the IO	String	Yes
contact	Contact name of the IO String	String	Yes
email	Contact email of the IO	String (email format)	Yes
signature-date	The signature date of the IO	Date	Yes

Ad JSON Fields

Property	Description	Type	Optional on Create?
name	The ad name	String(255)	No
campaign-id	The id of ad's campaign	Integer	No Cannot be set on update
type	The ad type (Video or VAST redirect or Audio) *Caution: field only available at creation. The ad type must match its campaign.*	String. Possible values are video or redirect.	No
url	The url of the media file if the type is video or audio, or the url of the VAST redirect to if this is a redirect. If this is a video or audio url, the video or audio file is uploaded to Freewheel's CDN and transcoded as needed.	String	No
clickthrough	If the ad type is video, a clickthrough url can be provided.	String	Yes Default is null: nothing is added. To delete, set it to null.
delivery-condition	A boolean expression a request must fulfill in order to be eligible for the campaign. See Allowed filters below.	Object. See Boolean Expression below.	Yes Default is null: nothing is added. To delete, set it to null.
third-party-trackings	The list of third-party trackings associated to the ad	Array of third-party-tracking objects. A third-party-tracking object has a type and an url property which are both mandatory. The type can have one of the following values: impression start firstQuartile midpoint thirdQuartile complete click The url represents the full URL to contact when the associated event occurs. Note that there can have multiple objects with the same type	Yes
skip-ad-button	An object defining the behavior of the skip ad button. Skip-ad-button.type is the duration type where the button appears and skip-ad-button.value is the duration in milliseconds/percent of the video from where the button appears.	Object	Yes Default is null: no skip ad button is added. To delete, set it to null.

Skip Ad Button

Property	Description	Type	Optional on Create?
type	The duration of the video at which the button appears	Enum ('ms', 'percent')	No, if the skip-ad-button object is present, the field is mandatory.
value	The duration in milliseconds/percent of the video at which the button appears	Integer	No, if the skip-ad-button object is present, the field is mandatory. If type is percent, the minimum value is 0, the maximum is 99 (inclusively for both). If type is ms, the minimum value is 0, and the maximum is 60000 (inclusively for both.)

Campaign JSON

Property	Description	Type	Optional on creation?
name	The campaign name	String(255)	No
start-date	The starting date of the campaign	Date using the YYYYMMDDHHMM format	No
end-date	The ending date of the campaign Sending an end-date will turn its objectives to flight and to daily if it's not.	Date using the YYYYMMDDHHMM format	Yes
impressions	If no end date is provided this represent a daily target, if not this is a global objective on the campaign running period	integer	No
brand-id	Id of the brand this campaign belongs to	integer	No
cpm	The campaign CPM	String with dot as decimal separator to avoid conversion issues	Yes
capping	An object describing the capping applied for this campaign. capping.view is the maximum number of impression for a viewer capping.duration is the duration in seconds for which this limitation applies	Object	Yes Default is null: no capping is applied to the campaign.
ad-ids	The list of ad ids contained in the campaign	Array (Int)	READ ONLY
io-id	The insertion order internal ID	integer	No
ad-type	Defines the ad type for this site: 0 for video 1 for audio Audio support module is required when creating audio inventory.	Int	Yes Default is 0, video.

Boolean expressions

Boolean expressions are expressed as objects in the form of a tree.

For example:

<p>{"operator":"or","left":{"operator":"and","left":{"key":"Geo_CountryId","operator":"=~","value":["FR"]},"right":{"key":"Time_Day","operator":"=~","value":["Monday", "Wednesday"]}},"right":{"key":"Geo_CountryId","operator":"=~","value":["CA"]}}</p>

For more information, visit Boolean Expressions.