Specification Support

Guide Change Log

Current Guide Version

Historic

1. Introduction 

Prebid Server is an advanced ad serving technology that facilitates server-side header bidding. It acts as a bridge between publishers and demand sources (DSPs, ad exchanges, or SSPs), enabling efficient ad auction processes by translating bid requests and responses into standardized formats. Our fwssp Prebid Server Adapter, adapts Prebid ORTB ad requests into OpenRTB Supply Integration ad requests and OpenRTB Supply Integration ad responses back to Prebid ORTB ad responses.

Key Features

• Adapter Integration: Prebid Server uses adapters (like FreeWheel's fwssp adapter) to integrate demand sources, by translating bid requests and responses between different systems

• OpenRTB Supply Integration Compatibility: Supports the OpenRTB Supply Integration API built to make it possible to deploy and maintain an effective OpenRTB supply integration with Freewheel to pass inventory to downstream demand sources to obtain incremental demand. Please refer to the OpenRTB Supply Integration Guide for more on specifications supported and other items.

• Media Type Support: Can handle various media types

1.1 Integration Diagram

1.2 Pre-Requisites

Before starting this integration, please ensure you have the following to start: 

• Existing connection to a Prebid Server provider using PBS-Go
  • There are two implementation types of Prebid Server: PBS-Go and PBS-Java. Freewheel currently does not support PBS-Java. 
• Expected QPS volumes (daily max and average)
• Estimated traffic per geo
• Ensure ads.txt and app ads.txt are up to date
• Must use the adapter released in Prebid Server version 3.18.0 or above
• New endpoint url - see section below
• Freewheel account team to provide:
  • Profile ID
  • Network ID
  • Custom site section ID

2. Technical Implementation

Freewheel only offers a Go version of the fwssp Prebid Server Adapter which can be used as a module for an ad server's Prebid Server instance built on Go.

1. If the ad server already has a Prebid Server setup via Go
   1. You can find our prebid server adapter module (the fwssp.go file) here: https://github.com/prebid/prebid-server/tree/master/adapters/fwssp
      1. Usage instructions can be found here: https://go.dev/doc/tutorial/getting-started and https://go.dev/blog/using-go-modules
2. If the ad server doesn't have a Prebid Server setup
   1. See here on installing Prebid Server on to an ad server: https://docs.prebid.org/prebid-server/developers/installing-go.html 
      1. To note we are linking the GO version of Prebid Server here as we only offer a Go version/module of the fwssp Prebid Server Adapter
   2. You can find our fwssp Prebid Server Adapter module (the fwssp.go file) here: https://github.com/prebid/prebid-server/tree/master/adapters/fwssp
      1. Usage instructions can be found here: https://go.dev/doc/tutorial/getting-started and https://go.dev/blog/using-go-modules

2.1 Updates to the fwssp Prebid Server Adapter

Freewheel may update the adapter to extend its capabilities or correct an issue, we are currently looking into the best way to relay to clients and ad servers when we make an update so they can then update their local version of fwssp Prebid Server Adapter.

3. Endpoint

The following dedicated endpoint is what will be used for Prebid Server traffic to Freewheel and is hardcoded into the fwssp Prebid Server adapter config file:

3.1 Gzip Compression Support

The fwssp Prebid Server adapter can support gzip compression (declared via the endpointcompression attribute/kvp) and for more information on this please see section 4.6 in the OpenRTB Supply Integration Guide Gzip Compression support section. 

For documentation on how we declare this in our adapter please see: https://docs.prebid.org/prebid-server/developers/add-new-bidder-go.html#bidder-info

4. Parameters

4.1 fwssp Adapter Parameter Highlights

The following are highlights from the list of OpenRTB Supply Integration (ORTB-S) parameters relevant to the fwssp Prebid Server adapter. For a list of all ORTB-S parameters please refer to the OpenRTB Supply Integration Guide. 

4.2 ORTB Type Ad Request Body

Please refer to section 5 of our OpenRTB Supply Integration Guide for the current list of supported ORTB fields. Note that there will often be new fields added to this section. 

4.3 OpenRTB Supply Integration (ORTB-S) Extended Features

For more on using ORTB-S extended features such as Multi-Bid, Multi-Imp (Structured Pods), and Dynamic Podding - please refer to section 1.2 in the OpenRTB Supply Integration Guide.

5. Config Code

If you need access to the adapter code, you can view it on the following Github repository.

6. User Syncing/Cookie Syncing

Starting from the 7.11 release on 8/25/2025, we'll have the ability to handle cookie syncing for Prebid Server clients, until then user/cookie sync will not be able to function via the fwssp Prebid Server adapter.
The code to manage this will be integrated into the adapter code including the sync pixel. Each Prebid Server instance will be able to retrieve the FW cookie ID via the sync pixel and use it to populate the user.buyerid in the outgoing ad request to Freewheel. This will then be used downstream to check if we have a cookie match with the DSPs as we send outgoing bid request. 

The expectation is the the upstream adserver will host the user match table in-between your cookie ID and the Freewheel cookie ID.

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

The populating of the Schain will be handled via the Prebid Server. 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 - refer here to the ORTB-S Integration Guide section 5.10. If you are a Freewheel client and need more information on the ads.txt setup please refer to here.

8. Passing Contextual Information (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+from+OpenRTB-S details the fields required to pass the needed information for ORTB ad requests. This document includes details of the passing of Standard Attributes such as Brand, Channel, IAB Category, Genre, Content title, etc.

9. 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 - fwssp and not another adapter. 

9.1 Sample ad requests and responses

Please refer to the below code blocks which pass the expected parameters as a guide and to sanity check the code

9.1.1 Prebid Received Request Sample

{
  "id": "fwssp-test",
  "imp": [{
    "id": "imp-1",
    "video": {
      "mimes": ["video/mp4"],
      "minduration": 5,
      "maxduration": 30,
      "startdelay": -1,
      "maxseq": 5,
      "poddur": 120,
      "w": 300,
      "h": 250,
      "minbitrate": 300,
      "maxbitrate": 1500
    },
    "secure": 1,
    "ext": {
      "prebid": {
        "bidder": {
          "fwssp": {
            "custom_site_section_id": "ss_12345",
            "network_id": "123456",
            "profile_id": "123456:prof_12345"
          }
        }
      }
    }
  }],
  "site": {
    "page": "https://prebid.org",
    "ext": {
      "amp": 0
    },
    "content": {
      "cat": ["IAB2"],
      "contentrating": "tv-14",
      "genre": "GV,Entertainment,Automotive,Talk Show",
      "keywords": "Entertainment",
      "language": "en",
      "len": 2700,
      "livestream": 1,
      "prodq": 1,
      "qagmediarating": 1,
      "series": "VOD",
      "title": "title-name",
      "userrating": "4.6",
      "producer": {
        "name": "prorducer-name"
      },
      "network": {
        "name": "network-name"
      },
      "channel": {
        "name": "channel-name"
      }
    }
  },
  "device": {
    "ua": "curl/8.7.1"
  },
  "at": 1,
  "regs": {
    "coppa": 0,
    "gdpr": 1,
    "gpp": "DBABLA~BVQqAAAAAWA",
    "gpp_sid": [7],
    "us_privacy": "1---"
  },
  "user": {
    "ext": {
      "consent": "ABCDEF123456"
    }
  },
  "source": {
    "ext": {
      "schain": {
        "complete": 1,
        "nodes": [{
          "asi": "lkqd.net",
          "hp": 1,
          "sid": "1100053830"
        }],
        "ver": "1.0"
      }
    }
  },
  "ext": {
    "keywords": {
      "_fw_content_programmer_brand": "brand-name",
      "_fw_content_programmer_brand_channel": "channel-name",
      "_fw_content_genre": "comedy",
      "_fw_content_category": "comedy",
      "_fw_content_rating": "PG",
      "_fw_content_language": "en"
    },
    "prebid": {
      "debug": true,
      "server": {
        "externalurl": "http://localhost:8000",
        "gvlid": 0,
        "datacenter": ""
      }
    }
  }
}

9.1.2 Bidder Received Request Sample

{
  "id": "fwssp-test",
  "imp": [{
    "id": "imp-1",
    "video": {
      "mimes": ["video/mp4"],
      "minduration": 5,
      "maxduration": 30,
      "startdelay": -1,
      "maxseq": 5,
      "poddur": 120,
      "w": 300,
      "h": 250,
      "minbitrate": 300,
      "maxbitrate": 1500
    },
    "secure": 1,
    "ext": {
      "custom_site_section_id": "ss_12345",
      "network_id": "123456",
      "profile_id": "123456:prof_12345"
    }
  }],
  "site": {
    "page": "https://prebid.org",
    "ext": {
      "amp": 0
    },
    "content": {
      "cat": ["IAB2"],
      "contentrating": "tv-14",
      "genre": "GV,Entertainment,Automotive,Talk Show",
      "keywords": "Entertainment",
      "language": "en",
      "len": 2700,
      "livestream": 1,
      "prodq": 1,
      "qagmediarating": 1,
      "series": "VOD",
      "title": "title-name",
      "userrating": "4.6",
      "producer": {
        "name": "prorducer-name"
      },
      "network": {
        "name": "network-name"
      },
      "channel": {
        "name": "channel-name"
      }
    }
  },
  "device": {
    "ua": "curl/8.7.1"
  },
  "at": 1,
  "regs": {
    "coppa": 0,
    "gdpr": 1,
    "gpp": "DBABLA~BVQqAAAAAWA",
    "gpp_sid": [7],
    "us_privacy": "1---"
  },
  "user": {
    "ext": {
      "consent": "ABCDEF123456"
    }
  },
  "source": {
    "ext": {
      "schain": {
        "complete": 1,
        "nodes": [{
          "asi": "lkqd.net",
          "hp": 1,
          "sid": "1100053830"
        }],
        "ver": "1.0"
      }
    }
  },
  "ext": {
    "keywords": {
      "_fw_content_programmer_brand": "brand-name",
      "_fw_content_programmer_brand_channel": "channel-name",
      "_fw_content_genre": "comedy",
      "_fw_content_category": "comedy",
      "_fw_content_rating": "PG",
      "_fw_content_language": "en"
    },
    "prebid": {
      "debug": true,
      "server": {
        "externalurl": "http://localhost:8000",
        "gvlid": 0,
        "datacenter": ""
      }
    }
  }
}

9.1.3 Bidder Returned Response Sample

{
  "id": "fwssp-test",
  "seatbid": [{
    "bid": [{
      "id": "12345_fwssp-test_1",
      "impid": "imp-1",
      "price": 1,
      "adid": "7857",
      "adm": "<VAST version='2.0'></VAST>",
      "cid": "4001",
      "crid": "7857"
    }],
    "seat": "FreeWheel"
  }],
  "bidid": "fwssp-test",
  "cur": "USD"
}

9.1.4 Prebid Returned Response Sample 

{
  "id": "fwssp-test",
  "seatbid": [{
    "bid": [{
      "id": "12345_fwssp-test_1",
      "impid": "imp-1",
      "price": 1,
      "adm": "<VAST version='2.0'></VAST>",
      "adid": "7857",
      "cid": "4001",
      "crid": "7857",
      "ext": {
        "origbidcpm": 1,
        "origbidcur": "USD",
        "prebid": {
          "meta": {
            "adaptercode": "fwssp"
          },
          "type": "video",
          "video": {
            "duration": 0,
            "primary_category": ""
          }
        }
      }
    }],
    "seat": "fwssp"
  }],
  "cur": "USD"
}