Create Advertisers

Why Create Advertisers?

When you are setting up a campaign with flights, it is important to also create advertisers for the creatives that will be part of the campaign. Examples of advertisers may be Nike, GM, Ford, etc., and by creating advertisers that are attached to creatives, it makes it easier for you to make changes to campaigns and flights by enabling you to search by advertiser instead of creative or flight. This API endpoint enables you to create a new advertiser.

For more information on how to create an advertiser, please refer to the Creating an Advertiser technical documentation.

📘

Note

When creating an Advertiser, always set IsDeleted = False and IsActive = True

API Syntax

When using the Create Advertisers API endpoint, it is important to understand the syntax required to make the request. Because the Kevel API is a RESTful API, there is a specific request format that must be followed to ensure the endpoint can process the request. The format is:

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

Where:

  • POST - the type of API request being made.
  • <https://api.kevel.co> - the URL for the request.
  • v1 - the API version.
  • advertisers - the API endpoint being called.
Body Params
string
required

The advertiser name

boolean
required
Defaults to false

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

int32

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

int32

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

int32

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

int32

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

int32

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

int32

The max daily revenue

int32

The max lifetime revenue

string

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

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.

string

Used to reference an ID from another external system

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.

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
LoadingLoading…
Response
Choose an example:
application/json