API DocsKnowledge BaseSystem StatusContact SupportContact Sales
API Documentation

Create targeting set

post
https://api.kevel.co/v1/forecaster/ad-products//targeting-sets

Create a Targeting Set in a Yield Forecast Ad Product.

Path Params
integer
required

The ad product ID.

Body Params

The JSON object with the targeting set.

A targeting set is an object which contains all the fields in a flight that are relevant and supported in the forecast planner.

string
required

The name of the targeting set.

boolean
required

Whether the targeting set is enabled. Only enabled targeting sets are considered when calculating and displaying results.

integer | null

The ID of the priority. It is required when the targeting set is enabled.

rate
object | null

The rate at which the advertiser pays you. It is required when the targeting set is enabled.

string | null

Please head to Keyword Logic for more details.

frequencyCap
object | null

Configuration for limiting ad frequency to users.

siteZoneTargeting
array of objects | null
siteZoneTargeting
geoTargeting
array of objects | null
geoTargeting
distanceTargeting
array of objects | null
distanceTargeting
string | null

A string for custom targeting using the Zerkel Language.

integer | null
enum

When defined, enables no duplicates and defines the type of the duplicate mode:

  • 1: Flight
  • 2: Campaign
  • 3: Advertiser
  • 4: Creative
Allowed:
adTypes

The ad type IDs to use in forecasts. Required on an enabled targeting set, unless you provide ads. A targeting set that defines its ads directly uses ads instead. The adTypes list and the ads list are mutually exclusive.

searchTerms
array of objects | null

Search term targeting rules. Please head to Search Term Targeting for more details.

searchTerms
bidModifiers
array of objects | null

Bid modifiers to apply to the flight's effective price for matching ad requests.
Please head to Bid Modifiers for more details.

bidModifiers
boolean | null

When true, the ads in ads are treated as companion ads: when one wins a placement, the forecast co-allocates the other ads across the request's remaining placements. Requires a non-empty ads list. When absent or false, the ads entries are forecast as that many separate ads with no co-allocation.

ads
array of objects | null

A fixed list (duplicates allowed) of the flight's ads. The adTypes list and the ads list are mutually exclusive. Each entry becomes a separate ad on the flight, carrying a single ad type. The list holds at most 1000 ads, or 19 when isCompanion is set. Set isCompanion to true to make these ads co-allocate as a companion flight.

ads
Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago