Skip to end of metadata
Go to start of metadata

Deal Buyer Access Service

This read-only service lets bidders view information about the negotiated deals they have with sellers on Xandr's platform. A deal may provide a buyer preferential pricing, access to exclusive inventory, reduced competition on inventory, or other opportunities. Each deal is valid for a single buyer, but note that inventory included in a deal may be encompassed by deals with other buyers as well.

On This Page

REST API

When logged in with a member user, the following calls will return only deals available to that member. When logged in with a bidder user, the following calls will return deals available to all members or buyer seats under that bidder.

View all deals you have with sellers:
GET http://api.adnxs.com/deal-buyer-access  

View all deals you have with a specific seller:
GET http://api.adnxs.com/deal-buyer-access?seller_member_id=SELLER_MEMBER_ID   

View a specific deal:
GET http://api.adnxs.com/deal-buyer-access?id=DEAL_ID 

View multiple deals by ID using a comma-separated list: 
GET http://api.adnxs.com/deal-buyer-access?id=1,2,3

Search for a deal by name, ID, or code:
GET http://api.adnxs.com/deal-buyer-access?search="Deal_ID, DEAL_NAME,  or CODE"

Find out which fields you can filter and sort by:
GET http://api.adnxs.com/deal-buyer-access/meta  

JSON Fields

Field

Type (Length)

Description

id

int

The ID of the deal. This is the field you will receive on the bid request. Note that if you set up a deal with an external seller and funnel it through Xandr, we will turn their code into this ID.

codestring (100)The custom code for the deal.

name

string (255)The name of the deal.

description

string (65535)The description of the deal.

active

boolean

 

If true, the deal is active. Note that the deal will be available only when this field is true, start_date is in the past (or null), and end_date is in the future (or null).

start_date

timestamp

The day and time when the deal starts being available to the buyer. Null corresponds to "immediately".

end_date

timestamp

The day and time when the deal stops being available to the buyer. Null corresponds to "indefinitely".

floor_price

double

Deprecated. Please refer to ask_price instead. The minimum CPM value that the bidder must bid to be eligible for the deal.

If use_deal_floor is false, floor_price will be 0. In this case, note that although 0 is shown as the floor price, no deal floor is applied; if the seller has any other floors (in placements or yield management profiles), they will be applied, or if the seller does not have any other floors, the standard second-price auction mechanics will apply.

currency

enum

The currency for the floor_price.
use_deal_floorboolean

If true, the floor_price is applied for the deal.

When use_deal_floor is true, the deal's floor price overrides any other floors the seller may have, i.e., in placements or yield management profiles.

last_modifiedtimestampThe date and time when the deal was last modified.
sellerobjectThe selling member who is offering the deal. For more details, see Seller below.
buyerobjectThe buying bidder and member who can target this deal. For more details, see Buyer below.
buyer_seatsobjectThe buying bidder and seat who can target this deal. For more details, see Buyer Seats below.
typeobject

The type of deal. A deal can be an open auction or a private auction. For more details, see Type below.

brandsarray of objects

The brands of creatives that are eligible for the deal. For more details, see Brands below.

ask_priceintThe  price associated with the deal. This is the minimum amount the seller will accept for this inventory.
suggested_min_bid_priceint

The same amount as the ask_price.

Your minimum bid should be higher than the ask_price to account for the auction service charges specified in your Xandr contract. For deals with external suppliers, your bid should also include additional margin to account for discrepancies. Bidding the more than the ask_price helps ensure that you are eligible for the deal but there is no guarantee that your bid will win.

sizesarray of objects

The sizes of creatives that are eligible for the deal. For more details, see Sizes below.

If this array is not present in the response, there are no creative size requirements for the deal.

Seller

The seller object contains the following fields.

Field

Type

Description

id intThe member ID of the seller.
namestringThe member name of the seller.

Buyer

The buyer object contains the following fields.

Field

Type

Description

id intThe member ID of the buyer.
bidder_idintThe bidder ID of the member.
namestringThe member name of the buyer.

Buyer Seats

The buyer_seats object contains the following fields.

Field

Type

Description

bidder_idintThe bidder ID of the member.
bidder_namestringThe name of the bidder.
codestringThe identifier for the buyer seat
namestringName of buyer

Type

The type object contains the following fields.

Field

Type

Description

id int

The ID representing the type of deal. Possible values:

  • 1 = Open Auction
    In an "Open Auction", buyers targeting the deals and buyers targeting the inventory via other means compete for the impression. If a buyer targeting a deal submits the highest bid and the bid clears the deal's floor, that buyer wins the auction, paying either the second-highest bid or the deal floor price, whichever is higher. If one of the non-deal buyers submits the highest bid, that buyer wins the auction, paying either the second-highest bid or ECP, whichever is higher. 
  • 2 = Private Auction
    In a "Private Auction", buyers targeting the private deals compete for the impression first. Then, if none of the deal buyers win, the auction is opened to buyers targeting the inventory via other means. If a buyer targeting a deal submits a bid higher than the deal's floor and higher than any other private auction bids, that buyer wins the auction, paying either the second-highest bid from the private auction or the deal floor price, whichever is higher. If no private auction deals clear their floors, the highest bid in the open auction wins, paying either the second-highest bid from the open auction or ECP, whichever is higher.

For examples showing how these different types of auctions work, see Deal Auction Mechanics

namestringThe name of the type of deal. Possible values: "Open Auction", "Private Auction", or "First Look".

Brands

Each brands object contains the following fields.

Field

Type

Description

id intThe ID of the brand that is eligible for the deal. You can use the Brand Service to retrieve brand IDs.
namestringThe name of the brand that is eligible for the deal. You can use the Brand Service to retrieve brand names.

Sizes

Each object in the sizes array contains the following fields.

Field

Type

Description

width stringThe width of the creative.
heightstringThe height of the creative.

Examples

 View all deals you have with sellers
 View all deals you have with a specific seller
 View a specific deal
 View a specific deal (w/ Seat Code)
 View all deals that have not expired
  • No labels