Skip to main content

Carrier

A media carrier: a single carrier, a folder of carriers or a joint of carriers. Take ids from GET /api/v2/survey/{surveyCode}/carriers or from a tree query with treeType CARRIERS. How type, ids and insertions are used depends on where the carrier is sent; see each field.

idstring

Identifier of the carrier or folder, as returned by the carriers tree. For a CARRIER_JOINT, an id chosen by the caller for the joint, echoed in the response. Ignored for TOTAL_MEDIA.

labelstring

Display label, in the language of the user. Optional in requests; for TOTAL_MEDIA it sets the label of the aggregate. Always returned in responses.

typeCarrierType (string)

Kind of carrier. In requests: CARRIER (the default when omitted) is one carrier; FOLDER is every carrier of a folder (targetMedia only); CARRIER_JOINT is a joint of the carriers listed in ids; TOTAL_MEDIA is the aggregate of all media (CARRIERS axis only). The meaning depends on the context: in a CARRIERS axis any value other than CARRIER_JOINT and TOTAL_MEDIA is a single carrier; targetMedia reads FOLDER as a folder and flattens a joint into its members, and any other value is a single carrier. Responses can also return TOTAL, MEDIA_PLAN and MEDIA_PLAN_TOTAL; the field is omitted for a kind the API does not describe.

Enum ValueDescription
CARRIEROne carrier (a media vehicle). It is the default when type is omitted.
FOLDEREvery carrier of a folder of the carriers tree. It is read in targetMedia; a CARRIERS axis reads it as a single carrier.
CARRIER_JOINTA joint of the carriers listed in ids, with an id chosen by the caller; in targetMedia it counts as its members.
TOTAL_MEDIAThe aggregate of all the media of the survey. It is sent only in a CARRIERS axis, and its id is ignored.
TOTALThe total of the carriers of a table. Responses only.
MEDIA_PLANOne plan of the table. Responses only.
MEDIA_PLAN_TOTALThe total of the plans of the table. Responses only.

Possible values: [CARRIER, FOLDER, CARRIER_JOINT, TOTAL_MEDIA, TOTAL, MEDIA_PLAN, MEDIA_PLAN_TOTAL]

idsstring[]

Member carrier ids of a CARRIER_JOINT: at least 2, plus a caller-assigned id for the joint, which is echoed back in the response. Ignored for the other types.

insertionsinteger<int32>[]

Insertions of the carrier in a calculated study table (a MEDIA axis): a single value, the insertions of that row in its plan. Ignored in requests.

Carrier
{
"id": "string",
"label": "string",
"type": "CARRIER",
"ids": [
"string"
],
"insertions": [
0
]
}