FreeWheel
Learn how to define the following FreeWheel ad configurations:
- Set a FreeWheel
GETad request URL. - Define where ads may be placed within your content.
- Pass the desired key/value pairs to FreeWheel. These key/value pairs allow you to send or receive information from FreeWheel that describes the content currently being streamed.
- Pass additional parameters through which you may customize the data provided to FreeWheel and the ads it provides.
FreeWheel Ad Requests
Upon setting the Server URL parameter, our service constructs the following GET request in order to request ads for your content:
http://[customerId].v.fwmrm.net/ad/g/1?[globalParams];[keyValues];[ParamsForSlot1];[ParamsForSlot2];...;[ParamsForSlotN];
The query string for the above request is constructed according to the parameters passed to our service as described below.
- [globalParams]: Most of the parameters described in the FreeWheel Ad Parameters section will be applied globally to all ad units.
- [keyValues]: The Key-Value Pairs parameter (
ad.kv) defines key-value pairs that may either be passed or retrieved from FreeWheel. - [ParamsForSlotN]: The Ad Units parameter (
ad.slau) determines whether we add slot-specific parameters (i.e.,[ParamsForSlot1];[ParamsForSlot2];...;[ParamsForSlotN];) to the above query string.
Toggle Ad Units
Ad placement is handled slightly differently between live and on-demand streaming.
Live Streaming
Toggle ad units by setting the Ad Units parameter (ad.slau) to a comma-separated list of ad unit types. Only ad unit types that are defined within this parameter will be requested.
Example:
The following value will only request mid-roll ads during this playback session of the live stream.
ad.slau=,midroll
On-Demand Content
By default, ads will be requested for pre-roll, mid-roll, and post-roll ad units.
FreeWheel Ad Parameters
This section describes parameters that our service will insert into the GET request sent to the FreeWheel ad server.
Name | Parameter | Description | |
|---|---|---|---|
Server URL | ad.serverurl |
| |
Location Description (Custom Site Section ID) | ad.locationDesc |
| |
Network ID | ad.nw |
| |
Player Profile | ad.prof |
| |
Maximum Pre-Roll Ads | ad.pre_maxads | Sets the maximum number of pre-roll ad units that may be returned by the ad server. | |
Minimum Pre-Roll Duration | ad.pre_mind | 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. | |
Maximum Pre-Roll Duration | ad.pre_maxd | Sets the maximum duration, in seconds, for pre-roll ad units within a live stream. This parameter only supports integers. | |
Pre-Roll Duration | ad.predur |
| |
Duration | ad.rdur | Defines a default duration. This duration is only applicable for ad breaks without an explicitly defined duration. | |
Minimum Mid-Roll Duration | ad.mind | 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. | |
Maximum Mid-Roll Duration | ad.maxd | Sets the maximum duration, in seconds, for mid-roll ad units within a live stream. This parameter only supports integers. | |
Use Live Break Duration | ad.ulbd | Sets ad unit duration for on-demand content to the duration defined when the source live stream was sliced. Set this parameter to 1. | |
Mode | ad.mode | Overrides the default request mode ( | ondemand` Learn how to set a default value for this parameter. |
Flags | ad.flags | Enables one or more flag(s) that define the player's capabilities. This value should be URL encoded. | |
Suppress supportsSlotTemplate | ad.suppress_pre_sltp | Removes supportsSlotTemplate from the pre-roll ad request. | |
Advanced Callbacks | ad.ametr | Allows FreeWheel to use impressions with advanced callbacks. Set this flag to 1. | |
HyLDA | ad.hylda | Activates FreeWheel’s HyLDA feature. Set this flag to 1. | |
Acid | ad.acid | Adds Acid as a value in the HyLDA keyword. This parameter is only applicable when the HyLDA flag has been enabled. | |
Default Ad Capabilities | ad.metr | Defines the default capabilities for all ads. Set this parameter to an integer that maps bits to capabilities. | |
Asset Network ID | ad.asnw | Adds a video asset network ID ( | |
Custom Asset ID | ad.caid | Sets the custom asset ID ( | |
Key-Value Pairs | ad.kv | Passes or retrieves key-value pair(s) using the FreeWheel | |
Key-Value Separator | ad.kvsep | Determines the delimiter that must be used when defining key-value pairs through the Key-Value Pairs parameter. | |
Site Section Network ID | ad.ssnw | Sets the site section network ID ( | |
Video Asset Fallback ID | ad.afid | Sets the video asset fallback ID ( | |
Visitor Custom ID | ad.vcid | Sets the visitor's custom ID included with the FreeWheel | |
Site Section Fallback ID | ad.sfid | Sets the site section fallback ID included with the FreeWheel | |
Pre-Roll Ad Unit | ad.preroll | Requests a pre-roll ad unit. Set this parameter to 1. | |
Ad Units | ad.slau | Determines whether pre-roll, mid-roll, and post-roll ad units will be requested from FreeWheel. Valid values are: | |
Asset Duration | ad.vdur | Overrides an asset's duration ( | |
Tag (FreeWheel Ad Request) | ad.tag | Sets a FreeWheel | |
Primary Content Type | ad.prct | Defines a global primary content type for all non-temporal, user-generated ad units. | |
Client IP Address | ad.vip | Overrides the client's IP address that will be included with the FreeWheel | |
Client Referrer | ad._fw_h_referer | Overrides the Referer header value that will be included with the FreeWheel | |
Client User Agent | ad._fw_h_user_agent | Overrides the value of the User-Agent header that will be included with the FreeWheel | |
Customer ID | ad.customer_id |
| |
Custom Site Section ID | ad.csid |
| |
End-User ID | ad.euid | The Visitor Custom ID parameter ( | |
Skip Preroll | skippreroll | If the |
Enable FreeWheel Video View Feature
The parameter to enable FreeWheel's Video View by Callback feature varies depending on the version of the ping API being used. This feature requires the use of both the Preplay and Ping APIs.
- Version 3: If you are using version 3 of the ping API (the current version), add
2to the value of thead.pingfparameter in your preplay request. (See the "Calculating the pingf Parameter" section of the Features portion of the ping API v3 documentation.) - Version 2: If you are using version 2 of the ping API (a past version), include the
ad.svv=1parameter in your preplay request.
This feature also requires using the Smart XML response type, as Video Views are not supported by VAST.
FreeWheel Creative Parameters
An ad response sent by FreeWheel may include creative parameters such as:
- _fw_ad_position_in_pod
- _fw_ad_title
- _fw_ad_unit_name
- _fw_advertiser_name
- _fw_asset_thumbnail_url
- _fw_campaign_name
- _fw_creative_name
- hulu_industry
- moat
These creative parameters are automatically included in preplay and ping responses to the client. The client may then leverage these parameters for use with a custom integration (e.g., integration of FreeWheel with Moat Analytics).
Ad Configuration
An ad configuration allows you to define default values for use with third-party ad servers (e.g., FreeWheel).
Define an ad configuration by performing the following steps:
- Navigate to the Ad Server page via Settings > Ad Server.
- Click + Ad Config.
- In the Ad config name option, type the name that will be assigned to your ad configuration.
- From the Select ad server option, select "FreeWheel."
- Click Create.
- In the serverURL option, type your FreeWheel
GETad request URL. - In the networkID option, type the distributor’s FreeWheel network ID (
adRequest@networkId). - Define default values for any other desired FreeWheel parameters.
- Click Save.
Updated 5 days ago