Key Values GET Flashcards
_fw_h_user_agent
Required? No*. End user User Agent. It’s optional if the request comes directly from an end user, as FreeWheel ad server will get the user agent string from the HTTP request. But in a server to server integration, this key value is required. This parameter is also required if the user agent needs to be returned by the macro #{request.keyValue(“_fw_h_user_agent”)}.
_fw_vcid2
Required? No. This feature is for fee. Please contact FreeWheel for its pricing. Turn on the Server Side User State feature. It shifts the client side cookie storage for MRM to FreeWheel’s ad servers, so user state can be tracked even without cookie support on the client side. The value of _fw_vcid2 needs to follow the format “:”: is a hardcoded string provided by FreeWheel, typically a space name for the network’s user-base, unless they need to be segmented off for some reason. An id space can be shared across multiple networks; is generated by the client (player/app) and should be unique by user. This feature can be used when the player environment doesn’t support cookie (e.g., XBox, mobile Safari for 3rd-party cookies), so features based on user state can work in these environments, including UEX, frequency cap, etc. The player/app is responsible for persistence of the value and conforming to PII laws. You can read more about Custom Visitor IDs here. When a randomized user id can not be generated, do NOT send in a default value, e.g. 0000-00-0000000. This will have negative impact on ad server’s performance as ad server will not be able to understand its meaning, and will treat all requests with that id as the same user.
_fw_ae
Required? No. MVPD hash. See TV Everywhere: MVPD Key Values for details.
_fw_h_referer
Required? No. HTTP referer. Override the referer in HTTP headers.
_fw_player_height
Required? No. There are default width / height values set as player dimension in SFX side. For MRM-SFX integration, the default width / height value will be used if the player does not set “_fw_player_width” and “_fw_player_height” in the ad request. For MRM full stack, we recommend the player to set the “_fw_player_width” and “_fw_player_height” in ad request. If not, MRM will use a default width / height sending to DSP. We highly recommend the client to add “_fw_player_width” and “_fw_player_height” in the ad request no matter it is SFX integration or MRM full stack integration. As having the player’s dimension information would benefit the clients that maximize utilization of inventory for SSP integration. And it would also benefit our AdManager integration QA in the future.
_fw_h_x_state
Required? No. override state by kv , e.g. - see Geography data for valid values
_fw_h_x_country
Required? No. override country by kv, e.g. - see Geography data for valid values
_fw_h_x_city
Required? No. override city by kv, e.g. - see Geography data for valid values
_fw_zipcode
Required? No. override zip code by kv , e.g. - see Geography data for valid values
ltlg
Required? No. Latitude and longitude of request GEO location, in the format of decimal separated by “,”. For example “ltlg=37.566146,-122.323644”. By default ad server reverse looks up geographic location by the IP address of the request. “ltlg” value has a higher priority because it usually comes from mobile GPS or other location API.
_fw_player_width
Required? No. There are default width / height values set as player dimension in SFX side. For MRM-SFX integration, the default width / height value will be used if the player does not set “_fw_player_width” and “_fw_player_height” in the ad request. For MRM full stack, we recommend the player to set the “_fw_player_width” and “_fw_player_height” in ad request. If not, MRM will use a default width / height sending to DSP. We highly recommend the client to add “_fw_player_width” and “_fw_player_height” in the ad request no matter it is SFX integration or MRM full stack integration. As having the player’s dimension information would benefit the clients that maximize utilization of inventory for SSP integration. And it would also benefit our AdManager integration QA in the future.
_fw_h_x_postal_code
Required? No. override postal code by kv , e.g. - see Geography data for valid values
_fw_h_x_dma
Required? No. override dma by kv , e.g. - see Geography data for valid values
