Create Advertisers

post

https://api.kevel.co/v1/advertiser/

Body Params

Title

string

required

The advertiser name

IsActive

boolean

required

Defaults to false

Whether advertiser is running. Always set to true when creating. Defaults to false.

PlacementLimit

int32

How many placements the advertiser's ads can fill per request

FreqCap

int32

The number of times that you would like the frequency cap to occur. Set-up instructions here

FreqCapDuration

int32

How often the frequency cap should occur. Set-up instructions here

FreqCapType

int32

The unit of time you would like frequency capping to occur. Key follows: 1 = Hour 2 = Day 3 = Minute. Set-up instructions here

CapType

int32

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

DailyCapAmount

int32

The max daily revenue

LifetimeCapAmount

int32

The max lifetime revenue

CustomFieldsJson

string

Sets the value of custom fields based on a custom fields schema. Must contact support before use. More info here.

RtbCustomFields

string

Required for RTB enabled advertisers 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.

ExternalId

string

Used to reference an ID from another external system

PartnerId

int32

Required for RTB enabled advertisers only. The ID of the RTB Partner. If you aren't sure what is required, your account manager will supply you with the data for this property.

IsDeleted

boolean

Defaults to false

Whether advertiser is deleted. Defaults to false

CatalogAccess

array of objects

Define the scope of Catalog items that pertain to an Advertiser.

CatalogAccess

Segments

array of objects

Segments that the advertiser should be able to access when configuring user segment targeting in Kevel Console. These settings do not effect campaigns managed directly through the Ad Server.

Segments

Response

Language

Credentials

Header

Request

Response

Choose an example:

application/json

200200