Ogury Prebid Adapter
The Ogury Prebid Adapter is a module connecting the Prebid framework to Ogury. It enables you to request and render Ogury Ads. This documentation provides integration guidelines.
Prerequisites
General
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 consentManagement 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 Prebid.js documentation for more details.
For server-side bidding
Server-side bidding is optional, see Enable server-side bidding with Prebid Server if you wish to activate it.
Ogury is fully supported in Prebid-Server since version
3.13.0
.Ogury is fully supported in Prebid-Server-Java since version
3.23.0
.
Supported format
The Ogury Prebid Adapter currently supports all available ad formats.
Compatible Prebid.js modules
The Ogury Prebid.js adapter is currently compatible with the following Prebid.js modules
consentManagement: required to support the EU GDPR regulation
priceFloors: used to specify bid price floors. Note that prices need to be specified in USD or converted to USD.
Adding the Ogury Prebid Adapter to your Prebid.js library
The Ogury Prebid Adapter needs to be included in the Prebid.js script that 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.
Download the latest version
You can download or build the latest version of Prebid.js with Ogury Prebid Adapter here: https://docs.prebid.org/download.html
You only need to include ogury
to your selected adapters to download a ready to use Prebid.js script.
Configure the Ogury Prebid Adapter
A typical Prebid.js ad unit configuration looks like the following:
var adUnits = [
{
code: 'iframe-1',
mediaTypes: {
banner: {
sizes: [[320, 100], [1, 1], [300, 250]],
}
},
bids: [
{
bidder: "ogury",
params: {
adUnitId: '$OGURY_AD_UNIT',
assetKey: '$OGURY_ASSET_KEY'
}
}
// You may have other Prebid.js bidder adapters to configure here
]
}
];
You need to replace $OGURY_AD_UNIT
and $OGURY_ASSET_KEY
by the values you received at after inventory creation.
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.
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 when sticky ad units are used, but will return our own creative dimensions that can differ from the prebid configuration. For Standard Banners, the prebid size configuration needs to contain the sizes that you support and Ogury will return a size appropriated creative if we support them.
Enable user syncing
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.
pbjs.setConfig({
userSync: {
filterSettings: {
image: {
bidders: ['ogury'], // add other adapters here if needed
filter: 'include'
}
}
}
});
More details on Prebid.js user syncing can be found here.
Update your ads.txt
Make sure to add your Ogury ID to your ads.txt file.
Optional configuration
Enable server-side bidding with Prebid Server
You first need to have a working prebid-server including the ogury prebid server adapter. See prerequisites For server-side bidding.
Add Ogury to the list of server-side enabled bidders.
pbjs.setConfig({
s2sConfig: {
accountId : '12345',
bidders : ['ogury', 'other_bidder1', 'other_bidder2']
}
});
Mapping inventory
You need Prebid.js version 9.29.0
or above to use this feature.
If you prefer to use a single ID for all your inventory instead of placement IDs per domain and format, you'll need provide the domains/sites and the corresponding ad unit codes on which Ogury is supposed to bid.
Ad server configuration: Google Ad Manager example
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 official Prebid.js documentation.
Here is an example of a working GAM creative:



Ogury Formats are not compatible with SafeFrame
delivery, except for standard banners. Thus it has to be unchecked.
Creative Sizes
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. If you use standard banners, the size in the bid response will correspond to the size in the bid request.
Bid floor
The Ogury Prebid Adapter supports bid floor management. You can optionally set a floor as defined in the price floor Prebid.js documentation.
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.
Customize your Ad Format
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 :
{
{
bidder: "ogury",
params: {
assetKey: string, // MANDATORY
adUnitId: string, // MANDATORY
xMargin?: number, // Thumbnail only
yMargin?: number, // Thumbnail only
gravity?: string, // Thumbnail only
headerSelector?: string, // Header Ad only
headerAdDomPosition?: string // Header Ad only
adSlotSelector?: string // Header, In-Article and Footer only
adSlotSelectorPosition?: string // Header and In-Article only
fixedElements?: ['string'] // In-Article only
onAdShow?: function,
onPositionChange?: function,
onAdComplete?: function,
onError?: function
}
}
Vendor Mapping
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.
pbjs.setConfig({
gvlMapping: {
ogury: 31,
}
});
Last updated
Was this helpful?