Ogury Prebid.js Adapter
The Ogury Prebid Adapter is a module connecting Prebid.js framework to Ogury's ad network. It enables you to request and render Ogury ads. This documentation provides integration guidelines.
Last updated
Was this helpful?
The Ogury Prebid Adapter is a module connecting Prebid.js framework to Ogury's ad network. It enables you to request and render Ogury ads. This documentation provides integration guidelines.
Last updated
Was this helpful?
If your website will be trafficked in a country where GDPR applies, you must have implemented a consent management platform (CMP) which is compliant with TCF v2.2 and includes the Ogury vendor ID (31). The Prebid.js module has also to be enabled so that the Ogury Prebid.js can access consent information.
Your website needs to be integrated and set up with Prebid.js. Please refer to the for more details.
The Ogury Prebid.js Adapter currently supports all available ad formats.
The Ogury Prebid.js adapter is currently compatible with the following Prebid.js modules
: required to support the EU GDPR regulation
: used to specify bid price floors. Note that prices need to be specified in USD or converted to USD.
You cannot use a Prebid integration with a Direct Integration on the same page. Besides, we are not supporting multi placements on the same page, which means you should declare only one adUnit per page.
The Ogury Prebid Adapter needs to be included in the Prebid.js script you use for header bidding.
The Ogury Prebid Adapter is fully supported by the official Prebid.js since version 6.6.0
. This is the minimal version you should use. However, we recommend using the latest available version to benefit from functional and maintenance updates.
You only need to include Ogury
to your selected adapters to download a ready to use Prebid.js script.
Although the officially supported Ogury Prebid Adapter is available since version 6.6.0
of Prebid.js, it is compatible with earlier 5.x and 4.x versions and can be used through a custom build from source code.
Go to your Prebid.js folder
cd Prebid.js
Download the latest Ogury Prebid Adapter files to the modules folder. You may do it using wget
as follows:
Build the Prebid.js library including the Ogury Prebid Adapter. You may use the gulp
command for that:
A successful build generates a production ready prebid.js library in this folder: build/dist/prebid.js
A typical Prebid.js ad unit configuration looks like the following:
If the code
field (corresponding to 'iframe-1' in the example above) is the identifier of the div where the ad will be displayed, it will be used to close the div and avoid blank space.
The Ogury Prebid Adapter currently relies on pixel-based user syncing performed by Prebid.js. This feature is enabled by default but if you need to customize the configuration, please make sure that the Ogury Prebid Adapter is allowed to perform user syncing.
Here is an example of a working GAM creative:
Ogury Formats are not compatible withSafeFrame
delivery, except desktop standard banners. Thus it has to be unchecked.
Ogury has proprietary formats that don't follow the common IAB Ad space sizes. While Ogury returns a creative size that is defined in the prebid ad unit configuration, the real creative size differs depending on the used format and returned media type.
The Ogury Prebid Adapter supports only floors expressed in USD. Please make sure that you have defined your price floor in that default currency or you have properly configured currency conversion.
If you want to adjust the rendering of your selected Ogury Ad Format please refer to the individual ad format sections:
Two things to keep in mind when doing adjustments:
For Prebid you'll need to switch the configuration parameters from snake case to camel case notation
All configuration options will be listed in the params Object
Bidder configuration :
If you're are using prebid's gdprEnforcement module and you're not using the most recent Ogury Adapter or Prebid version, you might need to map the Ogury Bid Adapter to the right vendor ID, otherwise Ogury won't be able to perform the necessary cookie synching.
You can download or build the latest version of Prebid.js with Ogury Prebid Adapter here:
Assuming that you have a copy of the Prebid.js target version that you can build based on the :
You need to replace $OGURY_AD_UNIT
and $OGURY_ASSET_KEY
by the values you received at and .
In order to enable Ogury ad formats, please make sure you use banner
as media type. Concerning the sizes
configuration, on mobile we can bid on any size but will return our own creative dimensions that can differ from the prebid configuration. On desktop, the prebid size configuration needs to contain the sizes that you support and Ogury will return a size appropriated creative if we .
More details on Prebid.js user syncing can be found .
Make sure to to your ads.txt file.
Ogury Prebid Adapter can be configured along with Google Ad manager as an ad server. A typical configuration should be similar to what is described in the .
The Ogury Prebid Adapter supports bid floor management. You can optionally set a floor as defined in .