Page History
...
Section | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
1. Introduction
SFX has provided tech resources in order for publishers to integrate with thePrebid Server Framework. This is an open source framework that allows publishers to integrate with demand sources in a plug and play type fashion and with less complexities than other integration methods. 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.
Key Features
Adapter Integration: Prebid Server uses adapters (like FreeWheel's
fwssp
adapter) to integrate demand sources, which translate bid requests and responses between different systemsOpenRTB Compatibility: Supports OpenRTB protocol
Media Type Support: Can handle various media types
Note | ||
---|---|---|
| ||
With the sunsetting of SFX, any customers using an existing Prebid Server Integration will need to complete a new adaptor 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
1.2 Pre-Requisites
...
The new Freewheel adaptor is named fwssp and can be found in the Prebid Github Repository.
Info | ||
---|---|---|
| ||
This new Prebid Adaptor will work in parallel to the existing SFX adaptors whilst the migration of clients is complete. Then the |
...
fwssp Adaptor is going to replace the SFX instances of freewheel-ssp and freewheelssp adaptors in the future once SFX is deprecated. |
...
Info |
---|
Note that the SFX adaptors 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 themthe SFX adaptors. |
...
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 config file:
...
The expectation is the the upstream adserver will host the user match table in-between your cookie ID and the Freewheel Cooke 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.
8. Ads.txt/app ads.txt
Link to the new Hub guide for FW SSP - still pending publication on https://hub.freewheel.tv/display/MUG/ads.txt+and+app-ads.txt+setup.
...
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
In order to successfully monetize your supply and align all relevant demand, we'll require clients to correctly pass contextual information around the supply. The section below details the fields required to pass the needed information for ORTB ad requests:
...
Info |
---|
For the most optimal monetization, clients should pass at a minimum Programmer, Brand, Channel and Genre. If these aren't passed, Freewheel may not be able to effectively monetize the supply. |
...
...
9. 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.
...
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 adaptor - fwssp and not another adaptor.
...
10.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
...
10.1.1 Prebid Received Request Sample
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "id": "fwssp-test", "site": { "page": "prebid.org" }, "imp": [ { "id": "imp-1", "video": { "mimes": [ "video/mp4" ], "w": 300, "h": 250, "maxduration": 30, "minduration": 5, "startdelay": -1, "minbitrate": 300, "maxbitrate": 1500, "maxseq": 5, "poddur": 120 }, "ext": { "prebid": { "bidder": { "fwssp": { "custom_site_section_id": "ss_12345", "network_id": "123456", "profile_id": "123456:prof_12345" } } } } } ], "ext": { "prebid": { "debug": true } } } |
...
10.1.2 Bidder Received Request Sample
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "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": "prebid.org", "ext": { "amp": 0 } }, "device": { "ua": "curl/8.7.1" }, "at": 1, "source": { "tid": "d5e38b20-69d3-4a0a-bbc5-ebb523542062" }, "ext": { "prebid": { "debug": true, "server": { "externalurl": "http://localhost:8000", "gvlid": 0, "datacenter": "" } } } } |
...
10.1.3 Bidder Returned Response Sample
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "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" } |
...
10.1.4 Prebid Received Request Sample
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "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" } |
...