| Table of Contents |
|---|
Overview
PrebidJS Prebid.js for Web is an open-source Javascript library and community which allows publishers to implement Header Bidding.The PrebidJS library and a configuration is usually placed in the header of a web site .
In summary, Prebid.js and Sharethrough work like this:
The publisher creates ad slots on their page.
The publisher configures ad units configurations. Each one is associated with an ad slot and defines the kind of ads it can render and bidder specific parameters.
Prebid.js starts an auction with all the bidder adapters included in the Prebid.js bundle.
Each bidder adapter exchanges bid requests and bid responses with their respective bidder.
Prebid.js calls the website’s bidsBackHandler function.
The website decides on the winning bids.
The winning ad creatives are rendered on the page.
...
The Prebid.js library and configuration is included in the webpage and will work with an existing ad server such as Google Ad Manager, AppNexus, and others.
This specific page contains brief information on how to get started with Prebid using our demand.
For additional information, see:
Quick Start Guide
...
Select the latest version of Prebid to
...
get all the latest features
Check the box for ‘Sharethrough’
...
Enter your e-mail address and a built Prebid library will be emailed to you with our adapter included
...
Select the “Get Prebid.js!” button to download the library on browser.
Add the Prebid.js library to your web page using <script> tags like this. We recommend using a test page to configure Prebid before going live in
...
production.
| Code Block |
|---|
<html>
<head>
<script async src="prebid.js"></script>
<script>
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];
</script>
</head>
</html> |
Push Price Priority Line Items to your publisher adserver (for instance GAM for those using Google’s adserver) using the defined price granularity and setup specific for that adserver.
This Python project does a good job for users semi-familiar with the Ad Manager API and Python
Use the key-values 'sharethrough' per the bidder parameters documentation from Prebid.
Configure the ad units for which you want the
sharethroughbidder to return bid responses. Sharethrough supports
...
banner, native and video impression requests
...
.
...
See the
...
...
. It provides definitions for all the supported fields and examples for various types of ads.
The important fields are:code: Associates the ad unit configuration with an ad slot on the page.mediaTypes: The type of ads to serve. E.g. banner, video, native, etc.bids: Bidder specific parameters.You must define the sharethrough bidder and associate this ad unit with a PubMaestro placement key using
pkey
ortb2Imp: Optional parameters supported by OpenRTB. For example, you could configure a floor price, block advertiser domains or block IAB categories.Example:
Code Block language js
...
<script>
...
var adUnits = [ {
...
...
...
...
...
code: 'my-html-div-tag-id',
...
...
9. A complete setup for a banner ad unit may look like the following:
...
| language | js |
|---|
...
mediaTypes: {
...
...
...
...
...
...
...
banner: { sizes: [[300,
...
250]
...
]
...
...
...
...
...
...
...
...
} },
...
...
...
...
...
bids:
...
[
...
...
...
...
...
...
...
...
...
{
...
...
...
bidder:
...
"sharethrough",
...
...
params:
...
{
...
pkey: '
...
pkey1',
...
}
...
...
}
...
...
]
...
...
}, ]
...
pbjs.que.push(function() {
...
pbjs.addAdUnits(adUnits);
...
}
...
10. A complete setup for a video ad unit may look like the following:
...
| language | js |
|---|
...
); </script>
Request bids and render the winning ads
Call
pbjs.requestBidsto request bids for all ad units. This is typically called when the page loads or when an ad slot comes into view.The
bidsBackHandlerparameter is a callback function to call once the bid responses are received to render the winning ads.Code Block <script> pbjs.que.push(function() {
...
pbjs.requestBids({
...
bidsBackHandler:
...
renderAllAdUnits, //
...
Your
...
rendering
...
logic here });
...
11. After configuring your bid array, Sharethrough should start immediately competing in your header bidding auction. Be sure to add Sharethrough to your ads.txt file.
12. Note that the Sharethrough adapter does NOT support multiple formats (banner, video) for the same placement key.
13. Sharethrough adapter does NOT support mediaType of native.
14. For the default values specified for the mediaType of video, if they are specified, they will override the default values shown here. If the default values are fine, no specification of a value at the ad unit level is necessary.
}); </script>Examples:
Without an ad server: https://docs.prebid.org/dev-docs/examples/no-adserver.html
With an ad server: https://docs.prebid.org/dev-docs/examples/basic-example.html
Sharethrough should immediately start competing in your header bidding auctions.
Best Practices
Before implementing any Prebid demand on your pages we recommend some best practices to ensure the maximum benefit is provided to your bottom line while not impacting users.
Define and Request only what will be immediately rendered.
In some scenarios it might be useful to define and prepare all ad slots which will ever be displayed on page.
However, if some ad slots are never rendered these ad requests may reduce the fill % on the page, as well as possible SPO/optimization by buyers which exclude your inventory.
Keep the number of ad slots to less than 4
To improve view-ability and user experience we recommend limiting the number of active ad slots to 4, ensuring to keep them as view-able as possible.
Timeouts
A timeout of at least 1000ms is recommended per bidder unless most of your inventory is on slow mobile connections, in which case increasing the timeout to 3000ms is recommended.
Define, request, and render ad slots as they near view
If you are lazy loading ads on long article pages we recommend defining the new ad slots, making requests, and rendering the ad as the user scrolls through content and nears the ad slot.
This benefits the page by minimizing the ad load and reduces resources until such a time they are required.
Avoid creating new ad slots when you want to refresh ads
We recommend using Prebid’s documented refresh functionality.
Keep it simple
Avoid wrapping Prebid functionality in classes, functions, namespaces, etc
If you obfuscate Prebid you may introduce additional complexity when needing to troubleshoot
Add User ID Modules
Provide the position of the ad unit if possible, following , using the
banner.posfield (Open RTB Spec:1: Above the Fold3: Below the Fold4: Header5: Footer6: Sidebar7: Full Screen
For Prebid.js version 6.7.0 and above, Sharethrough supports first party data, as documented in this Prebid Guide.Placement Positions)
Check out the Sharethrough bidder page for other features that might interest you, such as first path data
Adapter Details
Sharethrough
...
Supported mediaTypes
Banner
Native
Video (instream and outstream)
...
For publishers on Prebid version 5 and above,
TTL is 360 for display and native, 3600 for video (in milliseconds)
Advertiser domains into the bid.meta object
Safeframes are supported
...
Additional information on defining GPID can be found here: https://dev.prebid.org/features/pbadslot.