Global Parameters GET

Question 1

nw

Answer 1

Required? Yes. Distributor’s FreeWheel network ID.

Question 2

resp

Answer 2

Required? Yes. Response format. Valid values include:ad: return ad creative directly. This is the default.smrx: SMART XML. FreeWheel proprietary ad response format.xml: same as “smrx”.json: FreeWheel proprietary JSON response format. Structurally the same as SMART XML.vast2: VAST 2.0 format. When use this value, also add crtp=vast2s in the global parameters section.vmap1: VMAP 1.0 format.

Question 3

prof

Answer 3

Required? Yes. Player profile. Specifies which types and formats of ads can be returned in this player environment. It’s pre-configured by FreeWheel.

Question 4

csid

Answer 4

Required? Yes. Custom site section ID. Indicates “where” the video is played.

Question 5

caid

Answer 5

Required? Yes. Custom content video asset ID. Either asid and caid is required for video asset requests. Indicates “what” video is being played.

Question 6

asid

Answer 6

Required? Yes. FreeWheel numeric Asset ID. Either asid and caid is required for video asset requests. Recommend to use caid since it is more human readable.

Question 7

asnw

Answer 7

Required? No. Asset Network ID. If not present will default to nw value.

Question 8

ssnw

Answer 8

Required? No. Site Section Network ID. If not present will default to nw value.

Question 9

vdur

Answer 9

Required? No. Content video duration in seconds. Usually used to match Commercial Break Patterns. It’s recommended to put the actual video duration here, otherwise ad server will use the ingested duration value of the video asset.

Question 10

pvrn

Answer 10

Required? Yes. Page View Random. A random number generated per page view. It is required for forecasting system to work properly. Rule of thumb: when csid changes, generate new pvrn.

Question 11

vprn

Answer 11

Required? Yes. Video Player Random. A random number generated per video instance (re-randomize on a new video play even on the same page). It is required for forecasting to work properly. Rule of thumb: when caid changes, generate new vprn.

Question 12

flag

Answer 12

Required? No. Turn on/off any Capabilities (a.k.a flags) supported by MRM ad server, in the format of “flag=+flag1-flag2+flag3”, “+” means to turn on and “-“ means to turn off. Refer to HTTP GET Ad Request: Capabilities (Flags).

Question 13

metr

Answer 13

Required? No. Default metrics of all ads for this request. It’s a bitmap representing whether this integration supports some pre-defined metrics like clickable, pausable, mutable, etc. For example the first bit of metr value stands for quartile, so if it’s turned on, this request is considered “can report quartiles”, and all impressions from this request will counted against the number of “impressions that CAN report Ads Quartiles” in reporting system. If it is Not an AdManager integration, please make sure to set the metr parameter explicitly in the ad request. A few common seen values of “metr” include: 0: it means the ads can send impressions and click callbacks. 7: the ads can send impressions, 4 quartiles and click callbacks. For backward compatibility reasons, 1 works the same as 7. 1024: the ads can send impressions but can’t send click callbacks. 1031: the ads can send impressions and quartiles, but No click callbacks. For backward compatibility reasons, 1025 works the same as 1031. 1023: the ads can support all IAB metrics including impression, click, mute/unmute, expand/collapse, pause/resume, rewind, accept-invitation, close, minimize. “metr” is a complex part of MRM system. Please don’t hesitate to consult FreeWheel for the proper value to set in your integration.

Question 14

afid

Answer 14

Required? No. Video asset fallback id. A FreeWheel video asset id when the video asset id in ad request is Not recognized. Note this needs to be a “FreeWheel id”, which is all digital. It is Not a custom id.

Question 15

sfid

Answer 15

Required? No. Site section fallback id. A FreeWheel site section id when the site section id in ad request is Not recognized. Note this needs to be a “FreeWheel id”, which is all digital. It is Not a custom id.

Question 16

vip

Answer 16

Required? No*. End user IP address. It’s optional if the request comes directly from end user, as FreeWheel ad server will get the IP address from http request. But if all requests to FreeWheel servers come from some other servers, this parameter is required.

Question 17

vclr

Answer 17

Required? No*. Custom visitor caller. Equivalent to the visitor/@caller attribute in XML request. It’s recommended to pass the app name and version information in this parameter. For example, FreeWheel Flash AS3 AdManager sets it to a string like “AS3-5.11.0-r10315-1312100615”, which is in the format of “[Platform]-[Version]-[Revision]-[Build Timestamp]”.

Question 18

vcid

Answer 18

Required? No. Custom visitor ID. Equivalent to the visitor/@customId attribute in XML request. https://hub.freewheel.tv/pages/viewpage.action?spaceKey=MUG&title=Custom+User+IDs

Question 19

vcid2

Answer 19

Required? No. Replaced by the reserved key _fw_vcid2. The param “vcid2” still works but is Not recommended. https://hub.freewheel.tv/display/MUG/Custom+User+IDs

Question 20

mode

Answer 20

Required? Required for live. Request mode. Valid values are: “on-demand”: default value. “live”: indicates this request is for live mode. Lots of live mode related behaviors will be activated.

Question 21

vdty

Answer 21

Required? Required for live. Video asset duration type. Valid values are: “exact”: if the content video duration is kNown as an exact value. “variable”: if the content video duration is unknown or can change. In live mode this type should be used, and “vrdu” should be used to specify the content video duration this request is to cover.

Question 22

vrdu

Answer 22

Required? Required for live. Video request duration, integer in seconds. This value replaces vdur (video duration) in live mode and is used to indicate the amount of time this ad request is to cover. For example, “this request should return enough ads to cover the next 300 seconds, as that’s how long I’ll be waiting before making another ad request.” If you are requesting ads for one immediate ad break, the request duration only needs to exceed the expected break duration.

Question 23

vtpo

Answer 23

Required? No. Video time position, integer in seconds. This value indicates the current playhead time of the content. Once it is specified, the “tpos” of temporal slots should be equal or greater than this value.

Question 24

cana

Answer 24

Required? No. Specifies candidate ad ids, separated by commas. This will replace any candidate ads. Example: cana=id1,id2,id3,…,idN;