Unique ID of the bid request, provided by FreeWheel.

Always

2.2/2.5/2.6

See Impression Object.

Always

2.2/2.5/2.6

For Bid request, only one of site or app object will be presented.

When to populate app object in Programmatic module (by priority):

1. Network item customized metadata configuration: apporsiteortb=app.
   
2. SCTE-130 ad request.
   
3. When bid request's devicetype is "Connected TV".
4. When bid request's devicetype is "Phone"/"Tablet" and through parsing ad request user agent it indicates it's not mobile web.

Details about the publisher’s app (i.e., non-browser applications). Only one of site or app object will be presented.

See App Object.

Occasionally

2.2/2.5/2.6

For bid request, only one of site or app object will be presented.

Programmatic module bid request will be populated with site object when it's not populated with app object (app object logic can be referred above).

Details about the publisher’s website. Only one of site or app object will be presented.

See Site Object.

Occasionally

2.2/2.5/2.6

Details about the user’s device to which the impression will be delivered.

See Device Object.

Always

2.2/2.5/2.6

Details about the human user of the device; the advertising audience.

See User Object.

Always

2.2/2.5/2.6

This is decided by the pricing model configured on open exchange rule.

 Auction type:

• "1": First-price auction
• "2": Second-price auction

Always

2.2/2.5/2.6

Always set this to 0 where 0 = live mode. 

Indicator of test mode in which auctions are not billable. FreeWheel always set this to 0 where 0 = live mode. 

Always

2.2/2.5/2.6

For non-Programmatic Guaranteed deals (Private Marketplace), please reach out to your account team to configure dynamic tmax per profile according to the timeout window specified for Phase 8 SSTF on your profile. FreeWheel is looking to support dynamic tmax eventually as the default in order to give our demand partners more time to bid and send back demand.

Maximum time in milliseconds FreeWheel provided as a guideline for demand partners' bids to be received, including Internet latency to avoid timeout. FreeWheel's default value is 200.

Freewheel allows optimizations that allow our publishers to extend the tmax time for their endpoints for non-Programmatic Guaranteed (PMP) bid request.

Programmatic Guaranteed bid request's tmax will always be 200 as FreeWheel doesn't expect auctioning to happen on demand partner. 

Always

2.2/2.5/2.6

DSP seats (e.g., advertisers, agencies) allowed to bid on this impression for a private auction initiated by open exchange rule.

DSP seats (e.g., advertisers, agencies) allowed to bid on this impression for a private auction.

This field is required in the bid response. Instances where FreeWheel will accept no wseat are to be considered edge cases.

Occasionally

2.2/2.5/2.6

FreeWheel supports below list currently and has the ability to extend:

"USD", "CAD", "SEK", "PEN", "CZK", "DKK", "UYU", "COP", "RSD", "GBP", "AUD", "EUR", "BRL", "PLN", "CHF", "NOK", "JPY", "ARS", "HUF", "CLP", "MXN"

Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes.

Always

2.2/2.5/2.6

A regs object that specifies any industry, legal, or governmental regulations in force for this request.

See Regulations Object.

Always

2.2/2.5/2.6

ID generated by FreeWheel.

Occasionally 

2.2/2.5/2.6

Domain of the site.

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Derived from key value "_fw_site_category" in the ad request.
2. Customized metadata on site level with key: sitecat

List of categories and values can be found in section 6.1 in the OpenRTB spec: https://www.iab.com/wp-content/uploads/2015/06/OpenRTBAPISpecificationVersion2_2.pdf. You should always use the value (e.g. "IAB1-6") instead of the description (e.g. "Music") in the IAB list when declaring this field.

Array of IAB content categories of the site. List of categories and values can be found in section 6.1 in the OpenRTB spec: https://www.iab.com/wp-content/uploads/2015/06/OpenRTBAPISpecificationVersion2_2.pdf

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Configuration in bid request amendments.
2. Derived from KeyValue "_fw_site_page" in the ad request.
3. Customized metadata on site level with key: sitepage.

For data sources number two and three above, if a network is a reseller or Marketplace buyer of inventory from another network, the content rights owner network's configuration will take precedence over your configuration. Users can change this to make your configuration take precedence if desired. If interested in this, please reach out to your FreeWheel account team.

If none of the above configuration exists, this field will not be in the bid request.

URL of the page where the impression will be shown.

Occasionally

2.2/2.5/2.6

See Publisher Object.

Always

2.2/2.5/2.6

See Content Object.

See Content Object.

Occasionally 

2.2/2.5/2.6

Data source (by priority):

