KEkevel

Placement Body Parameters

Changed on

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

post/part-of-decision/api

Request

  • Base URL
    https://e-YOUR-NETWORKID.adzerk.net
  • URL
    https://e-YOUR-NETWORKID.adzerk.net/part-of-decision/api
  • Auth
    none required

Request body

divNamestring

A unique name for the placement defined by you

networkidinteger

The numeric network id

siteidinteger required

The numeric site id

adTypesinteger[] required

One or more integer ad types. More info here

zoneIdsinteger[]

Zone IDs to use

advertiserIdinteger

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

campaignIdinteger

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

flightIdinteger

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

adIdinteger

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

clickUrlstring

The ad's click-through URL

eventIdsinteger[]

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

overridesobject

An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding

countinteger

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

proportionalityboolean

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

ecpmPartitionsstring[]

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

skipSelectionboolean

(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.

eventMultiplierinteger

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.

floorPricenumber 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.

floorCpcnumber float

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

logEventsstring json

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

Response

200

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?..."
        }
      ],
      "pricing": {
        "price": 5,
        "clearPrice": 2.01,
        "revenue": 0.002,
        "rateType": 2,
        "eCPM": 5
      }
    }
  },
  "candidateRetrieval": {
    "div0": {
      "candidatesFoundCount": 1
    }
  }
}

Changes