Skip to end of metadata
Go to start of metadata

Yield Management Bias Service

The Yield Management Bias Service is used to create and update biases within an existing Yield Management Profile. Biases are a way of modifying bids from certain buyers or groups of buyers so that they appear higher or lower than they actually are for the purposes of running an auction.

See our overview of Yield Management for more information on how biases work (Customer login required).

On This Page

REST API

Add a bias:
POST https://api.appnexus.com/ym-bias?ym_profile_id=YM_PROFILE_ID
POST https://api.appnexus.com/ym-bias?ym_profile_code=YM_PROFILE_CODE
(ym-bias JSON)

Modify an existing bias:
PUT https://api.appnexus.com/ym-bias?id=YM_BIAS_ID
PUT https://api.appnexus.com/ym-bias?code=YM_BIAS_CODE
(ym-bias JSON)

View all biases associated with a particular Yield Management Profile:
GET https://api.appnexus.com/ym-bias?ym_profile_id=YM_PROFILE_ID
GET https://api.appnexus.com/ym-bias?ym_profile_code=YM_PROFILE_CODE

View a specific bias:
GET https://api.appnexus.com/ym-bias?id=YM_BIAS_ID
GET https://api.appnexus.com/ym-bias?code=YM_BIAS_CODE

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

JSON Fields

Field

Type

Description

Default

Required On

id

int

The unique identifier for a yield management bias.

Auto-incremented Number (i.e. 123)

PUT

code

string

A optional custom code used to reference a yield management bias.

NULL

name

string

A name used to describe a yield management bias.

None

POST

description

string

An optional description how the yield management bias is being used.

NULL

ym_profile_id

int

The ID of the yield management profile that the yield management bias is associated with. See the Yield Management Profile Service for details. Note: This ID cannot be changed once it is set.

NULL

POST

profile_id

int

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

NULL

priority

int

The priority field (optional) is used to create a hierarchy of how the bias should to be applied. Value may be between 1-10 where priority 10 is treated as the highest priority value.

5

members

array of objects

This is an array specifying the member(s) the yield management bias should be applied to. See The Members Array below for details.

NULL

buyer_groups

array of objects

This is an array specifying the buyer group(s) the yield management bias should be applied to. See The Buyer Groups Array below for details.

NULL

The Members Array

Field

Type

Description

Default

Required On

id

int

This is the id of the buyer member (as found in the Platform Member Service) for which the bias should be applied.

None

POST, PUT

name

array

This is the name of the buyer member.

N/A

type

enum('percent','cpm')

This determines which value to use for the bias, represented as a percentage or a flat CPM.

"percent"

POST, PUT

bias_pct

double

This is the % amount the buyer member should be adjusted by. If bias_pct = 5, then the net bid will be increased 5%.

0.00

POST, PUT (if type is 'percent')

bias_cpm

double

This is the CPM increase/decrease the buyer member should be adjusted by.

NULL

POST, PUT (if type is 'cpm')

The Buyer Groups Array

Parameter

Type

Description

Default

Required On

id

int

This is the id of the buyer group for which the bias should be applied.

None

POST, PUT

name

array

This is the name of the buyer group.

N/A

type

enum('percent','cpm')

This determines which value to use for the bias, represented as a percentage or a flat CPM.

"percent"

POST, PUT

bias_pct

double

This is the % amount the buyer member should be adjusted by. If bias_pct = 5, then the net bid will be increased 5%.

0.00

POST, PUT (if type is 'percent')

bias_cpm

double

This is the CPM increase/decrease the buyer member should be adjusted by.

NULL

POST, PUT (if type is 'cpm')

Examples

View a specific bias
View all biases associated with a given Yield Management Profile