Skip to content

Commit

Permalink
Update docs to match with PBJ (#3212)
Browse files Browse the repository at this point in the history
* Fixed typo

* Updated docs to match with current PBJ state.

* Added default configuration section

* Removed redundant space between parentheses

* tweaked default configs

Co-authored-by: bretg <bgorsline@gmail.com>
  • Loading branch information
And1sS and bretg authored Aug 19, 2021
1 parent dac7cab commit 4e9a70d
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions prebid-server/developers/add-new-bidder-java.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,7 @@ Create a file with the path `static/bidder-info/{bidder}.yaml` and begin with th
```yaml
adapters:
yourBidderCode:
enabled: false
endpoint: http://possible.endpoint
pbs-enforces-gdpr: true
pbs-enforces-ccpa: true
modifying-vast-xml-allowed: true
deprecated-names:
aliases:
meta-info:
maintainer-email: maintainer@email.com
app-media-types:
Expand All @@ -109,8 +103,9 @@ adapters:
Modify this template for your bid adapter:
- Change the maintainer email address to a group distribution list on your ad server's domain. A distribution list is preferred over an individual mailbox to allow for robustness, as roles and team members naturally change.
- Change the `modifyingVastXmlAllowed` value to `true` if you'd like to opt-in for video impression tracking.
- Change the `enabled` value to `true` if you'd like to make your bid adapter enabled.
- Change the `modifying-vast-xml-allowed` value to `false` if you'd like to opt out of video impression tracking. It defaults to `true`.
- Change the `pbs-enforces-gdpr` to `false` if you'd like to disable gdpr enforcement. Defaults to `true`.
- Change the `pbs-enforces-ccpa` to `false` if you'd like to disable ccpa enforcement. Defaults to `true`.
- Change the `vendor-id` value to id of your bidding server as registered with the [GDPR Global Vendor List (GVL)](https://iabeurope.eu/vendor-list-tcf-v2-0/). Leave this as `0` if you are not registered with IAB Europe.
- Remove the `capabilities` (app/site) and `mediaTypes` (banner/video/audio/native) combinations which your adapter does not support.
- Change the `cookie-family-name` to the name which will be used for storing your user sync id within the federated cookie. Please keep this the same as your bidder name.
Expand All @@ -124,19 +119,31 @@ The url of your user syncer can make use of the following privacy policy macros

- Change the `usersync:type` value to `redirect` or `iframe` specific to your bidder.

### Default bidder configuration

Prebid Server has default configuration for common bidder properties, which can be overriden by bidders in their
configurations.

Default configuration:

```yaml
adapter-defaults:
enabled: false
pbs-enforces-gdpr: true
pbs-enforces-ccpa: true
deprecated-names:
aliases: {}
modifying-vast-xml-allowed: true
```

### Create bidder alias
If you want to add bidder that is an alias of existing bidder, you need just to update configuration of parent bidder:

Example of adding bidder alias:
```yaml
adapters:
yourBidderCode:
enabled: false
endpoint: http://possible.endpoint
pbs-enforces-gdpr: true
pbs-enforces-ccpa: true
modifying-vast-xml-allowed: true
deprecated-names:
aliases:
yourBidderAlias:
endpoint: http://possible.alias/endpoint
Expand Down

0 comments on commit 4e9a70d

Please sign in to comment.