Placement Body Parameters

Every request must contain one or more Placements. Each placement represents a "slot" in which an ad may be served.

Body Params
string

A unique name for the placement defined by you

int32

The numeric network id

int32
required

The numeric site id

adTypes
array of int32s
required

One or more integer ad types. More info here

adTypes*
zoneIds
array of int32s

Zone IDs to use

zoneIds
int32

An advertiser ID; if specified, only serve that advertiser if possible

int32

A numeric campaign id; if specified, only consider ads in that campaign

int32

A flight ID; if specified, only serve that flight if possible

int32

A numeric ad (flight-creative map) ID; if specified, only serve that ad if possible

string

The ad's click-through URL

properties
object

A map of key/value pairs used for Custom Targeting

eventIds
array of int32s

An array of numeric event types. Requests tracking URLs for custom events. See here for Event Tracking IDs

eventIds
contentKeys
object

A map of key/value pairs used with ContentDB. The format is "contentKeys": {"schema": "contentKey"}.

int32

The number of ads to return per placement. Integer between 1 and 20

boolean
Defaults to false

If true, fills ads in a multi-winner placement in proportion to the flight's goals

ecpmPartitions
array of strings

(BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions

ecpmPartitions
boolean
Defaults to false

(BETA) If true, returns all candidate ads for the placement instead of making a selection, bypassing weighting. Will not skip floor pricing settings in an auction, but you can override those via floorPrice and floorCpc.

skipFilters
object

Specifies which filters to bypass during the selection process. For example, given "skipFilters":{"keyword":true}, keyword targeting is ignored. Options: geodistance, geolocation, keyword, placementLimit, facet, siteZone

int32
Defaults to 1

Multiples the count of all events returned in the selection. For example, an impression with an eventMultiplier of 10 will count as 10 impressions in reporting.

float

Sets a floor price to use if the selection results in an auction. Overrides any floor price set on the priority. Should be expressed as an eCPM value.

float

Sets a floor CPC to use if the selection results in an auction. Overrides any floor CPC set on the priority.

json

Similar to eventIds, but instead of returning event pixels in the response, pushes event pixles into data shipping logs

relevancy
object

See the relevancy score documentation for data type examples

adQuery
object

See AdQuery for details and example usage.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json