Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SpecificationVersionLast Update DateNotes
Prebid Server3.18.0 and above

 

3.18.0 is the minimum Prebid Server Version that embeds the fwssp adaptoradapter

IAB Content Category Taxonomyv1

 

IAB Content Categories are mapped to FreeWheel Global Industries

...

Guide VersionDateAuthorDescription
v1.1

  

Admin

Initial ReleaseAdded Standard Attribute information 4. New Parameters

Historic

UI Expand
titleHistoric Prebid Server Integration Guide Change Log
VersionDateAuthorDescription
v1

  

Admin

Initial Release


...


Section


Column
width50%


Panel
borderColor#c8c8c8
borderWidth1
borderStylesolid

Table of Contents

Table of Contents
maxLevel2
indent20px
stylenone



Column
width50%



...

Note
titleSFX Note

With the sunsetting of SFX, any customers using an existing Prebid Server Integration will need to complete a new adaptor adapter integration in order to migrate to their new FW SSP network. This page outlines the integration steps for publishers to complete these steps.  

...

  • 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 adaptor 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. How to add the new FW Prebid Server

...

adapter

The new Freewheel adaptor adapter is named fwssp and can be found in the Prebid Github Repository

...

Info
titleSFX Note

This new Prebid Adaptor adapter will work in parallel to the existing SFX adaptors adapters whilst the migration of clients is complete. Then the fwssp Adaptor adapter is going to replace the SFX instances of freewheel-ssp and freewheelssp adaptors adapters in the future once SFX is deprecated. Note that the SFX adaptors adapters will be deprecated later in 2025 once all clients have migrated to their new networks. After this date, clients will no longer be able to use the SFX adaptorsadapters.


...

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 Adaptor adapter config file:

...

With the release of the new adaptorsadapters, there will be a need for certain parameters to change versus those used previously on SFX in order to meet the requisites of the new FW SSP platform. This is due to differences in architecture and concepts between the two platforms

FW SSP ParameterDescription
profile_id

A profile is used to determine and control what type/formats of ads can serve into a particular inventory type e.g creative specs. This is set up on the backend and the value to implement will be provided by your Freewheel account team

The expected format is the name of the profile as a string and not a numerical ID

network_id

The network ID is the ID of the customer account or instance, known as a 'network'. The value to implement will be provided by your Freewheel account team. The expected format is a numerical string.

Note
titleSFX Note

Networks are similar concept to SFX Private Exchanges (PX).

custom_site_section_id

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.

Note
titleSFX Note

Site Sections are a similar to the concept of SFX Zones, however unlike zones, the ad unit is separated from the site section and the site section agnostic of what type of ad unit is being used.

5. Config Code



Note
titleAdditional Details of Passing of Standard Attributes

This document includes details of the passing of Standard Attributes such as Brand, Channel, IAB Category, Genre, Content title, etc.

https://hub.freewheel.tv/display/MUG/Inventory+Standardization+from+OpenRTB-S

...

5. Config Code

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

...

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 Adaptoradapter. The code to manage this will be integrated into the adaptor 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. 

...

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 adaptor adapter - fwssp and not another adaptoradapter

10.1 Sample ad requests and responses

...

You are evaluating Refined.