Skip to main content

RankingCarrier

A carrier, or a folder of carriers, sent to a ranking, an evaluation, a saved evaluation or a response curve, with its insertions per plan and, optionally, its net price per insertion. Take ids from GET /api/v2/survey/{surveyCode}/carriers or from a tree query with treeType CARRIERS.

idstring

Identifier of the carrier or folder, as returned by the carriers listing.

labelstring

Display label. Optional: the result labels each row in the language of the user.

typeRankingCarrierType (string)

Kind of carrier. CARRIER (the default when omitted) is one carrier. Any other value, FOLDER included, is read as a folder: every carrier of that folder of the carriers tree, and its insertions are ignored. A joint of carriers is not supported by these operations: it is read as a folder. Values are case-sensitive.

Enum ValueDescription
CARRIEROne carrier (a media vehicle). It is the default when type is omitted and the only kind that reads insertions.
FOLDEREvery carrier of a folder of the carriers tree, kept as a grouping row. Its insertions are ignored.

Possible values: [CARRIER, FOLDER]

pathstring

Folder path of the carrier in the carriers tree. Optional. Responses do not return it.

insertionsinteger<int32>[]

Insertions of the carrier, one value per plan: position 0 is plan 1, position 1 is plan 2, and so on. A ranking adds one plan column per position; an evaluation and a response curve measure the plans. In a response curve it is required and non-empty, otherwise 400 AE_ERR_400. Ignored for a folder.

pricenumber<double>

Net price of one insertion of the carrier, in the currency of the survey. Optional. It replaces the price configured for this carrier, as the price of an optimization candidate does, and every cost statistic is calculated with it: the list price ones (PRICE, CPM_CONT, CGRP...) and the discounted ones (DISCOUNT_PRICE, DISCOUNT_CPM_CONT...). One price per carrier: it applies to every plan. 0 is a cost of zero (in an optimization it counts as no price). Without it, the configured price is used. A negative price, or a price on a folder, is rejected with 400 AE_ERR_400. A response curve accepts it, but its figures do not change: the curve returns no cost statistic.

Possible values: >= 0

RankingCarrier
{
"id": "string",
"label": "string",
"type": "CARRIER",
"path": "string",
"insertions": [
0
],
"price": 0
}