FreeWheel

Defines the base URL to the desired FreeWheel ad decision server.

Example:

A default value for this parameter may be defined from within the CMS. Take advantage of this functionality to avoid exposing your FreeWheel custom ID.
Learn how to set a default value for this parameter.

This parameter takes precedence over the Customer ID parameter (ad.customer_id).

Defines a description for the playback location.

Example:

Learn how to set a default value for this parameter.

This parameter takes precedence over the Custom Site Section ID parameter (ad.csid).

Sets the distributor’s FreeWheel network ID (adRequest@networkId).

Example:

Learn how to set a default value for this parameter.

Sets the player's profile (adRequest@profile).

Example:

Learn how to set a default value for this parameter.

Sets the maximum number of pre-rolls ad units that may be returned by the ad server.

Sets the minimum duration, in seconds, for pre-roll ad units within a live stream. This duration is only used when the duration of the ad unit is unknown.

This parameter only supports integers.

Example:

Sets the maximum duration, in seconds, for pre-roll ad units within a live stream.

This parameter only supports integers.

Example:

Sets the duration, in seconds, of a live stream's pre-roll ad unit.

Example:

Defines a default duration. This duration is only applicable for ad breaks without an explicitly defined duration.

Default Value:

Example:

Sets the minimum duration, in seconds, for mid-roll ad units within a live stream. This duration is only used when the duration of the ad unit is unknown.

This parameter only supports integers.

Example:

Default Value:

The default minimum duration is set by the Duration parameter (ad.rdur). If it is not set, then the default duration is determined by the duration passed to the Live Slicer.

Sets the maximum duration, in seconds, for mid-roll ad units within a live stream.

This parameter only supports integers.

Example:

Default Value:

By default, the maximum duration is the duration passed to the Live Slicer.

Sets ad unit duration for on-demand content to the duration defined when the source live stream was sliced. Set this parameter to 1.

Example:

Overrides the default request mode (adRequest@mode) for ad units. Valid values are:

View Live Streaming syntax.

Syntax:

ad.mode=[Pre-Roll Ad Units],[Mid-Roll Ad Units]

If this parameter only defines a single mode, then that mode will be applied to all ad units.

Default Value:

live

Example:

ad.mode=ondemand,live

View On-Demand Streaming syntax.

Syntax:

ad.mode=[All Ad Units]

Default Value:

ondemand

Example:

ad.mode=live

Learn how to set a default value for this parameter.

Enables one or more flag(s) that define the player's capabilities.

This value should be URL encoded.

The set of flags that will be enabled varies by syntax.

• Append Flags: Enable specific flags along with the default set of flags by setting this parameter to the desired set of flags.

  Example:

  ad.flags=+play+sync

• Specified Flags Only: Only enable specific flags by setting this parameter to a colon followed by the desired set of flags.

  Example:

  ad.flags=:+amcb

  The Advanced Callbacks parameter (ad.ametr) determines whether FreeWheel will use impressions with advanced callbacks instead of quartile callbacks. If you choose to only enable specific flags, then the Advanced Callbacks parameter will only work when you include the Advanced Callbacks flag (amcb).

  The plus symbol (+) in the above examples represent URL-encoded spaces.

Please refer to FreeWheel's documentation for more information (e.g., valid flag combinations).

Default Value:

Removes supportsSlotTemplate from the pre-roll ad request. The supportsSlotTemplate sub-element allows the Freewheel ad server to generate slots and deliver ads according to the Commercial Break Pattern settings.

Allows FreeWheel to use impressions with advanced callbacks. Set this flag to 1.

FreeWheel may not be configured to use impressions with both advanced and quartile callbacks.

By default, the Flags parameter includes the Requires Quartile Callback URLs flag (qtcb). Override the default value to enable the Advanced Callback flag instead of the Requires Quartile Callback URLs flag.

Example:

Activates FreeWheel’s HyLDA feature. Set this flag to 1.

Use this flag with the Acid flag.

Upon enabling these flags, the system will automatically generate: aiid, abid, and abwct.

Example:

Adds Acid as a value in the HyLDA keyword.

This parameter is only applicable when the HyLDA flag has been enabled.

Example:

Defines the default capabilities for all ads. Set this parameter to an integer that maps bits to capabilities.

Please refer to FreeWheel's documentation on the metr parameter for more information.

Example:

Default Value:

Adds a video asset network ID (videoAsset@videoAssetNetworkId) to the FreeWheel GET ad request.

Learn how to set a default value for this parameter.

Example:

Sets the custom asset ID (videoAsset@customId) that will be included with the FreeWheel GET ad request.

Syntax:

• @[Key-Value-Name]: Sends the value assigned to an asset's key-value pair to FreeWheel.

  Example:

  ad.caid=@custom_id

• $[Field-Name]: Sends the value defined within an asset's metadata field to FreeWheel.

  Example:

  ad.caid=$my_custom_id_field

