Skip to end of metadata
Go to start of metadata

Yield Management Floor Service

The Yield Management Floor Service is used to create and update floors within an existing Yield Management Profile.

A floor can be thought of as the minimum price a network or publisher would like to receive for a creative. There are subtleties, however. See our overview of Yield Management for details (Customer login required).

Floor settings supersede any reserve prices set via the Placement Service.

Example: You have a soft floor setting, but no hard floor, and you've set a reserve price at the Placement level. Since you're using Yield Management tools, however, your reserve price setting will be ignored. You must set it here via a hard floor.

On This Page

REST API

View all floors associated with a given member:

View all floors associated with a given Yield Management Profile :

View a specific floor:

View multiple yield management floors by ID using a comma-separated list:

Add a new floor:

Modify an existing floor:

Delete an existing floor:

You cannot delete a floor that is used as the base floor for one or more Yield Management Profiles.

JSON Fields

Field

Type

Description

Default

Required On

member_id int The unique identifier for the member with which the floor is associated. NULL PUT, in querystring

id

int

The unique identifier for a yield management floor.

Auto-incremented Number (i.e. 123)

PUT

name

string

The name used to describe a yield management floor.

None

POST

code

string

The optional custom code used to reference a yield management floor.

NULL

description

string

The optional description of how the yield management floor is being used.

NULL

hard_floor

double

The CPM floor used as the hard reserve price to be applied.

None

POST

soft_floor

double

The CPM floor used as the soft reserve, defined as the lowest price at which price reduction will occur. This must be greater than or equal to the hard floor if set. This value is ignored if f loor_optimization_enabled is true.

NULL

default_calculation_type

enum

Whether the floor should be applied to the gross or net bid. Possible values: gross or net. A default_calculation_type of net is a floor applied to the media cost paid out to the publisher.

gross

profile_id

int

An optional profile_id is used to determine when to apply a floor. A profile is a generic set of rules for targeting inventory, and certain floors 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 floor should to be applied. Value may be between 1-10, where priority 10 is treated as the highest priority value.

5

ym_profile_id

int

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

NULL

POST

floor_application_target

enum

The type of bids to which the price floor is applied. Possible values:

  • external_only: The price floor is applied only to external bids (buying member and selling member are different). Use this option if you would rather serve an available managed learn impression than serve a default, even if this means exceeding the maximum % of daily volume for learn (max_learn_pct field in Publisher Service).
  • external_non_preferred: The price floor is applied to external bids (buying member and selling member are different) or when the impression is an available managed learn impression that exceeds the maximum % of daily volume for learn. Use this option if you would rather serve a default than serve an available managed learn impression that would exceed the maximum % of daily volume for learn.
  • all: The price floor is applied to all bids except managed learn impressions within the maximum % of daily volume for learn.

all

apply_floor_to_direct

Boolean

Removed. Please use floor_application_target instead.

allow_tag_reserve_override

Boolean

If true, allow a reserve price sent in via the ad tag query string to override the existing hard floor. The floor will only be overridden if the tag-supplied reserve price is greater than the floor price.

false

floor_optimization_enabled Boolean If true, soft floors are ignored and floors to move up and and down depending on market conditions, but never allow the amount to go below the hard floor. false

members

array

The members to which the yield management floor should be applied. If left set to NULL, the floor will apply to all members. See Members below for more details.

NULL

brands

array

The brands to which the yield management floor should be applied. See Brands below for more details.

NULL

categories

array

The brands or creative categories to which this yield management floor should be applied. See Categories below for more details.

NULL

allowed_media_types array The media types to which this yield management floor should be applied. See Media Types below for more details. NULL
allowed_media_subtypes array The media subtypes to which this yield management floor should be applied. See See Media Subtypes below for more details. NULL

Members

Field

Type

Description

Default

Required On

id

int

The id of the buyer member (as found in the Platform Member Service) for which the floor should be applied.

POST / PUT

name

string

The name of the buyer member.This field is read-only.

Brands

Field

Type

Description

Default

Required On

id

int

The ID of the brand of the creative (as found in the Brand Service) for which the floor should be applied.

POST / PUT

name

string

The name of the brand. This field is read-only.

Categories

Field

Type

Description

Default

Required On

id

int

The ID of the brand or creative category (as described in the Category Service) to which this floor should be applied.

POST / PUT

name

string

The name of the brand or creative category. This field is read-only.

Media Types

Field

Type

Description

Default

Required On

id

int

The ID of the media type (as described in the Media Type Service) to which this floor should be applied.

POST / PUT

name

string

The name of the media type. This field is read-only.

Media Subtypes

Field

Type

Description

Default

Required On

id

int

The ID of the media subtype (as described in the Media Subtype Service) to which this floor should be applied.

POST / PUT

name

string

The name of the media subtype. This field is read-only.

Examples

View a specific floor
See all floors associated with a Yield Management Profile