The site section (id) determines the exact piece of inventory where the ad request is coming from as designed in your network design. You may have one or many different site sections breaking out inventory depending on what network design was agreed upon with your Freewheel account team. The value to implement will be provided by your Freewheel account team. The expected format is either the tag or the numerical ID of the site section.

"siteSectionId": "ss_12345"

or

"siteSectionId": "12345"

Request mode. Valid values are:

• "on-demand"
• "live"

An object of ad request key-pair values.

See AdCom v1 List: Creative Subtypes - Audio/Video for the industry standard protocol list.

Slot custom ID. Any string with valid letters/digits/symbols.

Specify custom ad unit names for this slot. Multiple ad unit names can be put into this parameter, separated by "\|". Ad unit group names are also supported but you can only specify one ad unit group; multiple ad unit groups or mixed ad unit group and ad unit names are not supported. Default: "preroll".

. Default: "preroll".

Controls if ad play back should start with volume muted.

Controls if a mute button should be shown during ad playback.

Controls if ad play back should start with volume muted.

Controls if a mute button should be shown during ad playback

.

The format to use for displaying the ad. 

...

We have dedicated documents (for VAST and ORTB-S) that includes details of the passing of Standard Attributes (such as Brand, Channel, IAB Category, Genre, Content title, as well as Schain, GDPR) within ad requests.

...

7. Passing Contextual Information via Standard Attributes

...

In order to successfully monetize your supply and align all relevant demand, we'll require clients to correctly pass contextual information around the supply also known as Standard Attributes. The page

https://hub.freewheel.tv/display/MUG/Inventory+Standardization+with+FreeWheel+Custom+Key+Values

...

6. Endpoint

Clients will be provided with a unique endpoint for which to send requests. Endpoints will have a variable prefix ID which is the Network ID in hexadecimal format. The Endpoint Prefix ID will need to be added as a prefix within the URL:

...

• Format
  • https://prefixID.v.fwmrm.net/ad/g/1
• Example with custom prefix ID included
  • https://83b96.v.fwmrm.net/ad/g/1

...

 details the fields required to pass the needed information within your ad requests. This document includes details of the passing of Standard Attributes such as Brand, Channel, IAB Category, Genre, Content title, etc.

Mandatory Standard Attributes are typically Brand and Genre, however, this may change depending on your inventory. Please work with your account manager for what is required for you.

...

8. User Syncing/Cookie Syncing 

*This section is only necessary for web inventory

User Syncing, also known as Cookie Syncing, is the process of sharing and matching HTTP cookies between various partners. The concept of Cookie Tracking is restrictive in the amount of information that can be collected and actioned upon for advertisers. This is because cookies are limited to domain and have varying expiration dates. In order for Freewheel to be able to identify, target and frequency cap across various digital properties in accordance with campaign KPI's, Freewheel needs to know how to distinguish one user from another that are sent to us in the publisher's bid request.

User/cookie syncing with Freewheel is available for Prebid.JS clients with the expectation that the client's cookies, if passed, will be included in the http headers of the ad request. When this is present, it will then be used downstream to check if we have a cookie match with the DSPs as we send outgoing bid requests. 

...

9. Schain/Sellers JSON/Ads.txt/app ads.txt 

Your Freewheel account representative will provide you with the required codes to enter in your ads.txt and ensure that your new publisher IDs are added into our sellers.JSON as an onboarding step. This schain object will be passed in the ext.schain object of the ORTB ad request - please refer here to the  ORTB-S Integration Guide section 5.10 for further information on this.

If you are a Freewheel client and need more information on:

• ads.txt setup please refer to this
• Sellers.json please refer to this

...

...

10. Troubleshooting Tips

Since integrations often break due to typos, errors in config, we highly recommend checking the format of your requests based on the samples below or the documentation housed on Github. Please also ensure that you use the correct adapter for JS - fwssp and not another adapter. 

The below code blocks are examples of the expected parameters as a guide and to sanity check the code 

...

10.1 Sample Ad Requests

...

10.1.1 Inbanner Ad request Config Example

{
        'bidder': 'fwssp',
        'adUnitCode': 'adunit-code',
        'mediaTypes': {
        'banner': {
          'sizes': [
            [300, 250], [300, 600]
          ]
        }
        },
        'sizes': [[300, 250], [300, 600]],
        'bidId': '30b31c1838de1e',
        'bidderRequestId': '22edbae2733bf6',
        'auctionId': '1d1a030790a475',
        'schain': {
          'ver': '1.0',
          'complete': 1,
          'nodes': [{
            'asi': 'example.com',
            'sid': '0',
            'hp': 1,
            'rid': 'bidrequestid',
            'domain': 'example.com'
          }]
        },
        'params': {
          'bidfloor': 2.00,
          'serverUrl': 'https://example.com/ad/g/1',
          'networkId': '42015',
          'profile': '42015:js_allinone_profile',
          'siteSectionId': 'js_allinone_demo_site_section',
          'flags': '+play',
          'videoAssetId': '0',
          'timePosition': 120,
          'adRequestKeyValues': {
            '_fw_player_width': '1920',
            '_fw_player_height': '1080'
          }
        }
      }

...

10.1.2 Instream Ad Request Config Example

{
        'bidder': 'fwssp',
        'adUnitCode': 'adunit-code',
        'mediaTypes': {
          'video': {
            'playerSize': [300, 600],
          }
        },
        'sizes': [[300, 250], [300, 600]],
        'bidId': '30b31c1838de1e',
        'bidderRequestId': '22edbae2733bf6',
        'auctionId': '1d1a030790a475',
        'schain': {
          'ver': '1.0',
          'complete': 1,
          'nodes': [{
            'asi': 'example.com',
            'sid': '0',
            'hp': 1,
            'rid': 'bidrequestid',
            'domain': 'example.com'
          }]
        },
        'params': {
          'bidfloor': 2.00,
          'serverUrl': 'https://example.com/ad/g/1',
          'networkId': '42015',
          'profile': '42015:js_allinone_profile',
          'siteSectionId': 'js_allinone_demo_site_section',
          'flags': '+play',
          'videoAssetId': '0',
          'mode': 'live',
          'timePosition': 120,
          'tpos': 300,
          'slid': 'Midroll',
          'slau': 'midroll',
          'minD': 30,
          'maxD': 60,
          'adRequestKeyValues': {
            '_fw_player_width': '1920',
            '_fw_player_height': '1080'
          },
          'gdpr_consented_providers': 'test_providers'
        }
      }

...

...

10.2 Troubleshooting Ad Rendering

• FWSSPAdapter fwssp Prebid.js Adapter will load the MRM AdManager SDK for ad rendering. Please see these Admanager pages for additional information https://hub.freewheel.tv/pages/viewpage.action?pageId=2267285912

...