Versions Compared

Key

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

...

Guide VersionDateAuthorDescription
v1.3


AdminCorrected typo in the 1.1 Integration Diagram section.  

Historic

UI Expand
titleHistoric Prebid Server Integration Guide Change Log
VersionDateAuthorDescription
v1.2

  

Admin
  1. Made adjustments to language around ORTB to further provide context on ORTB-S
  2. Added information on Gzip compression support (section 3.1)
  3. New Parameters section renamed to fwssp Adapter Parameter Highlights
  4. More context and line items added to fwssp Adapter Parameter Highlights
  5. Added ORTB-S line item to Specification Support Section
  6. Expanded the Passing Contextual Information Section (Standard Attributes)

...

Historic

Historic Prebid Server Integration Guide Change Log
UI Expand
title
VersionDateAuthorDescription
v1.1

  

Admin

Added Standard Attribute information 4. New Parameters

v1

  

Admin

Initial Release

...

Note
titleSFX Note

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

1.1 Integration Diagram

Image RemovedImage Added

1.2 Pre-Requisites

...

  • 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


Info
titleSFX Note

This new Prebid adapter will work in parallel to the existing SFX adapters whilst the migration of clients is complete. Then the fwssp adapter is going to replace the SFX instances of freewheel-ssp and freewheelssp adapters in the future once SFX is deprecated. Note that the SFX 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 adapters.


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:

...

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 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.

...

Code Block
languagejs
titleBidder Returned Response
collapsetrue
{
  "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 

Code Block
languagejs
titlePrebid Received Response
collapsetrue
{
  "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"
}

...

You are evaluating Refined.