Slot Parameters GET

Question 1

slid

Answer 1

Required? Yes. Slot custom ID. Any string with valid letters/digits/symbols, must be unique in a request.

Question 2

tpcl

Answer 2

Required? No. Slot Time Position Class. Valid values are: PREROLL MIDROLL POSTROLL OVERLAY DISPLAY PAUSE_MIDROLL If only tpcl is included in ad request, the slot will be generated with standard ad unit. If tpcl and slau are present in the request, the slau value will override the tpcl value.

Question 3

tpos

Answer 3

Required? Required for temporal slots. Slot time position in seconds.

Question 4

ptgt

Answer 4

Required? Yes. Type of slot. This is a required parameter. ptgt=a: temporal slot ptgt=s: site section non-temporal slot ptgt=p: video player non-temporal slot

Question 5

maxd

Answer 5

Required? No. Slot max duration in seconds.

Question 6

w

Answer 6

Required? Required for display slots. Slot width in pixel.

Question 7

h

Answer 7

Required? Required for display slots. Slot height in pixel.

Question 8

slau

Answer 8

Required? Required, if “tpcl” isn’t specified. Specify custom ad unit names for this slot. Multiple ad unit names can be put into this parameter, separated by “|”. Ad unit group names are also supported but you can only specify one ad unit group; multiple ad unit groups or mixed ad unit group and ad unit names are not supported. If only slau is included in ad request, the slot will be generated with specified ad unit. If slau is assigned with any of the following invalid values, the slot will be generated with standard ad unit: preroll midroll postroll overlay If slau is assigned with any other invalid value, the slot can NOT be generated. If both tpcl and slau are included, the slau value will override the tpcl value.

Question 9

cd

Answer 9

Required? No. Compatible Dimensions. Besides the primary dimension of a slot specified by “w” and “h”, you can use “cd” to specify multiple additional compatible dimensions of ad units that a slot can accept. The syntax is “cd=[width1],[height1]|[width2],[height2]|…”. For example, if a 300x250 slot can also accept 300x200 and 300x60 ads, you can set the “cd” parameter as “cd=300,200|300,60”.

Question 10

envp

Answer 10

Required? No. Rarely used except for Linktag2. Profile for this slot. It can override the configuration in “prof” on this slot level, and should not be used unless being instructed by the FreeWheel solutions team. “prof” should be preferred in most cases.

Question 11

cpsq

Answer 11

Required? Optional for midroll slots depending on NW setting. Specifies which cue point within a CBP should be used to determine ad restrictions: cpsq=[cue_point_number] If network turns on the network function to allow MRM to infer cue point sequence if not set in request, it could be omitted, Otherwise, this parameter is required. The max value of cpsq is 2147483647.

Question 12

mind

Answer 12

Required? Required in live. The minimum duration of a slot, in seconds: mind=[minimum_duration]. maxd and mind are usually set as the same value. mind allows ad server to ignore certain UI restrictions to more aggressively fill an ad break in a live scenario, where there may not be an option to return to content early.

Question 13

prct

Answer 13

Required? No. Primary content type. It is used to override profile supported content types for a specific slot. This will also mean that the profiles supported content types will be ignored and only looked at the content types specified in this flag for that slot. If a profile doesn’t support some specific content types, you can use this parameter to add them. Please use comma to separate multiple content types. For example: prct=content_type1,content_type2,content_type3 Note that all content types that need to be rendered on slots with prct enabled must be listed.