diff --git a/dev-docs/bidders/outbrain.md b/dev-docs/bidders/outbrain.md index ce15414b9d..1e71f6a77f 100644 --- a/dev-docs/bidders/outbrain.md +++ b/dev-docs/bidders/outbrain.md @@ -13,6 +13,7 @@ pbjs: true pbs: true pbs_app_supported: true prebid_member: true +pbjs_version_notes: for versions 4.35+ --- ### Registration diff --git a/dev-docs/bidders/outbrain_old.md b/dev-docs/bidders/outbrain_old.md new file mode 100644 index 0000000000..5bf0794eb3 --- /dev/null +++ b/dev-docs/bidders/outbrain_old.md @@ -0,0 +1,135 @@ +--- +layout: bidder +title: Outbrain - Old +description: Outbrain Prebid Bidder Adapter +biddercode: outbrain +aliasCode: zemanta +gdpr_supported: true +gvl_id: 164 +usp_supported: true +coppa_supported: true +media_types: banner, native +safeframes_ok: true +pbjs: true +pbs: true +pbs_app_supported: true +prebid_member: true +pbjs_version_notes: for versions 4.20-4.34 +--- + +### Registration + +The Outbrain Adapter requires setup before beginning. Please contact us at prebid.org@outbrain.com. + +### Configuration + +#### Prebid.js + +The Outbrain adapter does not work without setting the correct bidder and usersync URLs. +You will receive the URLs when contacting us. +``` +pbjs.setConfig({ + outbrain: { + bidderUrl: 'http://bidder-url.com', + usersyncUrl: 'http://usersync-url.com' + } +}); +``` + +#### Prebid server + +Similar to the Prebid.js configuration described 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: + outbrain: + endpoint: http://bidder-url.com + syncurl: http://usersync-url.com?gdpr={%raw%}{{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}{%endraw%}&cb=%2Fsetuid%3Fbidder%3Doutbrain%26uid%3D__ZUID__ + +``` + +### 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` | +| `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 + +``` +var adUnits = [ + code: '/19968336/prebid_native_example_1', + mediaTypes: { + native: { + image: { + required: false, + sizes: [100, 50] + }, + title: { + required: false, + len: 140 + }, + sponsoredBy: { + required: false + }, + clickUrl: { + required: false + }, + body: { + required: false + }, + icon: { + required: false, + sizes: [50, 50] + } + } + }, + bids: [{ + bidder: 'outbrain', + params: { + publisher: { + id: '2706', + name: 'Publishers Name', + domain: 'publisher.com' + }, + tagid: 'tag-id', + bcat: ['IAB1-1'], + badv: ['example.com'] + } + }] +]; +``` + +#### Banner example +``` +var adUnits = [ + code: '/19968336/prebid_display_example_1', + mediaTypes: { + banner: { + sizes: [[300, 250]] + } + }, + bids: [{ + bidder: 'outbrain', + params: { + publisher: { + id: '2706', + name: 'Publishers Name', + domain: 'publisher.com' + }, + tagid: 'tag-id', + bcat: ['IAB1-1'], + badv: ['example.com'] + } + }] +]; +```