• Custom Value: Sends a custom value to FreeWheel.

  Example:

  ad.caid=Asset123456

Default Value:

By default, the custom asset ID sent to FreeWheel is determined by the first available value from the following list:

1. The external ID defined in the asset's metadata (asset.ad_meta.external_id)
2. Asset's external ID (asset.external_id)
3. Asset ID (asset.id)

Passes or retrieves key-value pair(s) using the FreeWheel GET ad request.

By default, use a comma to delimit:

• A key from a value.
• Key-value pairs

Retrieve a field value by using the "$" macro. For example, ad.kv=genre,$genre will attempt to retrieve the value assigned to the "genre" field for the current asset.

Use the Key-Value Separator parameter (ad.kvsep) to define a different delimiter.

Example:

Determines the delimiter that must be used when defining key-value pairs through the Key-Value Pairs parameter.

Example:

Default Value:

Sets the site section network ID (siteSection@siteSectionNetworkId) included with the FreeWheel GET ad request.

Example:

Learn how to set a default value for this parameter.

Sets the video asset fallback ID (videoAsset@fallbackId) included with the FreeWheel GET ad request. This ID is used when an ad request's video asset ID is not recognized.

Example:

Learn how to set a default value for this parameter.

Sets the visitor's custom ID included with the FreeWheel GET ad request. This ID is the equivalent to the visitor/@customId attribute in the XML request.

Example:

Learn how to set a default value for this parameter.

This parameter takes precedence over the End-User ID parameter (ad.euid).

Sets the site section fallback ID included with the FreeWheel GET ad request. This ID is used when an ad request's site section ID is not recognized.

Example:

Learn how to set a default value for this parameter.

Requests a pre-roll ad unit. Set this parameter to 1.

Example:

Default Value:

Determines whether pre-roll, mid-roll, and post-roll ad units will be requested from FreeWheel.

Valid values are:

• preroll
• midroll
• postroll

View Live Streaming usage information.

Set this parameter to a comma-separated list of the desired types of ad units.

Syntax:

ad.slau=[Pre-Roll Ad Units],[Mid-Roll Ad Units],[Post-Roll Ad Units]

Use this parameter to:

• Request Ad Units: Each type of ad unit defined in the above parameter will be requested from FreeWheel. Leave an ad unit type blank to prevent it from being requested.

  Example:

  ad.slau=preroll,midroll,

  In this example, post-roll ad units will not be requested.

• Mapping Ad Unit Types: This parameter maps each type of ad unit that will be requested from FreeWheel.

  Example:

  ad.slau=midroll,midroll,postroll

  In this example, a mid-roll ad unit will be requested instead of a pre-roll ad unit. Mid-roll and post-roll ad units will be handled normally.

Default Value:

By default, the type of ad unit that is requested is determined by its position within the live stream.

View On-Demand Streaming usage information.

By default, pre-roll, mid-roll, and post-roll ad units are requested from FreeWheel.

Overrides an asset's duration (videoAsset@duration).

Example:

Default Value:

By default, this duration is determined by the CMS asset.

Sets a FreeWheel GET ad request URL that will be used instead of a POST Smart XML request.

Example:

Defines a global primary content type for all non-temporal, user-generated ad units.

Override this global value for a specific ad unit by assigning it a primary content type.

Example:

Default Value:

Overrides the client's IP address that will be included with the FreeWheel GET ad request.

This parameter is typically used for testing.

Example:

Default Value:

The IP address of the device that requested the playback of your content.

Overrides the Referer header value that will be included with the FreeWheel GET ad request.

This value should be URL encoded.

Example:

Default Value:

By default, the value of the Referer header included with the playback request will be included with the FreeWheel GET ad request.

Overrides the value of the User-Agent header that will be included with the FreeWheel GET ad request.

This value should be URL encoded.

Example:

Default Value:

By default, the playback request's User-Agent header value will be included with the FreeWheel GET ad request.

The Server URL parameter (ad.serverurl) takes precedence over this parameter. This parameter should not be specified if you plan on passing the Server URL parameter.

Sets the fourth-level domain, as indicated by [customerId] below, in the FreeWheel GET ad request.

FreeWheel GET ad request:

Example:

This example configures the FreeWheel GET ad request URL to: http://demo.v.fwmrm.net/ad/g/1.

The Location Description parameter (ad.locationDesc) takes precedence over this parameter. This parameter should not be specified if you plan on passing the Location Description parameter.

Defines a description for the playback location.

Example:

The Visitor Custom ID parameter (ad.vcid) takes precedence over this parameter. This parameter should not be specified if you plan on passing the Visitor Custom ID parameter.

Sets the custom visitor ID included with the FreeWheel GET ad request. This ID is the equivalent to the visitor/@customId attribute in the XML request.

Example: