Deal

Response values

Parameter	Type	Description
userID	integer	Specifies the ID of the user that can access the associated information. For more information about deals, see https://kb.indexexchange.com/publishers/pmp/negotiating_discounts_on_deals_publishers.htm
userDealID	integer	Specifies the ID systematically assigned to identify the user-deal association.
dspID	integer	Specifies the ID of the DSP.
name	string	Specifies the name of the deal.
dealType	integer	Specifies the ID of the deal type, where: `1` = one-to-many deal type `0` = one-to-one deal type
auctionType	string	Specifies the auction type, where: `first` = first price auction `second` = second price auction `fixed` = fixed price auction
rate	string	Specifies the floor rate of the deal. The format of the floor rate includes a decimal and two decimal places regardless of the publisher’s set currency. For example: 1.99.
status	string	Specifies the status of the deal, where: `A` = active `D` = deactivated or deleted `N` = new
startDate	string	Specifies the start date of the deal in the following format: YYYY-MM-DD.
endDate	string	Specifies the end date of the deal in the following format: YYYY-MM-DD.
dealID	string	Specifies the ID the user assigned to the deal.
priority	integer	Specifies the priority of the deal, where: `1` = lowest priority `10` = highest priority
openMarket	integer	Specifies whether the deal can compete in the open market, where: `0` = deal is private `1` = deal is open to market competition
payout	integer	Specifies whether payout is enabled, where: `1` = enabled `0` = not enabled Note: Impressions for the deal do not generate any revenue when payout is disabled.
humanVerification	integer	Specifies whether auto-approval is enabled, where: `1` = enabled `0` = not enabled Note: A value is returned only if the specified DSP and deal are active.
placementID	array of integers	Specifies the IDs of the placements associated with the deal.
sectionID	array of integers	Specifies the IDs of the deal sections associated with the deal.
buyerID	array of integers	Specifies the IDs of the buyers involved in the deal.
discount	float	Specifies the discount percentage. Possible values support up to one decimal place (for example, 15.5) and can range from 0 (no discount) to 99.9 (a 99.9% percent discount).