Create RTB Creatives & Ads

Create a new RTB ad. You can create a new creative, or use a pre-existing creative.

For more info on creating Ads & Creatives, refer to our Creative Flight Map Ad Endpoint page. Additional RTB-specific params are below.

Optional Creative RTB Properties

Name

Data Type

Required

Type

RtbCustomFields

JSON data provided by the RTB partner. Note that this is different than the advertiser-level RtbCustomFields. This should also be provided by the RTB provider or your account manager

Y

JSON object in a string

rtbFormat

Setting the rtbFormat in the RtbCustomFields string enables you to choose whether the RTB ad's source is an image or a custom native string that uses Kevel macros to supply ad data

Y

string

RTB Custom Field

Type

Description

Required For Partners

adId

integer

adTemplate

string

auctionType

string

bidPct

integer

Percentage of requests the advertiser bids on. Overrides the advertiser-level bidPct if present.

blockedDomains

string

dealId

string

Enables the ads to serve from a private marketplace.

disableSubdomain

boolean

If true, any subdomains of the referrer URL will NOT be passed to the RTB provider on the request. Defaults to false.

None

floorPrice

integer

imageHeight

integer

imageWidth

integer

matchedUsersOnly

boolean

maxBid

integer

minBid

integer

pubId

integer

pubmaticSiteId

integer

pubName

string

rtbFormat

string

textLength

integer

rtbValue String Value

Description

Image

Requests and responds with an image ad.

Custom Native Format (default)

Requests and responds with a native ad. Custom native ads should also include an adTemplate that uses macros to define the custom template. Refer to the Zemanta example in the curl example to the right:

creative={ 
  "CampaignId":123456, 
  "DistributionType":1, 
  "IsActive":true, 
  "FlightId":12345, 
  "Creative":{"AdTypeId":5}, 
  "RtbCustomFields":"{"something":true}" 
}
curl -X POST -H 'X-Adzerk-ApiKey:<API-KEY>' -H 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'creative={ "CampaignId":12345, "DistributionType":1, "IsActive":true, "FlightId":12345, "Creative":{"AdTypeId":5}, "RtbCustomFields":"{\"rtbFormat\":\"Custom Native Format (default)\",\"adTemplate\":\"URL: {{url}}\\nTITLE: {{title}}\\nIMAGE: {{externalUrl}}`\",\"auctionType\":\"Second Price (default)\",\"floorPrice\":\"0.01\",\"imageWidth\":\"300\",\"imageHeight\":\"250\",\"pubId\":\"12345\",\"pubName\":\"mazda\"}"}' http://api.adzerk.net/v1/flight/12345/creative
curl -H 'X-Adzerk-ApiKey:<API-KEY>' -H 'Content-Type: application/x-www-form-urlencoded' -X POST --data-urlencode 'creative={ "CampaignId":12345, "IsActive":true, "FlightId":123456, "Creative":{"Id": 12345}, "RtbCustomFields": "{\"pubmaticSiteId\":\"12345\",\"adId\":\"12345\",\"floorPrice\":null,\"dealId\":null,\"matchedUsersOnly\":null,\"disableSubdomain\":null,\"page\":null,\"pubmaticAdSlot\":null,\"auctionType\":null}" }' https://api.adzerk.net/v1/flight/123456/creative