1. Derived from KeyValue "_fw_inventorypartnerdomain" in the ad request.
2. Customized metadata on site level with key: inventorypartnerdomain

When a site contains ad inventory that is owned by another partner - the site should list all domains for those partners via this directive.

Pointer to the domain of the partner (of the site owner) with ownership of some portion of ad inventory on the site. The partner’s ads.txt file will be hosted here.

Occasionally

2.2/2.5/2.6

ID generated by FreeWheel.

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Configuration in bid request amendments.
2. Customized metadata on site level with key: appname.

For data sources number two above, if your network is the Reseller or Marketplace buyer of inventory from another network, the content rights owner network's configuration will take precedence over your configuration. Users can change this to make your configuration take precedence if desired. If interested in this, please reach out to your FreeWheel account team.

If none of the above configuration exists, this field will not be in the bid request.

App name

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Configuration in bid request amendments.
2. Customized metadata on site level with key: appversion.

For data sources number two above, if your network is the reseller or Marketplace buyer of inventory from another network, the content rights owner network's configuration will take precedence over your configuration. You can change this to make your configuration take precedence if desired. If you are interested in this, please reach out to your FreeWheel account team.

If none of the above configuration exists, this field will not be in the bid request.

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Configuration in Bid Request Amendments.
2. Derived from KeyValue "_fw_app_bundle" in the Ad Request.
3. Customized metadata on site level with key: appbundle.

For data sources number two and three above, if your network is the reseller or Marketplace buyer of inventory from another network, the content rights owner network's configuration will take precedence over your configuration. You can change this to make your configuration take precedence if desired. If you are interested in this, please reach out to your FreeWheel account team.

If none of the above configuration exists, this field will not be in the bid request.

A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.mygame). On iOS, it is typically a numeric ID.

Occasionally

2.2/2.5/2.6

See Publisher Object

Always

2.2/2.5/2.6

See Content Object 

See Content Object 

2.2/2.5/2.6

Data source (by priority):

1. Configuration in Bid Request Amendments.
2. Derived from KeyValue "_fw_app_store_url" in the Ad Request.
3. Customized metadata on site level with key: appstoreurl.

For data sources number two and three above, if your network is the reseller or Marketplace buyer of inventory from another network, the content rights owner network's configuration will take precedence over your configuration. You can change this to make your configuration take precedence if desired. If you are interested in this, please reach out to your FreeWheel account team.

If none of the above configuration exists, this field will not be in the bid request.

App store URL for an installed app

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Derived from KeyValue "_fw_inventorypartnerdomain" in the Ad Request.
2. Customized metadata on site level with key: inventorypartnerdomain

When an app contains ad inventory that is owned by another partner - the app should list all domains for those partners via this directive.

Pointer to the domain of the partner (of the app owner) with ownership of some portion of ad inventory on the app. The partner’s app-ads.txt file will be hosted here.

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Configuration in bid request amendments.
2. If GDPR or CCPA doesn't allow, pass empty string for this field.
3. If data sharing is not allowed on visitor user agent in data rights configuration, pass empty string for this field.
   1. A hardcoded user agent can be configured on player profile if needed in certain special integration.
4. If data sharing is allowed on visitor user agent in data rights configuration, pass user agent from the Ad Request.

Occasionally

2.2/2.5/2.6

Browser version:

• Sec-CH-UA-Full-Version-List

System/Platform version:

• Sec-CH-UA-Platform
• Sec-CH-UA-Platform-Version
• Sec-CH-UA-Platform-Version 

Device model:

• Sec-CH-UA-Model

FreeWheel will then put those into device.sua and pass to the DSP.

Occasionally

2.6

Data source (by priority):

1. Configuration in bid request amendments.
2. If GDPR or CCPA doesn't allow, pass empty string for this field.
3. If Data Sharing is "full rights (full IP)" on IP address in data rights configuration, pass ip from ad request.
4. If data sharing is "truncated IP" on IP Address in data rights configuration, pass truncated ip from ad request.
5. If data sharing is "no rights" on IP address in data rights configuration, pass empty string for this field.
   1. A hardcoded IP can be configured on player profile if needed in certain special integration.

Note: ip and ipv6 fields don't co-exist.

IPv4 address closest to device.

Occasionally

2.2/2.5/2.6

See Geo Object

 See Geo Object

2.2/2.5/2.6

1. If key value pair "_fw_is_lat = 1" is passed in ad request, pass lmt = 1 in bid request.
   1. For some DSPs, they explicitly notified FreeWheel that they cannot process the lmt field and doesn't want to get bid request with lmt field, FreeWheel will not send this type of bid request to the DSP at all.
