FreeWheel Ad Parameters
Use the following parameters to configure FreeWheel ads in Player V4 using the FreeWheel Ad Plugin. See Integrating FreeWheel Ads for details.
Note: These
parameters are specific to FreeWheel ads. You can also set global parameters for FreeWheel
ads. See Configuring Ad Parameters for
details.
| Name | Description | Type | Required? |
|---|---|---|---|
| freewheel-ads-manager | Parent parameter for FreeWheel ads embedded parameters. | Yes | |
| bitrateOverride | Specifies the initial bitrate (user bandwidth, in kbps) for Freewheel ads. If
Freewheel ads are playing in low quality, set this to override the initial bitrate
selected by Freewheel for rendering ads. See Freewheel's PARAMETER_DESIRED_BITRATE
setting.
"freewheel-ads-manager":
{"bitrateOverride":20000}
|
number (in kbps) | No |
| html5_ad_server | Location from which the player will request ads. The value assigned to this key must be HTTP. This is a HTML5 player-specific override, used when the site is loaded over HTTP. | string | Yes |
| html5_ssl_ad_server | Location from which the player will request ads. The value assigned to this key must be HTTPS. This is a HTML5 player-specific override, used when the site is loaded over HTTPS. | string | yes |
| fw_ad_module_js | Location from which the player will load the FreeWheel AdManager.js. The value assigned to this key must be HTTP. This is a HTML5 player-specific override, used when the site is loaded over HTTP. | string | yes |
| fw_mrm_network_id | Unique identifier assigned by FreeWheel that identifies a company. Clients are assigned their own Network ID during integration, and the player passes this value to the AdManager before making an ad request. | string | yes |
| fw_player_profile | Set of configurations that define what ads will be playable given the player environment and framework. For example, profiles ensure that the Ad Server does not try to return Silverlight ads for a Flash player. This is set up in the back end during integration, and the correct profile for the player to set will be provided by FreeWheel. | string | yes |
| fw_site_section_id | Site section tag is a string that identifies the site section, similar to the custom video ID for a video asset. This is the site section tag as specified by you in the Network Module. While the player does not directly interact with BVI, this is the system by which the Custom Asset ID that it will supply is entered into the FreeWheel system. Consequently, the player will need access to at least some of the same CMS information so it can provide this identifier. | string | yes |
| fw_site_section_id_type | Type of Site Section ID. | string | yes |
| fw_site_section_network_id | Unique identifier of site section network to segment ad retrieval. | string | yes |
| fw_tracking_pixel_url | URL for tracking pixels to monitor the delivery of your ad assets. | string | yes |
| fw_video_asset_id | Piece of content a user is viewing. The player will need to identify the asset to the AdManager for targeting purposes, using the custom asset ID provided via FreeWheel’s Bulk Video Ingestion (BVI). This field can be set on the page-level or by movie metadata (configured via Backlot UI or Backlot APIs). If neither are set, the value for this field will fall back to an external ID or an embed code (whichever is used to embed our player). | string | yes |