Skip to main content

OptimizationCandidateCarrier

A candidate carrier with its optional insertion constraints.

idstringrequired

Carrier identifier: the id of an item of type CARRIER from GET /api/v2/survey/{surveyCode}/carriers.

minInsertionsinteger<int32>

Minimum insertions of this carrier in the plan. Default 0.

Default value: 0
maxInsertionsinteger<int32>

Maximum insertions of this carrier in the plan. It must not be lower than minInsertions. Default: no limit.

stepinteger<int32>

Insertions added each time the engine selects this carrier. It must be greater than 0. Default 1.

Default value: 1
mandatoryboolean

When true, the carrier receives at least one insertion. Default false.

Default value: false
pricenumber<double>

Net price per insertion. It replaces the price configured in the workspace for this carrier; 0 counts as no price.

OptimizationCandidateCarrier
{
"id": "string",
"minInsertions": 0,
"maxInsertions": 0,
"step": 1,
"mandatory": false,
"price": 0
}