2. If KeyValue "_fw_is_lat = 0" is passed in the ad request, bid request will not contain lmt field.

“Limit Ad Tracking” signal commercially endorsed (e.g., iOS, Android), where 0 = tracking is unrestricted, 1 = tracking must be limited per commercial guidelines.

Occasionally

Data source (by priority):

1. Configuration in bid request amendments.
2. If GDPR or CCPA doesn't allow, pass empty string for this field.
3. If data sharing is "full rights (full IP)" on IP Address in data rights configuration, pass ipv6 from Ad Request.
4. If data sharing is "truncated IP" on IP Address in data rights configuration, pass truncated ipv6 from Ad Request.
5. If data sharing is "no rights" on IP address in data Rights configuration, pass empty string for this field.
   1. A hardcoded IP can be configured on player profile if needed in certain special integration.

Note: ip and ipv6 fields don't co-exist.

IP address closest to device as IPv6

Occasionally

2.2/2.5/2.6

Accept-Language from ad request header.

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Derived from key value "_fw_deviceMake" in the Ad Request.
2. Customized metadata on site level with key: devicemake.
3. Configured via player profile parameter "deviceMake".
4. Derived from user agent. 

Device make (e.g., “Apple”).

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Derived from key value "_fw_device_model" in the Ad Request.
2. Customized metadata on site level with key: deviceModel.
3. Configured via player profile parameter "deviceModel".

 Device model (e.g., “iPhone”).

Occasionally

2.2/2.5/2.6

Data source (by priority):

1. Customized metadata on site level with key: ortbos.
2. Configured via player profile parameter "ortbOS".
3. Derived from user agent. 

 Device operating system (e.g., “iOS”).

Always

2.2/2.5/2.6

Data source (by priority):

1. Derived from key value "_fw_devicetype" in the ad request.
2. Customized metadata on site level with key: deviceType.
3. Configured via player profile.
4. Derived from user agent. 
5. Default is CONNECTED_TV.

For NO. 1, NO. 2 and NO. 3 configuration, the value should following below principles:

• "2-personal_computer" or "2-personal computer"
• "3-connected_tv" or "3-connected tv"
• "4-phone"
• "5-tablet"
• "7-set_top_box" or "7-set top box"

The general type of device.

Supported device type list:

2 = Personal computer

3 = Connected TV

4 = Phone

5 = Tablet

7 = Set top box

Always

2.2/2.5/2.6

Data source: derived from key value from ad request. Below is the key list:

• _fw_did_idfa
• _fw_did_google_advertising_id
• _fw_did_android_id
• _fw_did

This field is controlled by data rghts. 

• If data sharing is full rights on Device ID, pass device ID in the bid request.
• If data sharing is hashed ID on Device ID, pass hashed device ID in the bid request.
• If data sharing is no rights on Device ID, pass empty string in the bid request.
  • However FreeWheel supports a rotated hashed device ID when data sharing is no rights when specific Network Function is turned on. Please reach out to your FreeWheel account team for help.

 ID sanctioned for advertiser use in the clear (i.e., not hashed).

Always

2.2/2.5/2.6

Always

If the ip or ipv6 fields are passing truncated IP (either decided by Data Rights or bid request amendments), this field will be 1.

1. If key value "_fw_is_lat = 1" is passed in ad request, pass lmt = 1 in bid request.
   1. For some DSPs, they explicitly notified FW that they cannot process the lmt field and doesn't want to get bid request with lmt field, FreeWheel will not send this type of bid request to the DSP at all.
2. If KeyValue "_fw_is_lat = 0" is passed in ad request, bid request will not contain lmt field.

Data source:

1. If KeyValue "_fw_atts=3" or there is no key value with key "_fw_atts" in ad request, bid request will not contain ext.atts field.
2. If key value "_fw_atts=0 or 1 or 2" in ad request, ext.atts field will be sent to DSPs in bid request with corresponding value "0, 1, 2". 
   1. For some DSPs, they explicitly notified FW that they cannot process the atts field and doesn't want to get bid request with atts field, FreeWheel will not send this type of bid request to the DSP at all.

 (iOS Only) An integer passed to represent the app's app tracking authorization status, where
0 = not determined
1 = restricted
2 = denied
3 = authorized

Data source:

• Derived from key value in ad request whose key name is _fw_did and the sub type is idfv. For example, _fw_did="idfv:336F2BC0-245B-1234-5678-83762AB47B15"

