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 prebid server support and new params #2796

Closed
Closed
Changes from 3 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
65 changes: 53 additions & 12 deletions dev-docs/bidders/outbrain.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,18 @@ coppa_supported: true
media_types: banner, native
safeframes_ok: true
pbjs: true
pbs: true
pbs_app_supported: true
prebid_member: true
---

### Registration
## Registration

The Outbrain Adapter requires setup before beginning. Please contact us at prebid.org@outbrain.com.

### Configuration
## Configuration

### Prebid.js

#### Bidder and usersync URLs

Expand All @@ -30,25 +34,58 @@ 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
}
});
```

### Bid Params
### 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 `<PREBID_SERVER_EXTERNAL_URL>` 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=<PREBID_SERVER_EXTERNAL_URL>%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

Expand Down Expand Up @@ -88,7 +125,9 @@ var adUnits = [
name: 'Publishers Name',
domain: 'publisher.com'
},
tagid: 'tag-id'
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
Expand All @@ -112,6 +151,8 @@ var adUnits = [
domain: 'publisher.com'
},
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
Expand Down