Sign in

v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Create Ads

post/v1/flight/{FlightID}/creative

Path parameters

FlightIDinteger required

The ID of the Flight

Request body

IsActiveboolean

Whether ad should be eligible to serve. Defaults to false

RtbCustomFieldsstring

Required for RTB ads only. JSON Object in a String. It's JSON data provided by the RTB partner. Certain parameters in the object will be required per partner. If you aren't sure what is required, your account manager will supply you with the data for this property

ActiveKeywordsstring[]

For Keyword Targeting. Instructions here

CustomTargetingstring

Zerkel string for Custom targeting. Instructions here. The maximum string length for CustomTargeting is 1000 characters.

SiteIdinteger

Site ID for Site Specific targeting

ZoneIdinteger

Zone ID for Zone Specific targeting

IsDeletedboolean

Whether it should be deleted

Iframeboolean

Whether Creative should use iFrame

SizeOverrideboolean

Whether size needs to be overridden. Defaults to false

IsStartEndDateOverrideboolean

Whether you are overriding the start and end date

StartDateISOstring

The start date for this ad in ISO 8601 format

EndDateISOstring

The end date for this ad in ISO 8601 format

IsGoalOverrideboolean

Whether you are overriding the goal on the ad

GoalTypeinteger

If you are overriding the flight's goal, sets the target goal metric for ad. Key follows: 1 = Impressions 2 = Percentage 3 = Click 7 = Any Conversions 8 = Lifetime Revenue (integer) 9 = Daily Revenue (integer) 10 = Monthly Revenue (integer)

Goalinteger

The Goal Amount of GoalType

Pricenumber float

The Price value - instructions here

Response

200

IsActiveboolean
DontAffectParentFreqCapboolean
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:FreqCapType","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:EndDate","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:Iframe","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:ZoneId","oasType":"schema","type":"unknown"}
PublisherAccountIdinteger
IsDeletedboolean
CustomTargetingstring
EndDateISOstring
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:RtbCustomFields","oasType":"schema","type":"unknown"}
Impressionsinteger
GoalTypeinteger
Goalinteger
Priceinteger
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:FreqCapDuration","oasType":"schema","type":"unknown"}
Percentageinteger
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:FreqCap","oasType":"schema","type":"unknown"}
IsStartEndDateOverrideboolean
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:CustomRelevancyScore","oasType":"schema","type":"unknown"}
FlightIdinteger
ActiveKeywordsstring[]
{"stackTrail":"paths:/v1/flight/{FlightID}/creative:post:responses:200:content:application/json:schema:properties:SiteId","oasType":"schema","type":"unknown"}
CampaignIdinteger
Idinteger
IsGoalOverrideboolean
StartDateISOstring

Example response

{
  "IsActive": true,
  "Creative": {
    "IsActive": true,
    "Title": "Adzerk Creative",
    "Url": "http://adzerk.com",
    "ImageLink": "http://s.zkcdn.net/Advertisers/",
    "AdvertiserId": 123,
    "AdTypeId": 5,
    "Id": 12345
  },
  "CustomTargeting": "$keywords contains \"dean\"",
  "EndDateISO": "2017-12-05T12:00:00.0000000",
  "Impressions": 100,
  "GoalType": 1,
  "Goal": 200000,
  "Price": 1,
  "IsStartEndDateOverride": true,
  "FlightId": 7290072,
  "ActiveKeywords": [
    "kittens"
  ],
  "CampaignId": 123,
  "Id": 12345,
  "IsGoalOverride": true,
  "StartDateISO": "2017-05-01T12:00:00.0000000"
}