Placement Body Parameters

divName

string

A unique name for the placement defined by you

networkid

int32

The numeric network id

siteid

int32

required

The numeric site id

adTypes

array of int32s

required

One or more integer ad types. More info here

zoneIds

array of int32s

Zone IDs to use

advertiserId

int32

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

campaignId

int32

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

flightId

int32

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

adId

int32

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

clickUrl

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

contentKeys

object

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

count

int32

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

proportionality

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

skipSelection

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.

eventMultiplier

int32

Defaults to 1. Multiples the count of all events returned in the selection.

floorPrice

float

Sets a floor price to use if the selection results in an auction.

floorCpc

float

Sets a floor CPC to use if the selection results in an auction.

logEvents

json

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

relevancy

object

See the relevancy score documentation for data type examples

adQuery

object

See AdQuery for details and example usage.

Example Request

curl --request POST \
     --url https://e-your-networkid.adzerk.net/part-of-decision/api \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "properties": {
    "age": 29,
    "segment_membership": "PRC"
  },
  "contentKeys": {
    "audience": "B2B",
    "businesses": "sportingGoods"
  },
  "proportionality": false,
  "skipSelection": false,
  "skipFilters": {
    "keyword": false
  },
  "eventMultiplier": 1
}'

Example Response

{
  "user": {
    "key": "abc"
  },
  "decisions": {
    "div0": {
      "adId": 111,
      "creativeId": 222,
      "flightId": 333,
      "campaignId": 444,
      "priorityId": 555,
      "clickUrl": "https://e-23.adzerk.net/r?...",
      "contents": [
        {
          "type": "html",
          "body": "<a href='...'><img src='https://static.adzerk.net/Advertisers/cat.jpg' title='ZOMG A CAT' width='350' height='350'></a>",
          "template": "image",
          "data": {
            "imageUrl": "https://static.adzerk.net/cat.jpg",
            "title": "ZOMG A CAT",
            "width": 350,
            "height": 350,
            "customData": {
              "headline": "Test Headline",
              "cta": "Download Here"
            }
          }
        }
      ],
      "impressionUrl": "https://e-23.adzerk.net/i.gif?...",
      "events": [
        {
          "id": 10,
          "url": "https://e-23.adzerk.net/e.gif?..."
        },
        {
          "id": 11,
          "url": "https://e-23.adzerk.net/e.gif?..."
        },
        {
          "id": 14,
          "url": "https://e-23.adzerk.net/e.gif?..."
        }
      ],
      "pricing": {
        "price": 5,
        "clearPrice": 2.01,
        "revenue": 0.002,
        "rateType": 2,
        "eCPM": 5
      }
    }
  },
  "candidateRetrieval": {
    "div0": {
      "candidatesFoundCount": 1
    }
  }
}