diff --git a/dev-docs/bidders/outbrain.md b/dev-docs/bidders/outbrain.md index 4187a7e982..3e3e0b6296 100644 --- a/dev-docs/bidders/outbrain.md +++ b/dev-docs/bidders/outbrain.md @@ -11,6 +11,8 @@ coppa_supported: true media_types: banner, native safeframes_ok: true pbjs: true +pbs: true +pbs_app_supported: true prebid_member: true --- @@ -20,7 +22,9 @@ The Outbrain Adapter requires setup before beginning. Please contact us at prebi ### Configuration -#### Bidder and usersync URLs +#### Prebid.js + +##### Bidder and usersync URLs The Outbrain adapter does not work without setting the correct bidder and usersync URLs. You will receive the URLs when contacting us. @@ -30,8 +34,8 @@ on the `usersync` config object. ``` pbjs.setConfig({ outbrain: { - bidderUrl: 'https://bidder-url.com', - usersyncUrl: 'https://usersync-url.com' + bidderUrl: 'http://bidder-url.com', + usersyncUrl: 'http://usersync-url.com' }, userSync: { aliasSyncEnabled: true @@ -39,18 +43,51 @@ pbjs.setConfig({ }); ``` +#### Prebid server + +Because Outbrain is an alias for Zemanta, the prebid server bidder configuration in `pbs.yaml` for Outbrain needs to reference the Zemanta bidder. + +Similar to the Prebid.js part above, our prebid server adapter requires you to configure the bidder and usersync URLs. +You will receive the URLs when contacting us. + +Please note that you need to replace the `` part with the actual external URL of the prebid server host. +``` +adapters: + zemanta: + endpoint: http://bidder-url.com + syncurl: http://usersync-url.com?gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb=%2Fsetuid%3Fbidder%3Dzemanta%26uid%3D__ZUID__ + +``` +In addition to the configuration above, support for aliased bidders in prebid server is enabled via some info in stored requests. +So please add the following JSON snippet to the stored request you will use to call our bidder. +``` +{ + ... + "ext": { + "prebid": { + "aliases": { + "outbrain": "zemanta" + } + } + } + ... +} +``` + ### Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|--------------------|----------|---------------------------------------------------|------------------------|----------| -| `publisher.id` | required | The publisher account ID | `'2706'` | `string` | -| `publisher.name` | optional | The publisher name | `'Publisher Name'` | `string` | -| `publisher.domain` | optional | The publisher domain | `'publisher.com'` | `string` | -| `tagid` | optional | Identifier for specific ad placement or ad tag | `'tag-id'` | `string` | +| Name | Scope | Description | Example | Type | +|--------------------|----------|----------------------------------------------------------------|--------------------|----------------| +| `publisher.id` | required | The publisher account ID | `'2706'` | `string` | +| `publisher.name` | optional | The publisher name | `'Publisher Name'` | `string` | +| `publisher.domain` | optional | The publisher domain | `'publisher.com'` | `string` | +| `tagid` | optional | Identifier for specific ad placement or ad tag | `'tag-id'` | `string` | +| `bcat` | optional | Blocked advertiser categories using the IAB content categories | `['IAB1-1']` | `string array` | +| `badv` | optional | Block list of advertisers by their domains | `['example.com]'` | `string array` | -### Native example +#### Native example ``` var adUnits = [ @@ -88,13 +125,15 @@ var adUnits = [ name: 'Publishers Name', domain: 'publisher.com' }, - tagid: 'tag-id' + tagid: 'tag-id', + bcat: ['IAB1-1'], + badv: ['example.com'] } }] ]; ``` -### Banner example +#### Banner example ``` var adUnits = [ code: '/19968336/prebid_display_example_1', @@ -112,6 +151,8 @@ var adUnits = [ domain: 'publisher.com' }, tagid: 'tag-id', + bcat: ['IAB1-1'], + badv: ['example.com'] } }] ];