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.

API Request Fields

Field	Type	Description
Title	string	The advertiser name (required)
IsActive	boolean	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.
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.
IsDeleted	boolean	Whether advertiser is deleted. Defaults to `false`
CatalogAccess	array of objects	Define the scope of Catalog items that pertain to an Advertiser.
Segments	array of objects	Segments that the advertiser should be able to access when configuring user segment targeting in Kevel Console.

Example Request

curl -X POST -H 'X-Adzerk-ApiKey:<APIKEY>' -H "Content-Type:application/json" https://api.kevel.co/v1/advertiser --data-binary '{"Title":"Nike","IsDeleted":false,"IsActive":true}'

Example Response

{
  "IsActive": true,
  "DailyCapAmount": null,
  "FreqCapType": 0,
  "Title": "Nike",
  "CapType": null,
  "IsFreqCap": false,
  "IsDeleted": false,
  "RtbCustomFields": null,
  "LifetimeCapAmount": null,
  "FreqCapDuration": null,
  "PlacementLimit": null,
  "FreqCap": null,
  "ExternalId": null,
  "PartnerId": null,
  "CatalogAccess":[
    {
      "ProductQuery":[
        [ ["one-of", "kevel/brand-id"], [12345, 12346]],
        [ "kevel/merchant-id", 12347 ]
      ],
      "CatalogId":101
    }
  ],
  "Id": 12345
}