Create Flight

Name

string

required

The flight name. Max length is 300 characters.

StartDateISO

string

required

UTC start date in ISO 8601 format: YYYY-MM-DDTHH:MM:SS.SSSSSSS. This can also be sent in the format of YYYY-MM-DD.

CampaignId

int32

required

The ID of the campaign.

PriorityId

int32

required

The ID of the Priority. Here are the Priority API endpoints.

GoalType

int32

required

This is the metric that Kevel uses to pace the ads so it hits the desired goal by the end date. Key follows: 1 = Impressions 2 = Percentage 3 = Click 7 = Conversion 8 = Revenue 9 = Daily Revenue 10 = Monthly Revenue. Instructions are here

Impressions

int32

required

The goal amount - specifies the number of GoalTypes to aim for during the life of the campaign. For Revenue, Daily Revenue and Monthly Revenue Goal Types the maximum Goal Amount is 500000000. For all other GoalTypes the maximum Goal Amount is 2147483647. Instructions are here. Note: the field is named Impressions even if Goal Type is not set to Impressions.

IsActive

boolean

required

Defaults to false

Specifies whether campaigns should be active or inactive. Defaults to false.

RateType

int32

required

The Rate value - instructions here. Key: 1 = Flat 2 = CPM 3 = CPC 4 = CPA View 5 = CPA Click 6 = CPA View & Click.

EndDateISO

string

UTC end date in ISO 8601 format: ``YYYY-MM-DDTHH:MM:SS.SSSSSSS. You can also send in a standard date of YYYY-MM-DD. **Required** if GoalTypeis not2, 9or10`.

IsDeleted

boolean

Defaults to false

Specifies whether flight should be deleted. Do not use when creating a flight. Defaults to false.

Price

float

The Price value - instructions here.

CapType

int32

The cap type metric. Instructions here. Key: 1 = Impressions 2 = Clicks 3 = Conversions 4 = Revenue. Do not set to 0 - if removing, set to null.

DailyCapAmount

int32

The maximum # of CapType per day. Instructions here.

LifetimeCapAmount

int32

The maximum # of CapType per lifetime. Instructions here.

Keywords

string

Keywords used for targeting. Instructions here.

CustomTargeting

string

Zerkel string for Custom targeting. Instructions here. The maximum string length for CustomTargeting is 1000 characters.

CustomFieldsJSON

string

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

IsFreqCap

boolean

Set to true if doing capping. If false or null, then the other Freq fields are ignored. Learn more about FC here. If not already enabled, you'll need your account manager to enable it.

FreqCap

int32

The number of times the frequency cap should occur. Cannot be 0 unless FreqCapType is None (0).

FreqCapDuration

int32

Specifies how often the frequency cap should occur. Cannot be 0 unless FreqCapType is None (0).

FreqCapType

int32

Specifies which unit of time you would like frequency capping to occur. Key: 1 = Hour 2 = Day 3 = Minute.

DontAffectParentFreqCap

boolean

If true, opts-it out of frequency cap settings imposed at advertiser or campaign level.

IsCompanion

boolean

If true, enables companion ads. IsCompanion must be set to false when IsNoDuplicates is true, and vice versa. Learn more here.

isNoDuplicates

boolean

If true, enables no duplicates. IsCompanion must be set to false when IsNoDuplicates is true, and vice versa.

DuplicateMode

int32

Indicates which level no duplicates should be enforced on. Key follows: 1: Flight 2: Campaign 3: Advertiser 4: Creative.

DeliveryStatus

int32

Read-only. Status of the flight. The mapping of the status against the UI are in brackets. Key: 0 = Pending (blue) 1 = Healthy (green) 2 = BorderLine (amber) 3 = InDanger (red) 5 = Underdelivered (amber).

IsTrackingConversions

boolean

If true, enables conversion tracking endpoints/pixels.

CanPassback

boolean

Sets whether a flight in an adChained-enabled priority can pass back to the next flight in the adChain.

PassbackSortOrder

int32

Sets the order of a flight in the adChain. PassbackSortOrder is a transient value that can be modified by internal processes in the UI. Although the value may change, the actual sort order of flights in the adChain will remain consistent. Setting two flights to the same PassbackSortOrder will cause the flights to be chosen randomly. Setting PassbackSortOrder to 0 will cause the flight to appear as "--" in the UI, but the flight will still be part of the adChain. This is not recommended.

IsECPMOptimized

boolean

Specifies whether ECPM Optimization is enabled.

ECPMOptimizePeriod

int32

Timeframe to optimize for [1 - 90 days].

ECPMMultiplier

float

The final eCPM will be multiplied by this amount. Must be at least 0.01.

FloorECPM

float

Minimum eCPM. Must be at least 0.01.

CeilingECPM

float

Maximum eCPM. Must be at least 0.01.

DefaultECPM

float

This is the eCPM that will be used while the Flight is in burn-in mode. Must be at least 0.01.

ECPMBurnInImpressions

int32

Impressions per creative to show before using the calculated eCPM over the default eCPM [1 - 2147483648].

EffectiveCPMOverride

float

Sets a manual override to a flight's CPM, e.g. so a Flat Rate flight can compete in an auction priority.

DatePartingStartTimeISO

string

Defaults to Null

Targets the flight to certain hours within a day. Use ISO 8601 format: HH:MM:SS. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

DatePartingEndTimeISO

string

Defaults to Null

Targets the flight to certain hours within a day. Use ISO 8601 format: HH:MM:SS. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsSunday

boolean

Defaults to false

If true, targets this day. Defaults to false if you have filled in the DateParting fields. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsMonday

boolean

Defaults to false

If true, targets this day. Defaults to false if you have filled in the DateParting fields. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsTuesday

boolean

Defaults to false

If true, targets this day. Defaults to false if you have filled in the DateParting fields. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsWednesday

boolean

Defaults to false

If true, targets this day. Defaults to false if you have filled in the DateParting fields. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsThursday

boolean

Defaults to false

If true, targets this day. Defaults to false if you have filled in the DateParting fields. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsFriday

boolean

Defaults to false

If true, targets this day. Defaults to false if you have filled in the DateParting fields. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsSaturday

boolean

Defaults to false

If true, targets this day. Defaults to false if you have filled in the DateParting fields. (This parameter is part of Kevel's legacy day parting features. It is still supported, but will be ignored if a Flight has one or more new day parts. Learn more about new day parting features here and about legacy day parts here.)

IsArchived

boolean

Defaults to false

Specifies whether flight is archived.

RequireStrictLocation

boolean

Defaults to false

If true, the ad request needs exact longitude and latitude in order to use GeoDistance targeting settings.

TimeZone

string

Defaults to "UTC"

Sets a supported IANA time zone string to be used for the flight's daily caps, daily goals, and day parting. Note that even if a non-UTC TimeZone is set, start and end dates will still be in UTC.

IsTargetingOptimization

boolean

Legacy parameter

TargetingOptimizationType

int32

Legacy parameter

TargetingOptimizationTargetType

int32

Legacy parameter

TargetingOptimizationTarget

float

Legacy parameter

TargetingOptimizationBurnIn

int32

Legacy parameter

TargetingOptimizationCanMiss

boolean

Legacy parameter

TargetROAS

float

Defaults to null

For CPC/CPA/CPM auctions, a target return can be selected on ad spend (ROAS) goal and the decision engine will automatically adjust the CPC/CPA/CPM bid to try to achieve the goal set. Acceptable values are expressed as a decimal between 0.01–99.99. This is equivalent to 1%–9,999%.

200200