Note: when ifv is populated in bid request, ifa_type will be "ppid".

IDFV of the device in that publisher.  It is an alphanumeric string that uniquely identifies a device to the app’s vendor. The IDFV is the same for apps from the same vendor but different across vendors. If the IDFA is not available, DSPs require an alternative, limited-scope identifier in order to provide basic frequency capping functionality to advertisers, which is IDFV.

This is an extension object for compatible in older ORTB version since device.sua is introduced in OpenRTB 2.6 version only.

Structured user agent information defined by a UserAgent object. If both ‘ua’ and ‘sua’ are present in the bid request, ‘sua’ should be considered the more accurate representation of the device attributes. This is because the ‘ua’ may contain a frozen or reduced user agent string.

Data source (by priority):

1. If the temporary ID network function is turned on your network, a rotated hashed user ID will be passed in bid request. Note: ifa_type field will be "sessionid".
2. If your network is not using temporary ID network function, and FreeWheel <> DSP user matching data is stored on DSP end (only few DSPs require this), a FW user ID will be passed in bid request to the DSP. Then DSP can recognize their own user ID from the FreeWheel <> DSP user matching data on their end.

Exchange-specific ID for the user.

Occasionally

2.2/2.5/2.6

1. If FreeWheel and the DSP successfully match FreeWheel user ID to DSP User ID, DSP user ID will be passed in this field.
2. If FreeWheel and the DSP doesn't successfully match FreeWheel user ID to DSP User ID or the device type doesn't support user syncing / matching, then bid request won't contain this field.

Occasionally

2.2/2.5/2.6

Data source: derived from ad Request KeyValue with key "_fw_gdpr_consent"

It is an optional string that contains the data structure developed by the GDPR Consent Working Group under the auspices of IAB Europe.

Occasionally

2.2 & 2.5

Data source (by priority):

1. Derived from key value "_fw_gdpr_consented_providers" in the Ad Request.
2. If above key value is not sent in the ad request, use the network's default Google GDPR consented providers configured in a network function.

For DV360 only - Google Consented Providers Solution

Occasionally

2.2 & 2.5

Occasionally

2.2 &2.5

For DV360 only

Occasionally

2.2 & 2.5

Data source: derived from key value "ltlg" in the ad request. This field will only sent in bid request when your network enables this. If you are interested please reach out to your FreeWheel account team. 

Latitude from -90.0 to +90.0, where negative is south.

Occasionally

2.2 / 2.5 / 2.6

Data source: derived from key value "ltlg" in the ad request. This field will only sent in bid request when your network enables this. If you are interested please reach out to your FreeWheel account team. 

Longitude from -180.0 to +180.0, where negative is west.

Occasionally

2.2 / 2.5 / 2.6

Data source (by priority):

1. Derived from key value "_fw_h_x_country" in the Ad Request.
2. Parsed from zip code / postal code from the Ad Request.
3. Parsed from IP from the ad request.
4. If none of above exists, bid request will not contain this field.

Occasionally

2.2 / 2.5 / 2.6

Data source (by priority):

1. Overriden postal code in cookie with field "Postal-Code"
2. Derived from key value "_fw_h_x_postal_code" in the ad request.
3. Derived from key value "_fw_zipcode" in the ad request.
4. Parsed from key value "ltlg" in the ad request.
5. Parsed from IP from the ad request.
6. If none of above exists, bid request will not contain this field.

This field is controlled by Data Rights configuration "Geography - Zipcode".

Occasionally

2.2 / 2.5 / 2.6

Data source (by priority):

1. Configuration in bid request amendments.
2. Derived from key value "_fw_content_channel" in the ad request.
3. Customized metadata on video or site axis with key: contentchannel

Channel the content is on (e.g., a local channel like “WABC-TV")

Data source (by priority):

• Configuration in bid request amendments.
• Derived from KeyValue "_fw_content_network" in the Ad Request.
• Customized metadata on video or site axis with key: contentnetwork

Channel the content is on (e.g., a local channel like “WABC-TV")

This is related to https://hub.freewheel.tv/display/MUG/Sellers.json.

An example:

"source":{
        "ext":{
            "schain":{
                "complete":1,
                "nodes":[
                    {
                        "asi":"demo1.com",
                        "sid":"pub-1",
                        "hp":2
                    },
                    {
                        "asi":"freewheel.tv",
                        "sid":"1234567",
                        "hp":1
                    }
                ],
                "ver":"1.0"
            }
        }
    }

This has to be enabled in order to receive it. Please reach out to your account representative if this is something your bidder would like to process