Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outbrain adapter: make adapter non-aliased #2847

Merged
merged 5 commits into from
Apr 13, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 34 additions & 19 deletions dev-docs/bidders/outbrain.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ layout: bidder
title: Outbrain
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
---

Expand All @@ -20,37 +21,47 @@ The Outbrain Adapter requires setup before beginning. Please contact us at prebi

### Configuration

#### Bidder and usersync URLs
#### Prebid.js

The Outbrain adapter does not work without setting the correct bidder and usersync URLs.
You will receive the URLs when contacting us.

Also note that the Outbrain adapter is an aliased adapter and for usersync to work you also need to enable it as shown below
on the `usersync` config object.
```
pbjs.setConfig({
outbrain: {
bidderUrl: 'https://bidder-url.com',
usersyncUrl: 'https://usersync-url.com'
},
userSync: {
aliasSyncEnabled: true
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 `<PREBID_SERVER_EXTERNAL_URL>` part with the actual external URL of the prebid server host.
```
adapters:
outbrain:
endpoint: http://bidder-url.com
syncurl: http://usersync-url.com?gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb=<PREBID_SERVER_EXTERNAL_URL>%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` |
| 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 = [
Expand Down Expand Up @@ -88,13 +99,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',
Expand All @@ -112,6 +125,8 @@ var adUnits = [
domain: 'publisher.com'
},
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
Expand Down