v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Create Campaigns

post/v1/campaign

Request body

AdvertiserIdinteger required

The advertiser's ID for the campaign.

Namestring required

The campaign name.

Flightsinteger[]

You can pass an array of flights, a blank array, or not include. See Create Flight endpoint.

IsActiveboolean

Specifies whether campaign should be active (serving ads). Defaults to false.

IsDeletedboolean

Specifies whether campaign should be deleted. Do not use when creating a campaign.

IsArchivedboolean

Specifies whether campaign should be archived. Do not use when creating a campaign.

FreqCapinteger

The number of times the frequency cap should occur.

FreqCapDurationinteger

Specifies how often the frequency cap should occur.

FreqCapTypeinteger

The enum value for how often frequency capping should occur. 1 = Hour 2 = Day 3 = Minute.

DontAffectParentFreqCapboolean

"Opts-out" campaign from advertiser-level frequency cap settings.

CapTypeinteger

Set to CapType = 4. Campaigns can only budget cap on revenue metric. Do not set to 0 - if removing, set to null.

DailyCapAmountinteger

The max daily revenue.

LifetimeCapAmountinteger

The max lifetime revenue.

Response

200

IsActiveboolean

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:DontAffectParentFreqCap","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:DailyCapAmount","oasType":"schema","type":"unknown"}

FreqCapTypeinteger

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:EndDate","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:CapType","oasType":"schema","type":"unknown"}

IsFreqCapboolean

IsDeletedboolean

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:EndDateISO","oasType":"schema","type":"unknown"}

Priceinteger

IsArchivedboolean

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:LifetimeCapAmount","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:FreqCapDuration","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:FreqCap","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:SalespersonId","oasType":"schema","type":"unknown"}

AdvertiserIdinteger

Namestring

Idinteger

{"stackTrail":"paths:/v1/campaign:post:responses:200:content:application/json:schema:properties:CustomFieldsJson","oasType":"schema","type":"unknown"}

StartDateISOstring

Example response

{
  "AdvertiserId": 12345,
  "Name": "Nike Q4 Campaign",
  "Id": 123456,
  "StartDateISO": "2017-01-01T00:00:00.0000000"
}