Skip to end of metadata
Go to start of metadata

Yield Management Auction Tier Service

The Yield Management Auction Tier Service allows you to modify the standard auction mechanics such that certain bids will be considered before others, provided that those bids are associated with certain members and meet particular pricing requirements. You may also use this service to exclude certain members from consideration altogether.

Auction tiers must be associated with an existing Yield Management Profile.

On This Page

REST API

Add an auction tier:
POST https://api.appnexus.com/ym-auction-tier
(auction-tier JSON)

Modify an auction tier:
PUT https://api.appnexus.com/ym-auction-tier?id=AUCTION_TIER_ID
(auction-tier JSON)

View all of your auction tiers:
GET https://api.appnexus.com/ym-auction-tier

View a specific auction tier:
GET https://api.appnexus.com/ym-auction-tier?id=AUCTION_TIER_ID

View multiple auction tiers by ID using a comma-separated list:
GET https://api.appnexus.com/ym-auction-tier?id=1,2,3

Delete an auction tier:
DELETE https://api.appnexus.com/ym-auction-tier?id=AUCTION_TIER_ID

JSON Fields

 

Field

Type

Description

Default

Required On

id

int

The unique identifier for this auction tier.

Auto-generated number

PUT, in query string

name

string

The name  of this tier.

 

POST

code

string

An optional custom code that you can use to map between this object's identifier in your system and in ours.

null

 

description

string

An optional description.

 

 

profile_id

int

An optional profile_id is used to determine when to apply a tier. A profile is a generic set of rules for targeting inventory, and certain tiers may only apply to certain slices of inventory. (See the Profile Service for details.)

null

 

priority

int

You'll rank each auction tier from 1 to 10 in ascending priority. Those with higher priorities are checked first for a match. If two tiers happen to match the bid in question, and their priorities are equal, the winner is chosen at random.

5

 

ym_profile_id

int

An auction tier is associated with a Yield Management Profile. This is that profile's identifier.

 

POST

min_price

decimal

The minimum price that must be bid by the members in the buyer_members array for inclusion in this tier. This can be null if the member_action is set to "exclude".

Whether a buyer has met the value of min_price is checked after AppNexus' revenue sharing fee has been removed; in other words, min_price is checked against their net bid. For example, if you've set min_price to $2.00, and the buyer bids $2.00, their net bid may be reduced to $1.70. This would mean they do not qualify for the tier. The solution is for buyers to take into account their revenue sharing agreement with AppNexus when submitting bids for inclusion in tiers.

null

 

member_action

enum

This setting determines what action is to be taken against the buyer_members array. Permissible values are "include" and "exclude".

exclude

 

member_id

int

This is your member ID.

 

 

buyer_members

array of objects

This array includes the buyers you're targeting for inclusion or exclusion in this Auction Tier. See The Buyer Members Array below for details.

null

 

The Buyer Members Array

Field

Type

Description

Default

Required On

id

int

The ID of the member you're targeting for inclusion or exclusion.

 

 

name

string

The name of the member you're targeting for inclusion or exclusion.

 

 

Examples

View all of your auction tiers
Add an auction tier - exclude a member
Add an auction tier - include a member
Update an auction tier
Delete an auction tier