Page History
...
| Guide Version | Date | Author | Description |
|---|---|---|---|
| v1 |
| Admin | Initial Release |
Historic
| UI Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
| Section | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Scroll to the right to see the full table
| Parameter Name | Required vs Recommended | Description and format | Freewheel Placeholder | SpringServe Macro (not in hub) | Publica Macro (not in hub) | Elemental Macros (not in hub) | GAM Macros (not in Hub) | |
|---|---|---|---|---|---|---|---|---|
| https://[CLIENT_VHOST].v.fwmrm.net/ad/g/1? | Required | Client specific Vhost. The alphanumeric ID is the client's network ID Hexadecimal encrypted. For example:
| Global Parameters | |||||
| nw=[NETWORK_ID_PLACEHOLDER] | Required | Network ID - integer | ||||||
| resp=vast4 | Required | Response format - string | ||||||
| prof=[PROFILE_PLACEHOLDER] | Required | Player profile. Specifies which types and formats of ads can be returned in this player environment - string 54321:fw_ssp_VAST_clientname | ||||||
| csid=[SITE_SECTION_PLACEHOLDER] | Required | Custom site section ID. Indicates "where" the video is played. This is an alpha-numeric value and is considered the tag for the site section - string | ||||||
| caid=0 | Required | Custom video asset ID. Hardcoded to '0' or '1'. - integer | ||||||
| pvrn= | Required | Page View Random. A random number generated per page view. Used for cache busting - integer | [CACHEBUSTER_PLACEHOLDER] | {{CACHEBUSTER}} | [CACHEBUSTER] | ${CB} | %%CACHEBUSTER%% | |
| vprn= | Required | Video Player Random. A random number generated per video instance (re-randomize on a new video play even on the same page). Used for cache busting - integer | [CACHEBUSTER_PLACEHOLDER] | {{CACHEBUSTER}} | [CACHEBUSTER] | ${CB} | %%CACHEBUSTER%% | |
| flag=+fwssp+amcb+nucr | Required | The flag section turns on or off specific capabilities that are needed to make the integration work. "+" means to turn on and "-" means to turn off. String | ||||||
| metr=1023 | Required | Signals the default metrics supported for all ads returned in the response. It's a bitmap representing whether this integration supports some pre-defined metrics like clickable, pausable, mutable, etc - Integer | 1023 | |||||
| vip= | Required | End user IP address - string | [IP_ADDRESS_PLACEHOLDER] | {{IP}} | [IP] | ${IP} | %%USER_IP%% | |
| mode=live | Required | Stream type of the video asset, acceptable values are "on-demand" or "live" - string | live | |||||
| ; | Global Parameter (Above) Key Values (Below) - please take note of the separator value | Global Parameter (Above) Key Values (Below) | ||||||
| _fw_h_user_agent= | Required | End user user agent - string | [USER_AGENT_PLACEHOLDER] | {{USER_AGENT}} | [%UA%] | ${UA} | %%USER_AGENT%% | Key Values |
| _fw_h_referer= | Required for OLV | End user referrer URL. Not required for non-web environments - string | [REFERER_URL_PLACEHOLDER] | {{ENCODED_URL}} | %%REFERRER_URL_ESC%% | |||
| _fw_vcid2= | Required | Custom user ID, used for frequency capping and audience lookup - string | [DEVICE_ID_PLACEHOLDER] | {{DEVICE_ID}} | [DID] | ${DEV_ID} | %%ADVERTISING_IDENTIFIER_PLAIN%% | |
| _fw_did= | Required | End user device ID, used for frequency capping and audience lookup - string | [IFA_TYPE_PLACEHOLDER] | {{IFA_TYPE}} | [IFA_TYPE] | ${IFA_TYPE} | %%ADVERTISING_IDENTIFIER_TYPE%% | |
| _fw_deviceMake= | Recommended | Device make (e.g. Apple) - string | [DEVICE_MAKE_PLACEHOLDER] | {{DEVICE_MAKE}} | [%DEVICE_MAKE%] | ${DEV_MAKE} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:dev_make%% | |
| _fw_player_width= | Recommended | Player width - integer | [WIDTH_PLACEHOLDER] | {{WIDTH}} | [WIDTH] | ${WIDTH} | %%WIDTH%% | |
| _fw_player_height= | Recommended | Player height - integer | [HEIGHT_PLACEHOLDER] | {{HEIGHT}} | [HEIGHT] | ${HEIGHT} | %%HEIGHT%% | |
| _fw_playback_method=1 | Recommended | Integer with the following possible values: 1 Initiates on Page Load with Sound On | ||||||
| _fw_playback_end= | Recommended | Integer - the following table lists the various modes for when playback terminates. | [PLAYBACK_END_PLACEHOLDER] | |||||
| _fw_app_name= | Required for in app | App Name - string | [APP_NAME_PLACEHOLDER] | {{APP_NAME}} | [%APP_NAME%] | ${APP_NAME} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:app_name%% | |
| _fw_app_bundle= | Required for in app | App Bundle ID - string | [APP_BUNDLE_PLACEHOLDER] | {{APP_BUNDLE}} | [%APP_BUNDLE%] | ${APP_BUNDLE} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:app_bundle%% | |
| _fw_app_store_url= | Required for in app | App store URL - string | [APP_STORE_URL_PLACEHOLDER] | {{APP_STORE_URL}} | [%APP_STORE_URL%] | ${APP_URL} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:url%% In this case the url will be expanded to that of the app store An example might be %%PATTERN:www.myappstoreurl.com%% | |
| _fw_inventorypartnerdomain= | Recommended | Declaration of inventory partner domain for ads.txt - string | [INVENTORY_PARTNER_DOMAIN_PLACEHOLDER] | {{INV_PARTNER_DOMAIN}} | [%PARTNER_DOMAIN%] | ${INV_PARTNER_DOMAIN} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:inv_partner_domain%% | |
| _fw_is_lat= | Recommended | Used to identify if a user has opted in or out of Limit Ad Tracking. Value should be 1 (user has enabled limit ad tracking) or 0 (user has not enabled limit ad tracking) - integer | [LIMITED_AD_TRACKING_PLACEHOLDER] | {{LMT}} | [LIMITED_AD_TRACKING] | ${LMT} | %%ADVERTISING_IDENTIFIER_IS_LAT%% | |
| _fw_us_privacy= | Recommended | In support of CCPA and future US privacy regulations, FW supports the IAB privacy string https://hub.freewheel.tv/display/Resources/California+Consumer+Privacy+Act+%28CCPA%29+-+Implementation+Guidelines+for+MRM+Clients - string | [US_PRIVACY_PLACEHOLDER] | {{US_PRIVACY}} | [US_PRIVACY] | ${US_PRIVACY} | %%US_PRIVACY%% | |
| _fw_gdpr= | Recommended | GDPR boolean flag - integer | [GDPR_PLACEHOLDER] | {{GDPR}} | [GDPR] | ${GDPR} | ||
| _fw_gdpr_consent= | Recommended | GDPR Consent String - string | [GDPR_CONSENT_PLACEHOLDER] | {{CONSENT}} | [CONSENT] | ${GDPR} | ${GDPR_CONSENT_XXXX} | |
| _fw_coppa= | Recommended | COPPA boolean flag - integer | [COPPA_PLACEHOLDER] | {{COPPA}} | [COPPA] | ${COPPA} | %%TFCD%% | |
| ltlg= | Recommended | Latitude, Longitude *Must be comma separated - string | [LATITUDE_PLACEHOLDER],[LONGITUDE_PLACEHOLDER] | {{LAT}},{{LON}} | [LAT],[LON] | ${LAT},${LON} | ||
| _fw_content_programmer_brand= | Required | Programmer- Brand Standard Attributes. Programmer is inferred from brand value. _fw_content_programmer_brand=FWNewsUS - string | [PROGRAMMER_BRAND_PLACEHOLDER] | |||||
| _fw_content_genre= | Required if IAB content category - _fw_content_category= cannot be passed | Content genre - string | [CONTENT_GENRE_PLACEHOLDER] | {{CONTENT_GENRE}} | [%CONTENT_GENRE%] | ${CONTENT_GENRE} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:genre%% | |
| _fw_content_rating= | Strongly recommended for effective monetization | Content rating - string | [CONTENT_RATING_PLACEHOLDER] | {{RATING}} | [%CONTENT_RATING%] | ${CONTENT_RATING} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:rating%% | |
| _fw_site_category= | Recommended | Site category name - string | [CONTENT_CATEGORY_PLACEHOLDER] | {{IAB_CATEGORY}} | [CONTENT_CAT] | ${CONTENT_CAT} | %%IAB_CATEGORIES%% | |
| _fw_content_category= | Strongly recommended for effective monetization | Content category - string | [CONTENT_CATEGORY_PLACEHOLDER] | {{IAB_CATEGORY}} | [CONTENT_CAT] | ${CONTENT_CAT} | %%IAB_CATEGORIES%% | |
| _fw_content_channel= | Strongly recommended for effective monetization | Content channel name - string | [CONTENT_CHANNEL_PLACEHOLDER] | {{CHANNEL_NAME}} | [%CONTENT_CHANNEL%] | ${CHANNEL} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:channel%% | |
| _fw_content_network= | Recommended | Content network name - string | [CONTENT_NETWORK_PLACEHOLDER] | {{NETWORK_NAME}} | [%CONTENT_NETWORK%] | ${NETWORK} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:network%% | |
| _fw_content_title= | Recommended | Content title - string | [CONTENT_TITLE_PLACEHOLDER] | {{CONTENT_TITLE}} | [%CONTENT_TITLE%] | ${CONTENT_TITLE} | %%VIDEO_TITLE%% | |
| _fw_content_language= | Strongly recommended for effective monetization | Content language - string | [CONTENT_LANGUAGE_PLACEHOLDER] | {{LANGUAGE}} | [CONTENT_LANGUAGE] | ${CONTENT_LANGUAGE} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:lang%% | |
| _fw_content_length= | Recommended | Content length expressed in seconds - integer | [CONTENT_LENGTH_PLACEHOLDER] | {{DURATION}} | [CONTENT_LENGTH] | ${CONTENT_DUR} | %%VIDEO_AD_DURATION%% | |
| _fw_content_producer_name= | Recommended | Content producer name - string | [CONTENT_PRODUCER_NAME_PLACEHOLDER] | {{CONTENT_PRODUCER_NAME}} | [%CONTENT_PRODUCER_NAME%] | ${PRODUCER_NAME} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:producer_name%% | |
| _fw_production_quality= | Recommended | Content production quality - string | [CONTENT_PRODUCTION_QUALITY_PLACEHOLDER] | {{PRODUCTION_QUALITY}} | [CONTENT_PROD] | ${PRODUCTION_QUALITY} | GAM uses the pattern macro where by the key is declared in this format: %%PATTERN:key%% Please replace the key string with the relevant key that you wish to use for custom targeting An example might be %%PATTERN:content_prod%% | |
| _fw_bidfloor= | Optional | Dynamically pass programmatic bid floor price in ad request i.e. '12.23'. This is similar to setting floor price in: UI > Admin > Programmatic Management > Network Floor Price. -OR- UI > Network Items (SG, S or SS only) > Programmatic Management. Value format = float | [NET_BIDFLOOR_PLACEHOLDER] | |||||
| _fw_bidfloorcur= | Optional | Currently of floor price set in '_fw_bidfloor', example value 'USD'. If no currency, ADS will use CRO default network currency. Please see MULTI_CURRENCY_SUPPORT for multiple currency support. Currency specified using 3-character ISO-4217 alpha codes. Value format = string | [NET_BIDFLOOR_CURRENCY_PLACEHOLDER] | |||||
| schain= | Recommended, but could have downstream revenue consequences if not included | String - this can be passed in the ad request with key ver,complete!asi,sid,hp,rid,name,domain,ext Example: &schain=1.0,1!customer.name,5af190fb073ef4546a085a53,1,,name,yourdomain.com | [SCHAIN_PLACEHOLDER] | {{SCHAIN}} | [SCHAIN] | ${SUPPLY_CHAIN} | ||
| ; | Key Values (Above) Slot Parameter (Below) - please take note of the separator value | Key Values (Above) Slot Parameter (Below) | ||||||
| tpcl=[AD_UNIT_POSITION] | Required | Supported values: preroll, midroll, postroll - string | [PREROLL_OR_MIDROLL_OR_POSTROLL] | midroll | [POSITION] *Publica clients can customize Position values i.e. the position macro can return 'midroll', 'mid' or 'm'. Consult with the Pub AM prior to using the Publica Position macro to confirm expected values. | midroll | Slot Parameters | |
| ptgt=a | Required | Type of slot. This is a required parameter - string ptgt=a: temporal slot | a | |||||
| mind=[MIN_SLOT_DURATION_PLACEHOLDER] | Required | Minimum slot duration - integer | ||||||
| maxd=[MAX_SLOT_DURATION_PLACEHOLDER | Required | Maximum slot duration ) - integer | ||||||
...
4. Sample Ad Request Tag
Please see below an example of an ad request tag in its expected format based on the above parameters:
https://1a2bC.v.fwmrm.net/ad/g/1?nw=54321&resp=vast4&prof=54321:fw_ssp_VAST_clientname&csid=my_site_section&caid=0&pvrn=[CACHEBUSTER_PLACEHOLDER]&vprn=[CACHEBUSTER_PLACEHOLDER]&flag=+fwssp+amcb+nucr&metr=1023&vip=[IP_ADDRESS_PLACEHOLDER]&mode=live;_fw_h_user_agent=[USER_AGENT_PLACEHOLDER]&_fw_h_referer=[REFERER_URL_PLACEHOLDER]&_fw_vcid2=[DEVICE_ID_PLACEHOLDER]&_fw_did=[IFA_TYPE_PLACEHOLDER]:[DEVICE_ID_PLACEHOLDER]&_fw_deviceMake=[DEVICE_MAKE_PLACEHOLDER]&_fw_player_width=[WIDTH_PLACEHOLDER]&_fw_player_height=[HEIGHT_PLACEHOLDER]&_fw_playback_method=1&_fw_playback_end=[PLAYBACK_END_PLACEHOLDER]&_fw_app_name=[APP_NAME_PLACEHOLDER]&_fw_app_bundle=[APP_BUNDLE_PLACEHOLDER]&_fw_app_store_url=[APP_STORE_URL_PLACEHOLDER]&_fw_inventorypartnerdomain=[INVENTORY_PARTNER_DOMAIN_PLACEHOLDER]&_fw_is_lat=[LIMITED_AD_TRACKING_PLACEHOLDER]&_fw_us_privacy=[US_PRIVACY_PLACEHOLDER]&_fw_gdpr=[GDPR_PLACEHOLDER]&_fw_gdpr_consent=[GDPR_CONSENT_PLACEHOLDER]&_fw_coppa=[COPPA_PLACEHOLDER]<lg<lg=[LATITUDE_PLACEHOLDER],[LONGITUDE_PLACEHOLDER]&_fw_content_programmer_brand=[PROGRAMMER_BRAND_PLACEHOLDER]&_fw_content_genre=[CONTENT_GENRE_PLACEHOLDER]&_fw_content_rating=[CONTENT_RATING_PLACEHOLDER]&_fw_site_category=[CONTENT_CATEGORY_PLACEHOLDER]&_fw_content_category=[CONTENT_CATEGORY_PLACEHOLDER]&_fw_content_channel=[CONTENT_CHANNEL_PLACEHOLDER]&_fw_content_network=[CONTENT_NETWORK_PLACEHOLDER]&_fw_content_title=[CONTENT_TITLE_PLACEHOLDER]&_fw_content_language=[CONTENT_LANGUAGE_PLACEHOLDER]&_fw_content_length=[CONTENT_LENGTH_PLACEHOLDER]&_fw_content_producer_name=[CONTENT_PRODUCER_NAME_PLACEHOLDER]&_fw_production_quality=[CONTENT_PRODUCTION_QUALITY_PLACEHOLDER]&_fw_bidfloor=[NET_BIDFLOOR_PLACEHOLDER]&_fw_bidfloorcur=[NET_BIDFLOOR_CURRENCY_PLACEHOLDER];tpcl=[PREROLL_OR_MIDROLL_OR_POSTROLL]&ptgt=a&mind=30&maxd=500
...
5. Inventory Standardization
...
Your Freewheel account management team with provide the relevant ads.txt lines to implement as well as ensure that your sellers.JSON is up to date for your relevant seller relationships. Please refer to https://hub.freewheel.tv/display/MUG/ads.txt+and+app-ads.txt+setup#ads.txtandappads.txtsetup-FreeWheelSSP for details on the expected set up for a FW SSP customer.
...